EspressReport 6.6

quadbase.reportdesigner.ReportElements
Class ReportElement

java.lang.Object
  extended by quadbase.reportdesigner.ReportElements.ReportElement
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ReportCell, ReportColumn, quadbase.reportdesigner.ReportElements.ReportTableElement

public abstract class ReportElement
extends java.lang.Object
implements java.io.Serializable

A quadbase report can be thought of as a collection of ReportElement(s), with each ReportElement containing the information on how data is going to look in the report. In such a way, the ReportElement Object provides a way to manipulate the contents as well as the look and feel of the individual elements.

This class serves as a general class for all other report object (such as ReportCell, ReportSection, ReportColumn, etc.) that extends it for controlling the formatting of the report.

Within each ReportElement object, properties such as font, color, data format, etc., can be manipulated. You can also copy ReportElement objects or just apply the template of one ReportElement object to another. When a template is applied, the data of the object does not change. Only the look and feel of the ReportElement object is modified.

See Also:
Serialized Form

Field Summary
protected  java.awt.Color bgColor
           
protected  java.awt.Color borderColor
           
static int CHART
          The element type CHART.
static int COLUMN
          The element type COLUMN.
static int COLUMNHEADER
           
static int FORMULA
          The element type FORMULA.
static int GRID
          The element type GRID.
protected  double height
           
static java.lang.String[] ID_TYPE
           
static int IMAGE
          The element type IMAGE.
protected  boolean isLocked
           
static int LABEL
          The element type LABEL.
static int LINE
          The element type LINE.
protected  double min_height
           
protected  double min_width
           
static int NONE
           
protected  double rotate_angle
           
static int ROTATE_CLOCKWISE
           
static int ROTATE_COUNTERCLOCKWISE
           
static int ROTATE_NONE
           
protected  int roundCornerRadius
           
protected  boolean[] roundCornersArray
           
static int RTFOBJECT
          The element type of ReportRTFObject *
static int SECTION
          The element type SECTION.
protected  java.util.Hashtable<java.lang.String,ReportElement> securityMap
           
protected  short snap
           
static int SORT_X
          for sorting in X (horizontal) direction.
static int SORT_Y
          for sorting in Y (vertical) direction.
static int SORT_Z
          for sorting in Z (depth) direction.
static int SUBREPORT
          The element type SUBREPORT.
static int TABLE
          The element type TABLE.
static int TABLEOFCONTENTS
           
static int TITLE
           
protected  boolean visible
           
protected  short vsnap
           
protected  double width
           
protected  double x
           
 
Constructor Summary
ReportElement()
          Default constructor to create an instance of ReportElement
ReportElement(java.lang.String name)
          Creates a new instance of ReportElement with the specified name.
 
Method Summary
 ReportElement addSecurityLevel(java.lang.String levelName)
          Create a new security level for this element.
 void applyImageTemplate(ReportElement _elt)
          For internal use only
 void applyImageTemplateExceptBound(ReportElement _elt)
          For internal use only
 void applySecurity(ReportElement _elt)
           
 void applyStyle(ReportElement _elt)
          Applies the style properties from ReportElement _elt onto this ReportElement
 void applyStyleButNotWH(ReportElement _elt)
           
 void applyTemplate(ReportElement _elt)
          internal use only

Specifies the look and feel of the ReportElement.

 void applyTemplate(ReportElement _elt, boolean applyScript)
           
 void applyTemplate(ReportElement _elt, boolean applyScript, boolean applyElementPosition, boolean copyDrillDownName)
          internal use only
 boolean contains(double cx, double cy)
          internal use only

Check whether a coordinate point (cx,cy) is contained within this element.

static boolean contains(ReportElement elt, java.util.Vector<ReportElement> eltList)
           
 boolean containsX(double cx, double w)
          internal use only

For Excel report: Export the Report line and Grid as Cell Border

 boolean containsY(double cy, double h)
          internal use only

For Excel report: Export the Report line and Grid as Cell Border

 void copy(ReportElement _elt)
          internal use only

Specifies the properties of this ReportElement object to be the same as the properties of ReportElement object "_elt".

 void copyTemplate(ReportElement _elt)
          For internal use only.
 void createScriptObject(java.util.Vector<Script> scripts)
          For internal use only *
 void createScriptObjectFromName(java.util.Vector<Script> scripts)
          For internal use only *
 void deepCopy(ReportElement _elt)
          For internal use only
static boolean doesElementSupportRoundCorners(ReportElement elt)
           
 boolean equals(ReportElement _elt)
          Checks to see if the properties of this ReportElement object are the same as the properties of ReportElement object "_elt".
static ReportElement[] findElementsAbove(ReportElement r, ReportElement[] ret)
          For internal use only
static java.util.Vector<ReportElement> findElementsBelow(ReportElement[] r, ReportElement[] ret)
          For internal use only
static ReportElement[] findElementsToLeft(ReportElement r, ReportElement[] ret)
          For internal use only
static java.util.Vector<ReportElement> findElementsToRight(ReportElement[] r, ReportElement[] ret)
          For internal use only
static ReportElement[] findElementsToRight(ReportElement r, ReportElement[] ret)
          For internal use only
static int findElementType(ReportElement elt)
          For internal use only.
static int findGroupElementType(ReportElement elt)
          For internal use only.
static int findMaxXr(ReportElement[] elt)
          For internal use only
static int findMaxYd(ReportElement[] elt)
          For internal use only
static int findMinX(ReportElement[] elt)
          For internal use only
static int findMinY(ReportElement[] elt)
          For internal use only
static java.util.Vector<ReportElement> findSpecificElements(ReportElement[] ret, java.lang.String type)
          For internal use only.
 short getAlign()
          Get the horizontal alignment of this element.
 java.util.Vector<java.awt.Color> getAllColors(java.util.Vector<java.awt.Color> colors)
          for internal use only.
 java.awt.Color getBgColor()
          Get the background color of this element.
 java.lang.String getBookmark()
          internal use only

