public abstract class Element extends ReportComponent implements GeneralProperties, java.lang.Cloneable
Element
is the superclass of all visible objects in
the report.Section.getElements()
in class
Section
. Note that the returned array is a snapshot of the
current state of the section. The reason for this is to allow you to
insert elements into a section according to the current state without
creating infinite loops. No field of the array contains an instance of
class Element
, each of them is an instance of the subclasses
of Element
.Section.getElements()
,
Section.getElementsV()
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
BOX
Element is an instance of Box.
|
static int |
CHART
Element is an instance of Chart.
|
static int |
CROSSTAB
Element is an instance of CrossTab.
|
static int |
CROSSTABSECTION
Element is an instance of CrossTabDescriptionSection.
|
static int |
DATABASE_PICTURE
Element is an instance of DatabasePicture.
|
static int |
FIELD
Element is an instance of Field.
|
static int |
FIELDPART
Element is an instance of FieldPart.
|
static int |
FORMFIELD
Element is an instance of FormFieldElement.
|
static int |
INTERACTIVE_SORTING
Element is an instance of InteractiveSorting
|
static int |
JAVABEAN
Element is an instance of JavaBean.
|
static int |
LINE
Element is an instance of Line.
|
static int |
PARAGRAPH
Element is an instance of Paragraph.
|
static int |
PICTURE
Element is an instance of Picture.
|
static int |
SIGNATURE
Element is an instance of SignatureForm.
|
static int |
SUBREPORT
Element is an instance of Subreport.
|
static int |
TEXT
Element is an instance of Text.
|
static int |
TEXTPART
Element is an instance of TextPart.
|
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
Modifier | Constructor and Description |
---|---|
protected |
Element(int type,
com.inet.report.RendererBase renderer)
Constructor of Element with necessary dependencies, calls the full constructor with parentSection=null
|
Modifier and Type | Method and Description |
---|---|
void |
addListener(com.inet.report.RDC.ElementRemoveListener erl)
Adds a listener.
|
java.lang.Object |
copy()
Creates a serializable copy of this Element.
|
int |
getBottomLineStyle()
Returns the value of the property 'bottom line style'.
|
FormulaField |
getBottomLineStyleFormula()
Returns the formula of the property 'bottom line style'.
|
int |
getCanGrowCount()
Returns the value of the property 'can grow count'.
|
FormulaField |
getCanGrowFormula()
Returns the formula of the property 'can grow'.
|
FormulaField |
getCloseBorderOnPageBreakFormula()
Returns the formula for the property 'close border on page break'.
|
FormulaField |
getDropShadowFormula()
Returns the formula for the property 'drop shadow'.
|
Engine |
getEngine()
Returns the Engine this Element is associated with.
|
Field |
getField()
Returns the field definition element (for example, database field element, prompt field element).
|
int |
getForeColor()
Returns the fore color of the element.
|
FormulaField |
getForeColorFormula()
Returns the formula fore color of the element.
|
int |
getHorAlign()
Returns the value of the property 'horizontal alignment'.
|
FormulaField |
getHorAlignFormula()
Returns the formula for the property 'horizontal alignment'.
|
java.lang.String |
getHyperlinkUrl()
Returns the target url of the hyperlink which is associated with this element.
|
FormulaField |
getHyperlinkUrlFormula()
Returns the formula of the property 'hyperlink url'.
|
int |
getLeftLineStyle()
Returns the value of the property 'left line style'.
|
FormulaField |
getLeftLineStyleFormula()
Returns the formula for the property 'left line style'.
|
java.lang.Object |
getParent()
Returns the parent element in object hierarchie (here: Section or null).
|
java.util.List<FormulaField> |
getPropertyFormulas()
Returns a list with all property formulas that are set for this report element.
|
int |
getRightLineStyle()
Returns the value of the property 'right line style'.
|
FormulaField |
getRightLineStyleFormula()
Returns the formula for the property 'right line style'.
|
FormulaField |
getSuppressIfDuplicatedFormula()
Returns the formula for the property 'suppress if duplicated'.
|
FormulaField |
getTightHorizontalFormula()
Returns the formula for the property 'tight horizontal'.
|
java.lang.String |
getToolTipsText()
Returns the value of the property 'tool tips text'.
|
FormulaField |
getToolTipsTextFormula()
Returns the formula of the property 'tool tips text'.
|
int |
getTopLineStyle()
Returns the value of the property 'top line style'.
|
FormulaField |
getTopLineStyleFormula()
Returns the formula of the property 'top line style'.
|
int |
indexOf()
Returns the current index of this element in section (z-order).
|
boolean |
isCanGrow()
Returns the value of the property 'can grow'.
|
boolean |
isCloseBorderOnPageBreak()
Returns the value of the property 'close border on page break'.
|
boolean |
isDropShadow()
Returns the value of the property 'drop shadow'.
|
boolean |
isSuppressIfDuplicated()
Returns the value of the property 'suppress if duplicated'.
|
boolean |
isTightHorizontal()
Returns the value of the property 'tight horizontal'.
|
java.lang.String |
paramString()
Creates and return a String representation for debugging.
|
void |
removeListener(com.inet.report.RDC.ElementRemoveListener erl)
Removes a previously added listener.
|
void |
setBottomLineStyle(int newValue)
Sets the value of the property 'bottom line style'.
|
void |
setBottomLineStyleFormula(FormulaField newFormula)
Sets the formula for the property 'bottom line style'.
|
void |
setCanGrow(boolean canGrow)
Sets the value of the property 'can grow'.
|
void |
setCanGrowCount(int newValue)
Sets the value of the property 'can grow count'.
|
void |
setCanGrowFormula(FormulaField newFormula)
Sets the formula for the property 'can grow'.
|
void |
setCloseBorderOnPageBreak(boolean newValue)
Sets the value of the property 'close border on page break'.
|
void |
setCloseBorderOnPageBreakFormula(FormulaField newFormula)
Sets the formula for the property 'close border on page break'.
|
void |
setDropShadow(boolean newValue)
Sets the value of the property 'drop shadow'.
|
void |
setDropShadowFormula(FormulaField newFormula)
Sets the formula for the property 'drop shadow'.
|
void |
setField(Field newField)
Sets the field definition element (for example, DatabaseField element, prompt field element).
|
void |
setForeColor(int newValue)
Sets the value of the property 'fore color'.
|
void |
setForeColorFormula(FormulaField newFormula)
Sets the formula fore color of the element.
|
void |
setHorAlign(int value)
Sets the value of the property 'horizontal alignment'.
|
void |
setHorAlignFormula(FormulaField newFormula)
Sets the formula for the property 'horizontal alignment'.
|
void |
setHyperlinkUrl(java.lang.String url)
Sets the target location of a hyperlink which is assoziated with this element.
|
void |
setHyperlinkUrlFormula(FormulaField newFormula)
Sets the formula for the property 'hyperlink url'.
|
void |
setIndex(int zPos)
Changes the z-order position of this element in the section (0 is all the way in
the back, greater numbers cause the elements to overlap elements with a lower z
index).
|
void |
setLeftLineStyle(int newValue)
Sets the value of the property 'left line style'.
|
void |
setLeftLineStyleFormula(FormulaField newFormula)
Sets the formula for the property 'left line style'.
|
void |
setRightLineStyle(int newValue)
Sets the value of the property 'right line style'.
|
void |
setRightLineStyleFormula(FormulaField newFormula)
Sets the formula for the property 'right line style'.
|
void |
setSuppressIfDuplicated(boolean newValue)
Sets the value of the property 'suppress if duplicated'.
|
void |
setSuppressIfDuplicatedFormula(FormulaField newFormula)
Sets the formula for the property 'suppress if duplicated'.
|
void |
setTightHorizontal(boolean newValue)
Sets the value of the property 'tight horizontal'.
|
void |
setTightHorizontalFormula(FormulaField newFormula)
Sets the formula for the property 'tight horizontal'.
|
void |
setToolTipsText(java.lang.String newValue)
Sets the value of the property 'tool tips text'.
|
void |
setToolTipsTextFormula(FormulaField newFormula)
Sets the formula for the property 'tool tips text'.
|
void |
setTopLineStyle(int newValue)
Sets the value of the property 'top line style'.
|
void |
setTopLineStyleFormula(FormulaField newFormula)
Sets the formula for the property 'top line style'.
|
getBackColor, getBackColorFormula, getHeight, getKeepTogetherFormula, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isKeepTogether, isSuppress, setBackColor, setBackColorFormula, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
isDOMParser, parseDOM, parseElement, parseEndElement, parseText
public static final int TEXT
Text
,
Constant Field Valuespublic static final int FIELD
FieldElement
,
Constant Field Valuespublic static final int LINE
Line
,
Constant Field Valuespublic static final int BOX
Box
,
Constant Field Valuespublic static final int CHART
Chart2
,
Constant Field Valuespublic static final int PICTURE
Picture
,
Constant Field Valuespublic static final int SUBREPORT
Subreport
,
Constant Field Valuespublic static final int DATABASE_PICTURE
DatabasePicture
,
Constant Field Valuespublic static final int CROSSTAB
CrossTab
,
Constant Field Valuespublic static final int CROSSTABSECTION
CrossTabDescriptionSection
,
Constant Field Valuespublic static final int PARAGRAPH
Paragraph
,
Constant Field Valuespublic static final int TEXTPART
TextPart
,
Constant Field Valuespublic static final int FIELDPART
FieldPart
,
Constant Field Valuespublic static final int JAVABEAN
JavaBean
,
Constant Field Valuespublic static final int SIGNATURE
SignatureForm
,
Constant Field Valuespublic static final int FORMFIELD
FormFieldElement
,
Constant Field Valuespublic static final int INTERACTIVE_SORTING
InteractiveSorting
,
Constant Field Valuesprotected Element(int type, com.inet.report.RendererBase renderer)
type
- type of element (valid valus defined in subclasses)renderer
- renderer responsible for this elementpublic java.lang.Object copy() throws ReportException
ReportException
- If accessing properties of this Element causes any errors.Section.pasteElement(java.lang.Object)
public java.lang.String paramString()
paramString
in class ReportComponent
public Field getField()
Field
The current value of the 'field' property.public void setField(Field newField)
newField
- The new field element of the property 'field'.public java.lang.Object getParent()
public Engine getEngine()
public int indexOf()
-1
is returned.indexOf
in class ReportComponent
-1
if the Element was not found in the parent section.setIndex(int)
public void setIndex(int zPos) throws ReportException
zPos
- z Index to set for this Element. 0 would be in the very back. If
an Element's z index is greater than the z index of another Element, it will overlap
that Element.ReportException
- Thrown if this element was not found in parent sectionindexOf()
public void setForeColor(int newValue)
newValue
- the new Value for the property 'fore color'.ColorUtils.toCcColor(java.awt.Color)
,
ColorUtils.toJavaColor(int)
public int getForeColor()
ColorUtils.toCcColor(java.awt.Color)
,
ColorUtils.toJavaColor(int)
public void setForeColorFormula(FormulaField newFormula)
newFormula
- The new formula fore color of this element.ColorUtils.toCcColor(java.awt.Color)
,
ColorUtils.toJavaColor(int)
public FormulaField getForeColorFormula()
FormulaField
The formula fore color of this element.ColorUtils.toCcColor(java.awt.Color)
,
ColorUtils.toJavaColor(int)
public int getBottomLineStyle()
BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setBottomLineStyle(int newValue)
newValue
- The new value of the property 'bottom line style'.java.lang.IllegalArgumentException
- if newValue is no valid line styleBorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public FormulaField getBottomLineStyleFormula()
BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setBottomLineStyleFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'bottom line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public int getTopLineStyle()
BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setTopLineStyle(int newValue)
newValue
- The new value of the property 'top line style'.java.lang.IllegalArgumentException
- if newValue is no valid line styleBorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public FormulaField getTopLineStyleFormula()
FormulaField
The formula of the property 'top line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setTopLineStyleFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'top line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setLeftLineStyle(int newValue)
newValue
- The new value of the property 'left line style'java.lang.IllegalArgumentException
- if newValue is no valid line styleBorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public int getLeftLineStyle()
BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setLeftLineStyleFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'left line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public FormulaField getLeftLineStyleFormula()
FormulaField
The formula for the property 'left line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setRightLineStyle(int newValue)
newValue
- The new value of the property 'right line style'.java.lang.IllegalArgumentException
- if newValue is no valid line styleBorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public int getRightLineStyle()
BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setRightLineStyleFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'right line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public FormulaField getRightLineStyleFormula()
FormulaField
The formula for the property 'right line style'.BorderProperties.NO_LINE
,
BorderProperties.LINE_STYLE_SINGLE
,
BorderProperties.LINE_STYLE_DOUBLE
,
BorderProperties.LINE_STYLE_DASHED
,
BorderProperties.LINE_STYLE_DOTTED
public void setTightHorizontal(boolean newValue)
newValue
- true
if the value should be set, else false
.public void setTightHorizontalFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'tight horizontal'.public boolean isTightHorizontal()
false
.public FormulaField getTightHorizontalFormula()
FormulaField
The formula for the property 'tight horizontal'.public FormulaField getHyperlinkUrlFormula()
FormulaField
The formula of the property 'hyperlink url'.public void setHyperlinkUrlFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'hyperlink url'.public void setHyperlinkUrl(java.lang.String url)
url
- A string which starts with one of the following protocol types (followed by the target):public java.lang.String getHyperlinkUrl()
public void setSuppressIfDuplicated(boolean newValue)
setSuppressIfDuplicated
in interface GeneralProperties
newValue
- The new value of the property 'suppress if duplicated'.public boolean isSuppressIfDuplicated()
isSuppressIfDuplicated
in interface GeneralProperties
public void setSuppressIfDuplicatedFormula(FormulaField newFormula)
setSuppressIfDuplicatedFormula
in interface GeneralProperties
newFormula
- The new formula for the property 'suppress if duplicated'.public FormulaField getSuppressIfDuplicatedFormula()
getSuppressIfDuplicatedFormula
in interface GeneralProperties
public final int getCanGrowCount()
getCanGrowCount
in interface GeneralProperties
public void setCanGrowCount(int newValue)
setCanGrowCount
in interface GeneralProperties
newValue
- The new value of the property 'can grow count'.java.lang.IllegalArgumentException
- when newValue < 0public FormulaField getHorAlignFormula()
getHorAlignFormula
in interface GeneralProperties
public void setHorAlignFormula(FormulaField newFormula)
setHorAlignFormula
in interface GeneralProperties
newFormula
- The new formula for the property 'horizontal alignment'.
The result of the formula should be in range from 0 to 4.GeneralProperties.ALIGN_HORIZONTAL_DEFAULT
,
GeneralProperties.ALIGN_HORIZONTAL_LEFT
,
GeneralProperties.ALIGN_HORIZONTAL_CENTER
,
GeneralProperties.ALIGN_HORIZONTAL_RIGHT
,
GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
public void setHorAlign(int value)
setHorAlign
in interface GeneralProperties
value
- The new value of the property 'horizontal alignment'.java.lang.IllegalArgumentException
- If the value given is not one of the provided constantsGeneralProperties.ALIGN_HORIZONTAL_DEFAULT
,
GeneralProperties.ALIGN_HORIZONTAL_LEFT
,
GeneralProperties.ALIGN_HORIZONTAL_CENTER
,
GeneralProperties.ALIGN_HORIZONTAL_RIGHT
,
GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
public int getHorAlign()
getHorAlign
in interface GeneralProperties
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT
,
GeneralProperties.ALIGN_HORIZONTAL_LEFT
,
GeneralProperties.ALIGN_HORIZONTAL_CENTER
,
GeneralProperties.ALIGN_HORIZONTAL_RIGHT
,
GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
public boolean isCanGrow()
isCanGrow
in interface GeneralProperties
public void setCanGrow(boolean canGrow)
setCanGrow
in interface GeneralProperties
canGrow
- The new value of the property 'can grow'public FormulaField getCanGrowFormula()
getCanGrowFormula
in interface GeneralProperties
public void setCanGrowFormula(FormulaField newFormula)
setCanGrowFormula
in interface GeneralProperties
newFormula
- The new formula for the property 'can grow'.public void setCloseBorderOnPageBreak(boolean newValue)
newValue
- The new value of the property 'close border on page break'.public boolean isCloseBorderOnPageBreak()
public void setCloseBorderOnPageBreakFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'close border on page break'.public FormulaField getCloseBorderOnPageBreakFormula()
public void setDropShadow(boolean newValue)
newValue
- true
- shadow will be displayed, false
- no shadow.public boolean isDropShadow()
false
.public void setDropShadowFormula(FormulaField newFormula)
newFormula
- The new formula for the property 'drop shadow'.public FormulaField getDropShadowFormula()
public java.lang.String getToolTipsText()
getToolTipsText
in interface GeneralProperties
public void setToolTipsText(java.lang.String newValue)
setToolTipsText
in interface GeneralProperties
newValue
- The new value of the property 'tool tips text'.public FormulaField getToolTipsTextFormula()
getToolTipsTextFormula
in interface GeneralProperties
public void setToolTipsTextFormula(FormulaField newFormula)
setToolTipsTextFormula
in interface GeneralProperties
newFormula
- The new formula for the property 'tool tips text'.public void addListener(com.inet.report.RDC.ElementRemoveListener erl)
erl
- An object which implements the CoderXML.ElementRemoveListener
and should handle the call-back for this element.public void removeListener(com.inet.report.RDC.ElementRemoveListener erl)
erl
- An object which implements the CoderXML.ElementRemoveListener interface
and should handle the call-back for this element.public java.util.List<FormulaField> getPropertyFormulas()
ReportComponent
of this one. To get the property formulas for descendant ReportComponent
use ReportComponent.getSubComponents()
getPropertyFormulas
in class ReportComponent
Copyright © 1999-2018 by i-net software GmbH