Package com.inet.report
Class Element
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
- All Implemented Interfaces:
GeneralProperties
,NodeParser
,com.inet.report.ReferenceHolder
,Serializable
,Cloneable
- Direct Known Subclasses:
AbstractFontElement
,AbstractLineElement
,AbstractPictureElement
,Chart2
,CrossTab
,Paragraph
,SignatureForm
,Text
The class
Each of them is inheriting from this class. It holds the properties that all objects have in common, like position, size, color. The elements used in the report are saved in particular sections; you can get them with method
Element
is the superclass of all visible objects in
the report.Each of them is inheriting from this class. It holds the properties that all objects have in common, like position, size, color. The elements used in the report are saved in particular sections; you can get them with method
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
.- Since:
- 1.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static enum
FOR INTERNAL USE ONLYstatic enum
FOR INTERNAL USE ONLYstatic enum
FOR INTERNAL USE ONLYprotected static enum
FOR INTERNAL USE ONLYprotected static enum
FOR INTERNAL USE ONLY -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Element is an instance of Box.static final int
Element is an instance of Chart.static final int
Element is an instance of CrossTab.static final int
Element is an instance of CrossTabDescriptionSection.static final int
Element is an instance of DatabasePicture.static final int
Element is an instance of Field.static final int
Element is an instance of FieldPart.static final int
Element is an instance of FormFieldElement.static final int
Element is an instance of InteractiveSortingstatic final int
Element is an instance of JavaBean.static final int
Element is an instance of Line.static final int
Element is an instance of Paragraph.static final int
Element is an instance of Picture.static final int
Element is an instance of SignatureForm.static final int
Element is an instance of Subreport.static final int
Element is an instance of Text.static final int
Element is an instance of TextPart.Fields inherited from interface com.inet.report.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
-
Constructor Summary
ModifierConstructorDescriptionprotected
Element
(int type, com.inet.report.RendererBase renderer) Constructor of Element with necessary dependencies, calls the full constructor with parentSection=null -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener.copy()
Creates a serializable copy of this Element.int
Returns the value of the property 'bottom line style'.Returns the formula of the property 'bottom line style'.final com.inet.lib.list.IntStack
FOR INTERNAL USE ONLYfinal int
Returns the value of the property 'can grow count'.
This property gives the maximum numbers of lines that a Text or a FieldElement can grow.Returns the formula of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container.Returns the formula for the property 'close border on page break'.Returns the formula for the property 'drop shadow'.Returns the Engine this Element is associated with.getField()
Returns the field definition element (for example, database field element, prompt field element).int
Returns the fore color of the element.Returns the formula fore color of the element.int
Returns the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.Returns the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.Returns the target url of the hyperlink which is associated with this element.Returns the formula of the property 'hyperlink url'.
Use this property to specify an url of a web site, an e-mail address or the url of a html-file.int
Returns the value of the property 'left line style'.Returns the formula for the property 'left line style'.final com.inet.lib.list.IntStack
FOR INTERNAL USE ONLYReturns the parent element in object hierarchie (here: Section or null).Returns a list with all property formulas that are set for this report element.int
Returns the value of the property 'right line style'.Returns the formula for the property 'right line style'.Returns the formula for the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.Returns the formula for the property 'tight horizontal'.Returns the value of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element.Returns the formula of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element.int
Returns the value of the property 'top line style'.Returns the formula of the property 'top line style'.FOR INTERNAL USE ONLYint
indexOf()
Returns the current index of this element in section (z-order).boolean
Returns the value of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container.boolean
Returns the value of the property 'close border on page break'.protected boolean
FOR INTERNAL USE ONLYboolean
Returns the value of the property 'drop shadow'.boolean
FOR INTERNAL USE ONLYboolean
Returns the value of the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.boolean
Returns the value of the property 'tight horizontal'.Creates and return a String representation for debugging.parseElement
(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
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'.final void
setBulletValueStack
(com.inet.lib.list.IntStack bulletValueStack) FOR INTERNAL USE ONLYvoid
setCanGrow
(boolean canGrow) Sets the value of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container.void
setCanGrowCount
(int newValue) Sets the value of the property 'can grow count'.
This property gives the maximum numbers of lines that a Text or a FieldElement can grow.void
setCanGrowFormula
(FormulaField newFormula) Sets the formula for the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container.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
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'.
Possible alignments are default, left, center, right or justified.void
setHorAlignFormula
(FormulaField newFormula) Sets the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.void
setHyperlinkUrl
(String url) Sets the target location of a hyperlink which is assoziated with this element.
This modify also the hyperlink type.void
setHyperlinkUrlFormula
(FormulaField newFormula) Sets the formula for the property 'hyperlink url'.
Use this property to specify an url of a web site, an e-mail address or the url of a html-file.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'.final void
setListStack
(com.inet.lib.list.IntStack listStack) FOR INTERNAL USE ONLYvoid
FOR INTERNAL USE ONLYvoid
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'.
If this property is enabled values of the field that are duplicated will not be printed.void
setSuppressIfDuplicatedFormula
(FormulaField newFormula) Sets the formula for the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.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
(String newValue) Sets the value of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element.void
setToolTipsTextFormula
(FormulaField newFormula) Sets the formula for the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element.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'.Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
-
Field Details
-
TEXT
public static final int TEXTElement is an instance of Text.- See Also:
-
FIELD
public static final int FIELDElement is an instance of Field.- See Also:
-
LINE
public static final int LINEElement is an instance of Line.- See Also:
-
BOX
public static final int BOXElement is an instance of Box.- See Also:
-
CHART
public static final int CHARTElement is an instance of Chart.- See Also:
-
PICTURE
public static final int PICTUREElement is an instance of Picture.- See Also:
-
SUBREPORT
public static final int SUBREPORTElement is an instance of Subreport.- See Also:
-
DATABASE_PICTURE
public static final int DATABASE_PICTUREElement is an instance of DatabasePicture.- See Also:
-
CROSSTAB
public static final int CROSSTABElement is an instance of CrossTab.- See Also:
-
CROSSTABSECTION
public static final int CROSSTABSECTIONElement is an instance of CrossTabDescriptionSection. -
PARAGRAPH
public static final int PARAGRAPHElement is an instance of Paragraph.- See Also:
-
TEXTPART
public static final int TEXTPARTElement is an instance of TextPart.- See Also:
-
FIELDPART
public static final int FIELDPARTElement is an instance of FieldPart.- See Also:
-
JAVABEAN
public static final int JAVABEANElement is an instance of JavaBean.- See Also:
-
SIGNATURE
public static final int SIGNATUREElement is an instance of SignatureForm.- See Also:
-
FORMFIELD
public static final int FORMFIELDElement is an instance of FormFieldElement.- See Also:
-
FormFieldElement
- Constant Field Values
-
INTERACTIVE_SORTING
public static final int INTERACTIVE_SORTINGElement is an instance of InteractiveSorting- See Also:
-
InteractiveSorting
- Constant Field Values
-
-
Constructor Details
-
Element
protected Element(int type, com.inet.report.RendererBase renderer) Constructor of Element with necessary dependencies, calls the full constructor with parentSection=null- Parameters:
type
- type of element (valid valus defined in subclasses)renderer
- renderer responsible for this element- Since:
- 5.0
-
-
Method Details
-
copy
Creates a serializable copy of this Element. The returned Object is not an instance of Element. This method is used from i-net Designer for Copy and Paste.- Returns:
- A serializable Object.
- Throws:
ReportException
- If accessing properties of this Element causes any errors.- Since:
- 6.0
- See Also:
-
paramString
Creates and return a String representation for debugging.- Overrides:
paramString
in classReportComponent
- Returns:
- String representation of this Element for debugging purposes
- Since:
- 4.0
-
getField
Returns the field definition element (for example, database field element, prompt field element).- Returns:
Field
The current value of the 'field' property.- Since:
- 3.0
-
setField
Sets the field definition element (for example, DatabaseField element, prompt field element).- Parameters:
newField
- The new field element of the property 'field'.- Since:
- 3.0
-
getParent
Returns the parent element in object hierarchie (here: Section or null).- Returns:
- The parent element in object hierarchie.
- Since:
- 3.0
-
getEngine
Returns the Engine this Element is associated with.- Returns:
- The Engine responsible for this Element
- Since:
- 6.0
-
indexOf
public int indexOf()Returns the current index of this element in section (z-order). If this Element is not found in the parent section-1
is returned.- Specified by:
indexOf
in classReportComponent
- Returns:
- The index (z-order) of this Element in the parent section or
-1
if the Element was not found in the parent section. - Since:
- 3.0
- See Also:
-
setIndex
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).- Parameters:
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.- Throws:
ReportException
- Thrown if this element was not found in parent section- Since:
- 3.0
- See Also:
-
getTypeAsString
FOR INTERNAL USE ONLY- Since:
- 6.1
-
setForeColor
public void setForeColor(int newValue) Sets the value of the property 'fore color'. This property sets the fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.- Parameters:
newValue
- the new Value for the property 'fore color'.- Since:
- 3.0
- See Also:
-
ColorUtils.toCcColor(java.awt.Color)
ColorUtils.toJavaColor(int)
-
getForeColor
public int getForeColor()Returns the fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.- Returns:
- The 'fore color' value of the element.
- Since:
- 3.0
- See Also:
-
ColorUtils.toCcColor(java.awt.Color)
ColorUtils.toJavaColor(int)
-
setForeColorFormula
Sets the formula fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.- Parameters:
newFormula
- The new formula fore color of this element.- Since:
- 3.0
- See Also:
-
ColorUtils.toCcColor(java.awt.Color)
ColorUtils.toJavaColor(int)
-
getForeColorFormula
Returns the formula fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.- Returns:
FormulaField
The formula fore color of this element.- Since:
- 3.0
- See Also:
-
ColorUtils.toCcColor(java.awt.Color)
ColorUtils.toJavaColor(int)
-
getBottomLineStyle
public int getBottomLineStyle()Returns the value of the property 'bottom line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the bottom of the element with the defined style.- Returns:
- The value of the property 'bottom line style'.
- Since:
- 3.0
- See Also:
-
setBottomLineStyle
public void setBottomLineStyle(int newValue) Sets the value of the property 'bottom line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the bottom of the element with the defined style.- Parameters:
newValue
- The new value of the property 'bottom line style'.- Throws:
IllegalArgumentException
- if newValue is no valid line style- Since:
- 3.0
- See Also:
-
getBottomLineStyleFormula
Returns the formula of the property 'bottom line style'. Returns the formula that results in one of the following line styles: single line, double line, dashed line, dotted line or no line. If it results in any of the first four a line will be drawn on the bottom of the element with the defined style.- Returns:
- FormulaField The formula of the property 'bottom line style'.
- Since:
- 3.0
- See Also:
-
setBottomLineStyleFormula
Sets the formula for the property 'bottom line style'. Give a formula that results in one of the following line styles: single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the bottom of the element with the defined style.- Parameters:
newFormula
- The new formula for the property 'bottom line style'.- Since:
- 3.0
- See Also:
-
getTopLineStyle
public int getTopLineStyle()Returns the value of the property 'top line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the top of the element with the defined style.- Returns:
- The value of the property 'top line style'.
- Since:
- 3.0
- See Also:
-
setTopLineStyle
public void setTopLineStyle(int newValue) Sets the value of the property 'top line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the top of the element with the defined style.- Parameters:
newValue
- The new value of the property 'top line style'.- Throws:
IllegalArgumentException
- if newValue is no valid line style- Since:
- 3.0
- See Also:
-
getTopLineStyleFormula
Returns the formula of the property 'top line style'. Returns the formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the top of the element with the defined style.- Returns:
FormulaField
The formula of the property 'top line style'.- Since:
- 6.0
- See Also:
-
setTopLineStyleFormula
Sets the formula for the property 'top line style'. Give a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the top of the element with the defined style.- Parameters:
newFormula
- The new formula for the property 'top line style'.- Since:
- 3.0
- See Also:
-
setLeftLineStyle
public void setLeftLineStyle(int newValue) Sets the value of the property 'left line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the left side of the element with the defined style.- Parameters:
newValue
- The new value of the property 'left line style'- Throws:
IllegalArgumentException
- if newValue is no valid line style- Since:
- 3.0
- See Also:
-
getLeftLineStyle
public int getLeftLineStyle()Returns the value of the property 'left line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the left side of the element with the defined style.- Returns:
- The value of the property 'left line style'.
- Since:
- 3.0
- See Also:
-
setLeftLineStyleFormula
Sets the formula for the property 'left line style'. Give a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the left side of the element with the defined style.- Parameters:
newFormula
- The new formula for the property 'left line style'.- Since:
- 3.0
- See Also:
-
getLeftLineStyleFormula
Returns the formula for the property 'left line style'. Returns a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the left side of the element with the defined style.- Returns:
FormulaField
The formula for the property 'left line style'.- Since:
- 3.0
- See Also:
-
setRightLineStyle
public void setRightLineStyle(int newValue) Sets the value of the property 'right line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the right side of the element with the defined style.- Parameters:
newValue
- The new value of the property 'right line style'.- Throws:
IllegalArgumentException
- if newValue is no valid line style- Since:
- 3.0
- See Also:
-
getRightLineStyle
public int getRightLineStyle()Returns the value of the property 'right line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the right side of the element with the defined style.- Returns:
- The value of the property 'right line style'.
- Since:
- 3.0
- See Also:
-
setRightLineStyleFormula
Sets the formula for the property 'right line style'. Give a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the right side of the element with the defined style.- Parameters:
newFormula
- The new formula for the property 'right line style'.- Since:
- 3.0
- See Also:
-
getRightLineStyleFormula
Returns the formula for the property 'right line style'. Returns a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the right side of the element with the defined style.- Returns:
FormulaField
The formula for the property 'right line style'.- Since:
- 3.0
- See Also:
-
setTightHorizontal
public void setTightHorizontal(boolean newValue) Sets the value of the property 'tight horizontal'. If this property is enabled the border of the element will be trimed to the size of the field. When this property is disabled the size will be the same for each record.- Parameters:
newValue
-true
if the value should be set, elsefalse
.- Since:
- 3.0
-
setTightHorizontalFormula
Sets the formula for the property 'tight horizontal'. If this property is enabled the border of the element will be trimed to the size of the field. When this property is disabled the size will be the same for each record.- Parameters:
newFormula
- The new formula for the property 'tight horizontal'.- Since:
- 3.0
-
isTightHorizontal
public boolean isTightHorizontal()Returns the value of the property 'tight horizontal'. If this property is enabled the border of the element will be trimmed to the size of the field. When this property is disabled the size will be the same for each record.- Returns:
- true if the property is set, else
false
. - Since:
- 3.0
-
getTightHorizontalFormula
Returns the formula for the property 'tight horizontal'. If this property is enabled the border of the element will be trimed to the size of the field. When this property is disabled the size will be the same for each record.- Returns:
FormulaField
The formula for the property 'tight horizontal'.- Since:
- 3.0
-
getHyperlinkUrlFormula
Returns the formula of the property 'hyperlink url'.
Use this property to specify an url of a web site, an e-mail address or the url of a html-file. If formula is not empty a click on the element will open a webbrowser with the content of the web-site or the file, or an e-mail client will open.- Returns:
FormulaField
The formula of the property 'hyperlink url'.- Since:
- 4.0
-
setHyperlinkUrlFormula
Sets the formula for the property 'hyperlink url'.
Use this property to specify an url of a web site, an e-mail address or the url of a html-file. If formula is not empty a click on the element will open a webbrowser with the content of the web-site or the file, or an e-mail client will open.- Parameters:
newFormula
- The new formula for the property 'hyperlink url'.- Since:
- 4.0
-
setHyperlinkUrl
Sets the target location of a hyperlink which is assoziated with this element.
This modify also the hyperlink type.- Parameters:
url
- A string which starts with one of the following protocol types (followed by the target):
mailto:
file:///
http://
or an empty string.- Since:
- 4.0
-
getHyperlinkUrl
Returns the target url of the hyperlink which is associated with this element.- Returns:
- A string which starts with one of the following protocol types (followed by the target):
mailto:
file:///
http://
or an empty string. - Since:
- 4.0
-
setSuppressIfDuplicated
public void setSuppressIfDuplicated(boolean newValue) Sets the value of the property 'suppress if duplicated'.
If this property is enabled values of the field that are duplicated will not be printed.- Specified by:
setSuppressIfDuplicated
in interfaceGeneralProperties
- Parameters:
newValue
- The new value of the property 'suppress if duplicated'.
-
isSuppressIfDuplicated
public boolean isSuppressIfDuplicated()Returns the value of the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.- Specified by:
isSuppressIfDuplicated
in interfaceGeneralProperties
- Returns:
- The value of the property 'suppress if duplicated'.
-
setSuppressIfDuplicatedFormula
Sets the formula for the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.- Specified by:
setSuppressIfDuplicatedFormula
in interfaceGeneralProperties
- Parameters:
newFormula
- The new formula for the property 'suppress if duplicated'.
-
getSuppressIfDuplicatedFormula
Returns the formula for the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.- Specified by:
getSuppressIfDuplicatedFormula
in interfaceGeneralProperties
- Returns:
- FormulaField The formula for the property 'suppress if duplicated'.
-
getCanGrowCount
public final int getCanGrowCount()Returns the value of the property 'can grow count'.
This property gives the maximum numbers of lines that a Text or a FieldElement can grow. Give 0 if you do not want to set a limit.- Specified by:
getCanGrowCount
in interfaceGeneralProperties
- Returns:
- The current value of the property 'can grow count'.
-
setCanGrowCount
public void setCanGrowCount(int newValue) Sets the value of the property 'can grow count'.
This property gives the maximum numbers of lines that a Text or a FieldElement can grow. Give 0 if you do not want to set a limit.- Specified by:
setCanGrowCount
in interfaceGeneralProperties
- Parameters:
newValue
- The new value of the property 'can grow count'.- Throws:
IllegalArgumentException
- when newValue < 0
-
getHorAlignFormula
Returns the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
getHorAlignFormula
in interfaceGeneralProperties
- Returns:
- FormulaField The formula for the property 'horizontal alignment'.
-
setHorAlignFormula
Sets the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
setHorAlignFormula
in interfaceGeneralProperties
- Parameters:
newFormula
- The new formula for the property 'horizontal alignment'. The result of the formula should be in range from 0 to 4.- See Also:
-
setHorAlign
public void setHorAlign(int value) Sets the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
setHorAlign
in interfaceGeneralProperties
- Parameters:
value
- The new value of the property 'horizontal alignment'.- Throws:
IllegalArgumentException
- If the value given is not one of the provided constants- See Also:
-
getHorAlign
public int getHorAlign()Returns the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
getHorAlign
in interfaceGeneralProperties
- Returns:
- Possible return values are default, left, center, right or justified.
- See Also:
-
isCanGrow
public boolean isCanGrow()Returns the value of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.- Specified by:
isCanGrow
in interfaceGeneralProperties
- Returns:
- The value of the property 'can grow'.
-
setCanGrow
public void setCanGrow(boolean canGrow) Sets the value of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.- Specified by:
setCanGrow
in interfaceGeneralProperties
- Parameters:
canGrow
- The new value of the property 'can grow'
-
getCanGrowFormula
Returns the formula of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.- Specified by:
getCanGrowFormula
in interfaceGeneralProperties
- Returns:
- FormulaField The formula of the property 'can grow'.
-
setCanGrowFormula
Sets the formula for the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.- Specified by:
setCanGrowFormula
in interfaceGeneralProperties
- Parameters:
newFormula
- The new formula for the property 'can grow'.
-
setCloseBorderOnPageBreak
public void setCloseBorderOnPageBreak(boolean newValue) Sets the value of the property 'close border on page break'. If this property is enabled and if the element has a border and will break over two pages, then the border of both parts will be closed (on bottom of the first, on top of the second part). If not the borders of both parts will be partial (on bottom of the first, on top of the second part are no borders).- Parameters:
newValue
- The new value of the property 'close border on page break'.- Since:
- 10.0
-
isCloseBorderOnPageBreak
public boolean isCloseBorderOnPageBreak()Returns the value of the property 'close border on page break'. If this property is enabled and if the element has a border and will break over two pages, then the border of both parts will be closed (on bottom of the first, on top of the second part). If not the borders of both parts will be partial (on bottom of the first, on top of the second part are no borders).- Returns:
- FormulaField The value of the property 'close border on page break'.
- Since:
- 10.0
-
isCloseBorderOnPageBreakInternal
protected boolean isCloseBorderOnPageBreakInternal()FOR INTERNAL USE ONLY- Returns:
- The value of the property 'close border on page break'.
-
setCloseBorderOnPageBreakFormula
Sets the formula for the property 'close border on page break'. If this property is enabled and if the element has a border and will break over two pages, then the border of both parts will be closed (on bottom of the first, on top of the second part). If not the borders of both parts will be partial (on bottom of the first, on top of the second part are no borders).- Parameters:
newFormula
- The new formula for the property 'close border on page break'.- Since:
- 10.0
-
getCloseBorderOnPageBreakFormula
Returns the formula for the property 'close border on page break'. If this property is enabled and if the element has a border and will break over two pages, then the border of both parts will be closed (on bottom of the first, on top of the second part). If not the borders of both parts will be partial (on bottom of the first, on top of the second part are no borders).- Returns:
- FormulaField The formula for the property 'close border on page break'.
- Since:
- 10.0
-
setDropShadow
public void setDropShadow(boolean newValue) Sets the value of the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.- Parameters:
newValue
-true
- shadow will be displayed,false
- no shadow.- Since:
- 3.0
-
isDropShadow
public boolean isDropShadow()Returns the value of the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.- Returns:
- true if the shadow will be displayed else
false
. - Since:
- 3.0
-
setDropShadowFormula
Sets the formula for the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.- Parameters:
newFormula
- The new formula for the property 'drop shadow'.- Since:
- 3.0
-
getDropShadowFormula
Returns the formula for the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.- Returns:
- FormulaField The formula for the property 'drop shadow'.
- Since:
- 3.0
-
getToolTipsText
Returns the value of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.- Specified by:
getToolTipsText
in interfaceGeneralProperties
- Returns:
- The value of the property 'tool tips text'.
-
setToolTipsText
Sets the value of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.- Specified by:
setToolTipsText
in interfaceGeneralProperties
- Parameters:
newValue
- The new value of the property 'tool tips text'.
-
getToolTipsTextFormula
Returns the formula of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.- Specified by:
getToolTipsTextFormula
in interfaceGeneralProperties
- Returns:
- FormulaField The formula of the property 'tool tips text'.
-
setToolTipsTextFormula
Sets the formula for the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.- Specified by:
setToolTipsTextFormula
in interfaceGeneralProperties
- Parameters:
newFormula
- The new formula for the property 'tool tips text'.
-
addListener
Adds a listener. All added listeners will get an remove call if this element is removed from engine.- Parameters:
erl
- An object which implements the CoderXML.ElementRemoveListener and should handle the call-back for this element.- Since:
- 4.0
-
removeListener
Removes a previously added listener.- Parameters:
erl
- An object which implements the CoderXML.ElementRemoveListener interface and should handle the call-back for this element.- Since:
- 4.0
-
setReferences
public void setReferences()FOR INTERNAL USE ONLY- Specified by:
setReferences
in interfacecom.inet.report.ReferenceHolder
- Overrides:
setReferences
in classReportComponent
-
getPropertyFormulas
Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendantReportComponent
of this one. To get the property formulas for descendantReportComponent
useReportComponent.getSubComponents()
- Overrides:
getPropertyFormulas
in classReportComponent
- Returns:
- List of property formulas
- Since:
- 6.0
-
isInCrossTab
public boolean isInCrossTab()FOR INTERNAL USE ONLY- Since:
- 6.1
-
setListStack
public final void setListStack(com.inet.lib.list.IntStack listStack) FOR INTERNAL USE ONLY- Since:
- 6.1
-
setBulletValueStack
public final void setBulletValueStack(com.inet.lib.list.IntStack bulletValueStack) FOR INTERNAL USE ONLY- Since:
- 6.1
-
getBulletValueStack
public final com.inet.lib.list.IntStack getBulletValueStack()FOR INTERNAL USE ONLY- Since:
- 6.1
-
getListStack
public final com.inet.lib.list.IntStack getListStack()FOR INTERNAL USE ONLY- Since:
- 6.1
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.
- Specified by:
parseElement
in interfaceNodeParser
- Overrides:
parseElement
in classReportComponent
- Parameters:
group
- XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.tag
- The XMLTag to be parsedatts
- The set of attributes in the current XMLTagparserMap
- The map of current Parser.- Returns:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Throws:
FatalParserException
- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
parseText
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLThis method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)
- Specified by:
parseText
in interfaceNodeParser
- Overrides:
parseText
in classReportComponent
- Parameters:
textData
- text encountered and to be storedparserMap
- The map of current Parser.
-