Gets the bookmark associated with this ReportElement.

 int getBorder(quadbase.reportdesigner.ReportElements.BorderSide borderSide)
           
 java.awt.Color getBorderColor()
          Get the border color of this element
 int getBorderThickness()
          Deprecated. 
 int getBottomBorder()
           
 java.lang.String getCustomID()
          Get the custom ID of this element
 double getDrawX()
          internal use only
 double getDrawX(int i)
          internal use only
 double getDrawY()
          internal use only
 double getDrawY(int i)
          internal use only
 java.lang.String getDrillDownName()
          Get the web link of this element
static java.lang.String getElementType(ReportElement elt)
          For internal use only
static java.lang.String getElementTypeName(int elementType)
           
static java.util.Vector<ReportElement>[] getFirst2RowOfColumns(ReportElement[] elt)
           
static java.util.Vector<ReportElement>[] getFirst2RowOfColumns(java.util.Vector<ReportElement> vec)
           
 java.awt.Font getFont()
          Get the font name of this element
 java.awt.Color getFontColor()
          Get the Font color of this element.
 double getHeight()
          INCH Get the height of this element
 double getHeight(boolean isMetric)
          Gets the height.
 int getHeightOfElement()
          Gets the height of this element in pixel *
 int getHeightOfElement(boolean forExport)
          For Internal use only.
 float getHeightToPoints()
          POINTS This is for export to PDF format 1 inch = 72 points
 java.lang.String getHint()
          Get the link hint of this element
 java.lang.String getID()
          Get the id of this element
 int getLeftBorder()
           
 java.lang.String getLink()
          Get the web link of this element
static double getMaxXr(ReportElement[] elt)
          For internal use only.
 double getMin_Height()
           
 double getMin_Width()
           
static double getMinX(ReportElement[] elt)
          For internal use only.
 java.awt.Font getRefFont()
          INTERNAL USE ONLY
 java.awt.Font getRefFontToDraw(boolean adjust)
          INTERNAL USE ONLY ONLY FOR VIEWER.
 int getRightBorder()
           
 double getRotateAngle()
           
 int getRoundCornerRadius()
           
 boolean[] getRoundCornersArray()
           
 java.lang.String getScript()
          Gets the scripting text of this ReportElement, if available.
 java.lang.String getScriptName()
          Gets the script name.
 Script getScriptObj()
          Gets the Script Object.
 java.lang.String[] getSecuredScripts()
          internal use only *
 ReportElement getSecurityLevel(java.lang.String levelName)
          Get the secured ReportElement associated with the specified Security level name.
 java.lang.String[] getSecurityLevels()
          gets the security levels associated with this ReportElement.
protected  java.util.Hashtable<java.lang.String,ReportElement> getSecurityMap()
          For internal use only.
 short getSnap()
          for internal use only.
 java.lang.String getStyleName()
          Get the external style name of this element
 java.lang.String getTarget()
          Get the link target of this element
 java.lang.String getText()
          Get the text of this element
 int getTopBorder()
           
 short getVAlign()
          Get the vertical alignment of this element.
 short getVSnap()
          for internal use only.
 double getWidth()
          INCH Get the width of this element
 double getWidth(boolean isMetric)
          Get the width of this element
 int getWidthOfElement()
          This is used for the export of the DHTML
 int getWidthOfElement(boolean forExport)
          For Internal use only.
 float getWidthToPoints()
          POINTS This is for export to PDF format 1 inch = 72 points
 double getX()
          Get the X-coordinate value of the upper left corner of this element
 double getX(boolean isMetric)
          Get the X-coordinate value of the upper left corner of this element in inches/cms
 int getXPos()
          Get the X-coordinate value as the pixel
 int getXPos(boolean forExport)
          For Internal use only.
 float getXToPoints()
          For Internal use only.
 double getY()
          INCH Get the Y-coordinate value of the upper left corner of this element
 double getY(boolean isMetric)
          INCH/CM Get the Y-coordinate value of the upper left corner of this element
 int getYPos()
          Get the X-coordinate value as the pixel
 int getYPos(boolean forExport)
          For Internal use only.
 float getYToPoints()
          For internal use only *
 int getZ()
          Gets the z-index of this report element.
 boolean hasBorder()
           
 boolean inBottomHalf(double cy)
          For internal use only
 boolean inLeftEnd(double cx)
          For internal use only
 boolean inLeftHalf(double cx)
          For internal use only
 boolean inRightEnd(double cx, double w)
          For internal use only
 boolean inRightHalf(double cx)
          For internal use only
 boolean inTopHalf(double cy)
          For internal use only
static boolean isCrossTabElt(ReportElement elt)
           
 boolean isDrawAgain()
          internal use only
 boolean isLocked()
          internal use only

Gets whether this ReportElement position is locked

 boolean isNoWrap()
          For HTML use Check the status of html text wrapping
 boolean isResizeToFitContent()
          Gets whether this ReportElement should be resized to fit all of its content.
 boolean isSecurityLevelDefined()
          Is any security level defined for this element.
 boolean isSecurityTextScript()
          For internal use only.
 boolean isShiftSecuredColX()
          For internal use only.
 boolean isShiftSecuredColXIncludeHeaderAndFooter()
          For internal use only.
 boolean isSnapToGrid()
          internal use only *
 boolean isUnderline()
          Check the status of underline text
 boolean isVisible()
          Gets the status of the display of this ReportElement.
static void moveForCrossTabFixedField(ReportElement elt, ReportElement[] elts, boolean isHorizontal, double change)
          internal use only Shift surrounding report elements after moving one
static void moveForCrossTabFixedField(java.util.Vector<ReportElement> groupFormat, ReportElement[] elts, boolean isHorizontal, double change)
           
 void newArrayX(int nRow)
          internal use only
 void newArrayY(int nRow)
          internal use only
 void read(java.io.DataInput in, int version)
          For internal use only.
 void readXML(org.w3c.dom.Node node, int version)
          For internal use only.
 void removeScriptReferenced(Script s)
          internal use only.
 void removeSecurityLevel(java.lang.String levelName)
          Remove the security level associated with the specific name.
 void renameSecurityLevel(java.lang.String oldName, java.lang.String newName)
          internal use only
 void resize(double xratio, double yratio)
          Resizes this ReportElement.
static void resizeForCrossTabFixedField(ReportElement resizeItem, ReportElement[] elts, double newW, double newH)
          internal use only Shift surrounding report elements after moving one
static void resizeForCrossTabFixedField(java.util.Vector<ReportElement> resizeItems, ReportElement[] elts, double ratioW, double ratioH, double startXD, double startYD)
          internal use only Shift surrounding report elements after moving one
 boolean scriptReferenced(Script s)
          internal use only.
 boolean securityScriptReferenced(Script s)
          internal use only.
 void setAlign(short newAlign)
          Set the horizontal alignment of this element.
 void setBgColor(java.awt.Color newColorBg)
          Set the background color of this element.
 void setBookmark(java.lang.String bookmark)
          internal use only

For exporting the report to a PDF format, you can set a bookmark that will be associated with this ReportElement to provide the user a link from a boookmark with the specified name to the location of this ReportElement.

 void setBorder(int b)
          Deprecated. 
 void setBorderColor(java.awt.Color newBorderColor)
          Set the border color of this element
 void setBorderThickness(int borderThickness)
          Set the border thickness of this element
 void setBorderThickness(int borderThickness, quadbase.reportdesigner.ReportElements.BorderSide borderSide)
           
 void setBorderThickness(int topBorder, int rightBorder, int bottomBorder, int leftBorder)
           
 void setBottomBorder(int bottomBorder)
           
 void setCustomID(java.lang.String newID)
          Set the custom ID of this element
 void setDrawAgain(boolean b)
          internal use only
 void setDrawX(double drawX)
          internal use only
 void setDrawX(int i, double x)
          internal use only
 void setDrawY(double drawY)
          internal use only
 void setDrawY(int i, double y)
          internal use only
 void setDrillDownName(java.lang.String name)
          Set the drilldown name of this element
 void setFont(java.awt.Font newFont)
          Set the font name of this element
 void setFontColor(java.awt.Color newColorFt)
          Set the Font color of this element.
 void setHeight(double height)
          INCH Set the height of this element
 void setHeight(double height, boolean isMetric)
          INCH/CM Set the height of this element
 void setHint(java.lang.String newHint)
          Set the link hint of this element
 void setID(java.lang.String newID)
          Set the id of this element
 void setID(java.lang.String prefix, java.lang.Object[] elts)
          For internal use only.
 void setInchGridSpace(double space)
          internal use only *
 void setLeftBorder(int leftBorder)
           
 void setLink(java.lang.String newLink)
          Set the web link of this element
 void setLocked(boolean state)
          internal use only

Sets whether the ReportElement position should be locked.

 void setMinHeight(double mH)
           
 void setMinWidth(double mW)
           
 void setNoWrap(boolean w)
          For HTML use Set the status of html text wrapping
 void setResizeToFitContent(boolean b)
          Sets whether this ReportElement should be resized to fit all of its content.
 void setRightBorder(int rightBorder)
           
 void setRotateAngle(double rotate_angle)
           
 void setRotateAngle(double rotate_angle, boolean resizeCell)
           
 void setRoundCornerRadius(int roundCornerRadius)
           
 void setRoundCornersArray(boolean[] roundCorners)
           
 void setScript(java.lang.String s)
          Sets the scripting text of the ReportElement.
 void setScriptName(java.lang.String s)
          Sets the Script name.
 void setScriptObj(Script scriptObj)
          Sets the Script Object.
 void setScriptObjNull(Script scriptObj)
          set the script Object to null
 void setSecurityLevelProperties(java.lang.String levelName, ReportElement level)
          For internal use only.
 void setSecurityMap(java.util.Hashtable<java.lang.String,ReportElement> table)
          For internal use only.
 void setSecurityTextScript(boolean state)
          For internal use only.
 void setShiftSecuredColX(boolean state)
          For internal use only.
 void setShiftSecuredColXIncludeHeaderAndFooter(boolean state)
          For internal use only.
 void setSnap(short snap)
          for internal use only.
 void setSnapToGrid(boolean snapToGrid, boolean metric, double stepSize)
          internal use only *
 void setSnapToGrid(boolean snapToGrid, double stepSize, double cmStepSize)
          internal use only *
 void setStyleName(java.lang.String newStyleName)
          Set the style name of this element
 void setTarget(java.lang.String newTarget)
          Set the link target of this element
 void setText(java.lang.String newText)
          Set the text of this element
 void setTopBorder(int topBorder)
           
 void setUnderline(boolean underline)
          set the status of underline text
 void setVAlign(short newVAlign)
          Set the vertical alignment of this element.
 void setVisible(boolean b)
          Sets the status of the display of this ReportElement.
 void setVSnap(short vsnap)
          for internal use only.
 void setWidth(double width)
          INCH Set the width of this element
 void setWidth(double width, boolean isMetric)
          INCH/CM Set the width of this element
 void setX(double x)
          INCHES Set the X-coordinate value of the upper left corner of this element
 void setX(double x, boolean isMetric)
          INCH/CM Set the X-coordinate value of the upper left corner of this element
 void setXX(double x)
          internal use only
 void setXX(double x, boolean doNotReCal)
           
 void setY(double y)
          INCH Set the Y-coordinate value of the upper left corner of this element
 void setY(double y, boolean isMetric)
          INCH/CM Set the Y-coordinate value of the upper left corner of this element
 void setYY(double y)
          internal use only *
 void setYY(double y, boolean doNotReCal)
           
 void setZ(int z)
          Sets the z-index of this report element.
static void shift(ReportElement elt, ReportElement[] elts, boolean isHorizontal, double change)
          internal use only Shift surrounding report elements after resizing one
static void shiftObjectsOnMove(ReportElement elt, ReportElement[] elts, boolean isHorizontal, double change)
          internal use only For internal use only--move only surrounding objects
static void shiftOnMove(ReportElement elt, ReportElement[] elts, boolean isHorizontal, double change)
          internal use only Shift surrounding report elements after moving one
static java.util.Vector<ReportElement[]> sortElement(ReportElement[] areportcell)
          internal use only *
static ReportElement[] sortElement(ReportElement[] elemsToSort, int order, boolean asc)
          sort elements R using insertion sort according to ORDER destructively.
static java.util.Vector<ReportElement[]> sortElementHorizontally(ReportElement[] areportcell)
          For internal use only.
static java.util.Vector<ReportElement> sortElementInXYOrder(ReportElement[] areportCell)
           
static java.util.Vector<ReportElement[]> sortElementVertically(ReportElement[] areportcell)
          For internal use only.
static void swapElements(ReportElement elt1, ReportElement elt2, ReportElement[] cells)
          internal use only

Swap 2 elements

 void switchSecurityProperties(ReportElement element)
          For internal use only.
 void write(java.io.DataOutput out)
          For internal use only.
 void writeXML(java.io.Writer out, boolean writeElementTag)
          For internal use only.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

bgColor

protected java.awt.Color bgColor

x

protected double x

width

protected double width

height

protected double height

min_width

protected double min_width

min_height

protected double min_height

rotate_angle

protected double rotate_angle

borderColor

protected java.awt.Color borderColor

isLocked

protected boolean isLocked

snap

protected short snap

vsnap

protected short vsnap

visible

protected boolean visible

securityMap

protected java.util.Hashtable<java.lang.String,ReportElement> securityMap

roundCornerRadius

protected int roundCornerRadius

roundCornersArray

protected boolean[] roundCornersArray

SORT_Y

public static final int SORT_Y
for sorting in Y (vertical) direction. *

See Also:
Constant Field Values

SORT_X

public static final int SORT_X
for sorting in X (horizontal) direction. *

See Also:
Constant Field Values

SORT_Z

public static final int SORT_Z
for sorting in Z (depth) direction. *

See Also:
Constant Field Values

CHART

public static final int CHART
The element type CHART. *

See Also:
Constant Field Values

GRID

public static final int GRID
The element type GRID. *

See Also:
Constant Field Values

LINE

public static final int LINE
The element type LINE. *

See Also:
Constant Field Values

IMAGE

public static final int IMAGE
The element type IMAGE. *

See Also:
Constant Field Values

COLUMN

public static final int COLUMN
The element type COLUMN. *

See Also:
Constant Field Values

FORMULA

public static final int FORMULA
The element type FORMULA. *

See Also:
Constant Field Values

LABEL

public static final int LABEL
The element type LABEL. *

See Also:
Constant Field Values

SECTION

public static final int SECTION
The element type SECTION. *

See Also:
Constant Field Values

TABLE

public static final int TABLE
The element type TABLE. *

See Also:
Constant Field Values

SUBREPORT

public static final int SUBREPORT
The element type SUBREPORT. *

See Also:
Constant Field Values

RTFOBJECT

public static final int RTFOBJECT
The element type of ReportRTFObject *

See Also:
Constant Field Values

TABLEOFCONTENTS

public static final int TABLEOFCONTENTS
See Also:
Constant Field Values

COLUMNHEADER

public static final int COLUMNHEADER
See Also:
Constant Field Values

TITLE

public static final int TITLE
See Also:
Constant Field Values

NONE

public static final int NONE
See Also:
Constant Field Values

ID_TYPE

public static final java.lang.String[] ID_TYPE

ROTATE_NONE

public static final int ROTATE_NONE
See Also:
Constant Field Values

ROTATE_CLOCKWISE

public static final int ROTATE_CLOCKWISE
See Also:
Constant Field Values

ROTATE_COUNTERCLOCKWISE

public static final int ROTATE_COUNTERCLOCKWISE
See Also:
Constant Field Values
Constructor Detail

ReportElement

public ReportElement()
Default constructor to create an instance of ReportElement


ReportElement

public ReportElement(java.lang.String name)
Creates a new instance of ReportElement with the specified name.

Method Detail

copy

public void copy(ReportElement _elt)
internal use only

Specifies the properties of this ReportElement object to be the same as the properties of ReportElement object "_elt".

Parameters:
_elt - The ReportElement object to be copied

deepCopy

public void deepCopy(ReportElement _elt)
For internal use only


copyTemplate

public void copyTemplate(ReportElement _elt)
For internal use only.


applyTemplate

public void applyTemplate(ReportElement _elt)
internal use only

Specifies the look and feel of the ReportElement.

Parameters:
_elt - The ReportElement template to be applied

applyTemplate

public void applyTemplate(ReportElement _elt,
                          boolean applyScript)

applyTemplate

public void applyTemplate(ReportElement _elt,
                          boolean applyScript,
                          boolean applyElementPosition,
                          boolean copyDrillDownName)
internal use only


applyStyle

public void applyStyle(ReportElement _elt)
Applies the style properties from ReportElement _elt onto this ReportElement


applyStyleButNotWH

public void applyStyleButNotWH(ReportElement _elt)

equals

public boolean equals(ReportElement _elt)
Checks to see if the properties of this ReportElement object are the same as the properties of ReportElement object "_elt".

Parameters:
_elt - The ReportElement being compared to

contains

public boolean contains(double cx,
                        double cy)
internal use only

Check whether a coordinate point (cx,cy) is contained within this element.

Returns:
false otherwise

containsX

public boolean containsX(double cx,
                         double w)
internal use only

For Excel report: Export the Report line and Grid as Cell Border

Returns:
true if the x coordinate is contained, false otherwisw

containsY

public boolean containsY(double cy,
                         double h)
internal use only

For Excel report: Export the Report line and Grid as Cell Border

Returns:
true if the y coordinate is contained, false otherwisw

inTopHalf

public boolean inTopHalf(double cy)
For internal use only


inBottomHalf

public boolean inBottomHalf(double cy)
For internal use only


inLeftHalf

public boolean inLeftHalf(double cx)
For internal use only


inRightHalf

public boolean inRightHalf(double cx)
For internal use only


inLeftEnd

public boolean inLeftEnd(double cx)
For internal use only


inRightEnd

public boolean inRightEnd(double cx,
                          double w)
For internal use only


isSecurityTextScript

public boolean isSecurityTextScript()
For internal use only.


setSecurityTextScript

public void setSecurityTextScript(boolean state)
For internal use only.


isShiftSecuredColX

public boolean isShiftSecuredColX()
For internal use only.


isShiftSecuredColXIncludeHeaderAndFooter

public boolean isShiftSecuredColXIncludeHeaderAndFooter()
For internal use only.


setShiftSecuredColX

public void setShiftSecuredColX(boolean state)
For internal use only.


setShiftSecuredColXIncludeHeaderAndFooter

public void setShiftSecuredColXIncludeHeaderAndFooter(boolean state)
For internal use only.


applySecurity

public void applySecurity(ReportElement _elt)

getScript

public java.lang.String getScript()
Gets the scripting text of this ReportElement, if available. *


setScript

public void setScript(java.lang.String s)
Sets the scripting text of the ReportElement. *


getScriptName

public java.lang.String getScriptName()
Gets the script name. *


setScriptName

public void setScriptName(java.lang.String s)
Sets the Script name. *


getScriptObj

public Script getScriptObj()
Gets the Script Object. *


setScriptObj

public void setScriptObj(Script scriptObj)
Sets the Script Object. *


setScriptObjNull

public void setScriptObjNull(Script scriptObj)
set the script Object to null


getAlign

public short getAlign()
Get the horizontal alignment of this element. Returns alignment constants as listed in IAlignConstants.

See Also:
IAlignConstants

setAlign

public void setAlign(short newAlign)
Set the horizontal alignment of this element. Takes alignment constants listed in IAlignConstants.

See Also:
IAlignConstants

getVAlign

public short getVAlign()
Get the vertical alignment of this element. Returns alignment constants as listed in IAlignConstants.

See Also:
IAlignConstants

setVAlign

public void setVAlign(short newVAlign)
Set the vertical alignment of this element. Takes alignment constants listed in IAlignConstants.

See Also:
IAlignConstants

setSnap

public void setSnap(short snap)
for internal use only. *


getSnap

public short getSnap()
for internal use only. *


setVSnap

public void setVSnap(short vsnap)
for internal use only. *


getVSnap

public short getVSnap()
for internal use only. *


getBgColor

public java.awt.Color getBgColor()
Get the background color of this element.

Returns:
Color java.awt.Color object

setBgColor

public void setBgColor(java.awt.Color newColorBg)
Set the background color of this element.

Parameters:
newColorBg - the new background Color

getFontColor

public java.awt.Color getFontColor()
Get the Font color of this element.

Returns:
Color java.awt.Color object

setFontColor

public void setFontColor(java.awt.Color newColorFt)
Set the Font color of this element.

Parameters:
newColorFt - the new Font Color

getAllColors

public java.util.Vector<java.awt.Color> getAllColors(java.util.Vector<java.awt.Color> colors)
for internal use only. *


isUnderline

public boolean isUnderline()
Check the status of underline text

Returns:
the status of underline text

setUnderline

public void setUnderline(boolean underline)
set the status of underline text

Parameters:
underline - the new status of underline text

getFont

public java.awt.Font getFont()
Get the font name of this element

Returns:
Font name of this element

getRefFont

public java.awt.Font getRefFont()
INTERNAL USE ONLY


setFont

public void setFont(java.awt.Font newFont)
Set the font name of this element

Parameters:
Font - font name of this element

getRefFontToDraw

public java.awt.Font getRefFontToDraw(boolean adjust)
INTERNAL USE ONLY ONLY FOR VIEWER. when true, adjust the font based on the resolution of the server


getText

public java.lang.String getText()
Get the text of this element

Returns:
the text of this element

setText

public void setText(java.lang.String newText)
Set the text of this element

Parameters:
newText - the value of new text

getID

public java.lang.String getID()
Get the id of this element

Returns:
the id of this element

setID

public void setID(java.lang.String newID)
Set the id of this element

Parameters:
newID - the value of new id

getCustomID

public java.lang.String getCustomID()
Get the custom ID of this element

Returns:
the custom ID of this element

setCustomID

public void setCustomID(java.lang.String newID)
Set the custom ID of this element

Parameters:
newID - the value of new custom ID

isNoWrap

public boolean isNoWrap()
For HTML use Check the status of html text wrapping

Returns:
the status of html text wrapping

setNoWrap

public void setNoWrap(boolean w)
For HTML use Set the status of html text wrapping

Parameters:
w - the new status of html text wrapping

isResizeToFitContent

public boolean isResizeToFitContent()
Gets whether this ReportElement should be resized to fit all of its content. *


setResizeToFitContent

public void setResizeToFitContent(boolean b)
Sets whether this ReportElement should be resized to fit all of its content. *


isLocked

public boolean isLocked()
internal use only

Gets whether this ReportElement position is locked


setLocked

public void setLocked(boolean state)
internal use only

Sets whether the ReportElement position should be locked. If this element is snap to guideline, then it cann't be locked.


getStyleName

public java.lang.String getStyleName()
Get the external style name of this element

Returns:
the external style name of this element

setStyleName

public void setStyleName(java.lang.String newStyleName)
Set the style name of this element

Parameters:
newStyleName - the value of new style name

getLink

public java.lang.String getLink()
Get the web link of this element

Returns:
the web link of this element

setLink

public void setLink(java.lang.String newLink)
Set the web link of this element

Parameters:
newLink - the value of new web link

getHint

public java.lang.String getHint()
Get the link hint of this element

Returns:
the link hint of this element

setHint

public void setHint(java.lang.String newHint)
Set the link hint of this element

Parameters:
newhint - the value of new link hint

getTarget

public java.lang.String getTarget()
Get the link target of this element

Returns:
the link target of this element

setTarget

public void setTarget(java.lang.String newTarget)
Set the link target of this element

Parameters:
newtarget - the value of new link target

getDrillDownName

public java.lang.String getDrillDownName()
Get the web link of this element

Returns:
the drilldown name of this element

setDrillDownName

public void setDrillDownName(java.lang.String name)
Set the drilldown name of this element

Parameters:
name - the drilldown value of the drilldown report

getX

public double getX()
Get the X-coordinate value of the upper left corner of this element

Returns:
X-coordinate value of the upper left corner of this element In INCHES **

getXPos

public int getXPos()
Get the X-coordinate value as the pixel


getXPos

public int getXPos(boolean forExport)
For Internal use only. to convert inch to pixel regardless of the resolution.


getXToPoints

public float getXToPoints()
For Internal use only.


getYToPoints

public float getYToPoints()
For internal use only *


getX

public double getX(boolean isMetric)
Get the X-coordinate value of the upper left corner of this element in inches/cms

Parameters:
isMetric - If true, the result is in cm, inches otherwise.
Returns:
X-coordinate value of the upper left corner of this element in inches/cms

setX

public void setX(double x)
INCHES Set the X-coordinate value of the upper left corner of this element

Parameters:
x - x-coordinate value of the upper left corner of this element

setXX

public void setXX(double x,
                  boolean doNotReCal)

setX

public void setX(double x,
                 boolean isMetric)
INCH/CM Set the X-coordinate value of the upper left corner of this element

Parameters:
x - x-coordinate value of the upper left corner of this element

setXX

public void setXX(double x)
internal use only


getY

public double getY()
INCH Get the Y-coordinate value of the upper left corner of this element

Returns:
Y-coordinate value of the upper left corner of this element

getYPos

public int getYPos()
Get the X-coordinate value as the pixel


getYPos

public int getYPos(boolean forExport)
For Internal use only. to convert inch to pixel regardless of the resolution.


getY

public double getY(boolean isMetric)
INCH/CM Get the Y-coordinate value of the upper left corner of this element

Parameters:
isMetric - If true, the result is in cm, inches otherwise.
Returns:
Y-coordinate value of the upper left corner of this element

setY

public void setY(double y)
INCH Set the Y-coordinate value of the upper left corner of this element

Parameters:
y - y-coordinate value of the upper left corner of this element

setYY

public void setYY(double y,
                  boolean doNotReCal)

setYY

public void setYY(double y)
internal use only *


setY

public void setY(double y,
                 boolean isMetric)
INCH/CM Set the Y-coordinate value of the upper left corner of this element

Parameters:
y - y-coordinate value of the upper left corner of this element

getWidth

public double getWidth()
INCH Get the width of this element

Returns:
width value of this element

getWidthOfElement

public int getWidthOfElement()
This is used for the export of the DHTML


getWidthOfElement

public int getWidthOfElement(boolean forExport)
For Internal use only. to convert inch to pixel regardless of the resolution.


getWidthToPoints

public float getWidthToPoints()
POINTS This is for export to PDF format 1 inch = 72 points


getWidth

public double getWidth(boolean isMetric)
Get the width of this element

Returns:
width value of this element in CM if and only if isMetric, otherwise returns the value in INCH

setWidth

public void setWidth(double width)
INCH Set the width of this element

Parameters:
width - width of this element

setWidth

public void setWidth(double width,
                     boolean isMetric)
INCH/CM Set the width of this element

Parameters:
width - width of this element
isMetric - if using metric system

setMinWidth

public void setMinWidth(double mW)

setMinHeight

public void setMinHeight(double mH)

getMin_Width

public double getMin_Width()

getMin_Height

public double getMin_Height()

getHeight

public double getHeight()
INCH Get the height of this element

Returns:
height value of this element

getHeightOfElement

public int getHeightOfElement()
Gets the height of this element in pixel *


getHeightOfElement

public int getHeightOfElement(boolean forExport)
For Internal use only. to convert inch to pixel regardless of the resolution.


getHeightToPoints

public float getHeightToPoints()
POINTS This is for export to PDF format 1 inch = 72 points


getHeight

public double getHeight(boolean isMetric)
Gets the height.

Parameters:
isMetric - is it metric (cm) or no (INCH)

setHeight

public void setHeight(double height)
INCH Set the height of this element

Parameters:
height - height of this element

setHeight

public void setHeight(double height,
                      boolean isMetric)
INCH/CM Set the height of this element

Parameters:
height - height of this element
isMetric - if using metric system

resize

public void resize(double xratio,
                   double yratio)
Resizes this ReportElement. *


getBorderThickness

@Deprecated
public int getBorderThickness()
Deprecated. 

Get the border thickness of this element. DEPRECATED: please use getTopBorderThickness(), getRightBorderThickness(), getBottomBorderThickness() and getLeftBorderThickness() methods instead.

Returns:
border thickness of this element

setBorderThickness

public void setBorderThickness(int borderThickness)
Set the border thickness of this element

Parameters:
newBorder - new border thickness of this element

setBorderThickness

public void setBorderThickness(int borderThickness,
                               quadbase.reportdesigner.ReportElements.BorderSide borderSide)

setBorderThickness

public void setBorderThickness(int topBorder,
                               int rightBorder,
                               int bottomBorder,
                               int leftBorder)

setBorder

@Deprecated
public void setBorder(int b)
Deprecated. 


getBorderColor

public java.awt.Color getBorderColor()
Get the border color of this element

Returns:
color of the border of this element

setBorderColor

public void setBorderColor(java.awt.Color newBorderColor)
Set the border color of this element

Parameters:
newBorderColor - new border color of this element

sortElement

public static ReportElement[] sortElement(ReportElement[] elemsToSort,
                                          int order,
                                          boolean asc)
sort elements R using insertion sort according to ORDER destructively.


sortElementInXYOrder

public static java.util.Vector<ReportElement> sortElementInXYOrder(ReportElement[] areportCell)

sortElementHorizontally

public static java.util.Vector<ReportElement[]> sortElementHorizontally(ReportElement[] areportcell)
For internal use only.

Returns:
vector with RE[] ordered by the X coordinate vector elements ordered by Y

sortElement

public static java.util.Vector<ReportElement[]> sortElement(ReportElement[] areportcell)
internal use only *


sortElementVertically

public static java.util.Vector<ReportElement[]> sortElementVertically(ReportElement[] areportcell)
For internal use only. return vector with RE[] ordered by the Y coordinate


getFirst2RowOfColumns

public static java.util.Vector<ReportElement>[] getFirst2RowOfColumns(java.util.Vector<ReportElement> vec)

getFirst2RowOfColumns

public static java.util.Vector<ReportElement>[] getFirst2RowOfColumns(ReportElement[] elt)

write

public void write(java.io.DataOutput out)
           throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

writeXML

public void writeXML(java.io.Writer out,
                     boolean writeElementTag)
              throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

readXML

public void readXML(org.w3c.dom.Node node,
                    int version)
             throws java.lang.Exception
For internal use only.

Throws:
java.lang.Exception

read

public void read(java.io.DataInput in,
                 int version)
          throws java.lang.Exception
For internal use only.

Throws:
java.lang.Exception

getElementType

public static java.lang.String getElementType(ReportElement elt)
For internal use only


findElementType

public static int findElementType(ReportElement elt)
For internal use only.


findGroupElementType

public static int findGroupElementType(ReportElement elt)
For internal use only. For Group selection.


setID

public void setID(java.lang.String prefix,
                  java.lang.Object[] elts)
For internal use only.


findSpecificElements

public static java.util.Vector<ReportElement> findSpecificElements(ReportElement[] ret,
                                                                   java.lang.String type)
For internal use only.


swapElements

public static void swapElements(ReportElement elt1,
                                ReportElement elt2,
                                ReportElement[] cells)
internal use only

Swap 2 elements


shift

public static void shift(ReportElement elt,
                         ReportElement[] elts,
                         boolean isHorizontal,
                         double change)
internal use only Shift surrounding report elements after resizing one


shiftOnMove

public static void shiftOnMove(ReportElement elt,
                               ReportElement[] elts,
                               boolean isHorizontal,
                               double change)
internal use only Shift surrounding report elements after moving one


resizeForCrossTabFixedField

public static void resizeForCrossTabFixedField(java.util.Vector<ReportElement> resizeItems,
                                               ReportElement[] elts,
                                               double ratioW,
                                               double ratioH,
                                               double startXD,
                                               double startYD)
internal use only Shift surrounding report elements after moving one


contains

public static boolean contains(ReportElement elt,
                               java.util.Vector<ReportElement> eltList)

resizeForCrossTabFixedField

public static void resizeForCrossTabFixedField(ReportElement resizeItem,
                                               ReportElement[] elts,
                                               double newW,
                                               double newH)
internal use only Shift surrounding report elements after moving one


moveForCrossTabFixedField

public static void moveForCrossTabFixedField(ReportElement elt,
                                             ReportElement[] elts,
                                             boolean isHorizontal,
                                             double change)
internal use only Shift surrounding report elements after moving one


moveForCrossTabFixedField

public static void moveForCrossTabFixedField(java.util.Vector<ReportElement> groupFormat,
                                             ReportElement[] elts,
                                             boolean isHorizontal,
                                             double change)

isCrossTabElt

public static boolean isCrossTabElt(ReportElement elt)

shiftObjectsOnMove

public static void shiftObjectsOnMove(ReportElement elt,
                                      ReportElement[] elts,
                                      boolean isHorizontal,
                                      double change)
internal use only For internal use only--move only surrounding objects


findMinX

public static int findMinX(ReportElement[] elt)
For internal use only


findMaxXr

public static int findMaxXr(ReportElement[] elt)
For internal use only


getMinX

public static double getMinX(ReportElement[] elt)
For internal use only.


getMaxXr

public static double getMaxXr(ReportElement[] elt)
For internal use only.


findMinY

public static int findMinY(ReportElement[] elt)
For internal use only


findMaxYd

public static int findMaxYd(ReportElement[] elt)
For internal use only


findElementsToRight

public static ReportElement[] findElementsToRight(ReportElement r,
                                                  ReportElement[] ret)
For internal use only


findElementsToRight

public static java.util.Vector<ReportElement> findElementsToRight(ReportElement[] r,
                                                                  ReportElement[] ret)
For internal use only


findElementsToLeft

public static ReportElement[] findElementsToLeft(ReportElement r,
                                                 ReportElement[] ret)
For internal use only


findElementsAbove

public static ReportElement[] findElementsAbove(ReportElement r,
                                                ReportElement[] ret)
For internal use only


findElementsBelow

public static java.util.Vector<ReportElement> findElementsBelow(ReportElement[] r,
                                                                ReportElement[] ret)
For internal use only


applyImageTemplate

public void applyImageTemplate(ReportElement _elt)
For internal use only


applyImageTemplateExceptBound

public void applyImageTemplateExceptBound(ReportElement _elt)
For internal use only


scriptReferenced

public boolean scriptReferenced(Script s)
internal use only. *


securityScriptReferenced

public boolean securityScriptReferenced(Script s)
internal use only. *


removeScriptReferenced

public void removeScriptReferenced(Script s)
internal use only. *


createScriptObject

public void createScriptObject(java.util.Vector<Script> scripts)
For internal use only *


createScriptObjectFromName

public void createScriptObjectFromName(java.util.Vector<Script> scripts)
For internal use only *


isSnapToGrid

public boolean isSnapToGrid()
internal use only *


setSnapToGrid

public void setSnapToGrid(boolean snapToGrid,
                          double stepSize,
                          double cmStepSize)
internal use only *


setSnapToGrid

public void setSnapToGrid(boolean snapToGrid,
                          boolean metric,
                          double stepSize)
internal use only *


setInchGridSpace

public void setInchGridSpace(double space)
internal use only *


isVisible

public boolean isVisible()
Gets the status of the display of this ReportElement.


setVisible

public void setVisible(boolean b)
Sets the status of the display of this ReportElement.


isSecurityLevelDefined

public boolean isSecurityLevelDefined()
Is any security level defined for this element.


addSecurityLevel

public ReportElement addSecurityLevel(java.lang.String levelName)
Create a new security level for this element. The new level is associated with the name specified. Although a security level is encapsulated in a ReportElement object, the only significant attributes are visibility, text and script. All other attributes are referenced from the base element.

Parameters:
levelName - the name of the security level to add to this ReportElement
Returns:
the secured ReportElement if the report is opened/exported with the specified security level name. Modify (set it to be visible, use script, etc.) this ReportElement for the behavior when the specified security level name is used.

getSecurityLevel

public ReportElement getSecurityLevel(java.lang.String levelName)
Get the secured ReportElement associated with the specified Security level name.

Parameters:
levelName - the name of the security level to get the secured ReportElement
Returns:
the secured ReportElement if the report is opened/exported with the specified security level name. Modify (set it to be visible, use script, etc.) this ReportElement for the behavior when the specified security level name is used. Returns NULL if none is found.

removeSecurityLevel

public void removeSecurityLevel(java.lang.String levelName)
Remove the security level associated with the specific name.


getSecurityLevels

public java.lang.String[] getSecurityLevels()
gets the security levels associated with this ReportElement. *


getSecuredScripts

public java.lang.String[] getSecuredScripts()
internal use only *


setSecurityLevelProperties

public void setSecurityLevelProperties(java.lang.String levelName,
                                       ReportElement level)
For internal use only.


setSecurityMap

public void setSecurityMap(java.util.Hashtable<java.lang.String,ReportElement> table)
For internal use only. This method is only called by ReportMain.


getSecurityMap

protected java.util.Hashtable<java.lang.String,ReportElement> getSecurityMap()
For internal use only. This method is only called by ReportMain.


switchSecurityProperties

public void switchSecurityProperties(ReportElement element)
For internal use only. Switch the security properties between this element and the argument.


setBookmark

public void setBookmark(java.lang.String bookmark)
internal use only

For exporting the report to a PDF format, you can set a bookmark that will be associated with this ReportElement to provide the user a link from a boookmark with the specified name to the location of this ReportElement.

Parameters:
bookmark - name of the bookmark.

getBookmark

public java.lang.String getBookmark()
internal use only

Gets the bookmark associated with this ReportElement.

See Also:
for more detail.

getZ

public int getZ()
Gets the z-index of this report element. Z-index controls the depth of an element, or the order in which they are drawn on a 2D report. This integer can be arbitrarily assigned so that if two elements A (with z-index 3) and B (with z-index 2), A would be drawn after or on top of B.

Returns:
the z-index, from the range of 0 <= z < sizeof(int)

setZ

public void setZ(int z)
Sets the z-index of this report element. Z-index controls the depth of an element, or the order in which they are drawn on a 2D report. This integer can be arbitrarily assigned so that if two elements A (with z-index 3) and B (with z-index 2), A would be drawn after or on top of B.

Parameters:
z - the z-index, from the range of 0 <= z < sizeof(int), negative values are truncated to 0.

setDrawAgain

public void setDrawAgain(boolean b)
internal use only


isDrawAgain

public boolean isDrawAgain()
internal use only


getDrawX

public double getDrawX()
internal use only


setDrawX

public void setDrawX(double drawX)
internal use only


getDrawY

public double getDrawY()
internal use only


setDrawY

public void setDrawY(double drawY)
internal use only


newArrayY

public void newArrayY(int nRow)
internal use only


newArrayX

public void newArrayX(int nRow)
internal use only


getDrawY

public double getDrawY(int i)
internal use only


getDrawX

public double getDrawX(int i)
internal use only


setDrawY

public void setDrawY(int i,
                     double y)
internal use only


setDrawX

public void setDrawX(int i,
                     double x)
internal use only


renameSecurityLevel

public void renameSecurityLevel(java.lang.String oldName,
                                java.lang.String newName)
internal use only


getRotateAngle

public double getRotateAngle()

setRotateAngle

public void setRotateAngle(double rotate_angle)

setRotateAngle

public void setRotateAngle(double rotate_angle,
                           boolean resizeCell)

setRoundCornerRadius

public void setRoundCornerRadius(int roundCornerRadius)
Parameters:
roundCornerRadius - the roundCornerRadius to set

getRoundCornerRadius

public int getRoundCornerRadius()
Returns:
the roundCornerRadius

setRoundCornersArray

public void setRoundCornersArray(boolean[] roundCorners)
Parameters:
roundCorners - the roundCorners to set

getRoundCornersArray

public boolean[] getRoundCornersArray()
Returns:
the roundCorners

doesElementSupportRoundCorners

public static boolean doesElementSupportRoundCorners(ReportElement elt)

getElementTypeName

public static java.lang.String getElementTypeName(int elementType)

getBorder

public int getBorder(quadbase.reportdesigner.ReportElements.BorderSide borderSide)

getTopBorder

public int getTopBorder()

setTopBorder

public void setTopBorder(int topBorder)

getBottomBorder

public int getBottomBorder()

setBottomBorder

public void setBottomBorder(int bottomBorder)

getLeftBorder

public int getLeftBorder()

setLeftBorder

public void setLeftBorder(int leftBorder)

getRightBorder

public int getRightBorder()

setRightBorder

public void setRightBorder(int rightBorder)

hasBorder

public boolean hasBorder()

EspressReport 6.6