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,java.io.Serializable,java.lang.Cloneable
- Direct Known Subclasses:
AbstractFontElement,AbstractLineElement,AbstractPictureElement,Chart2,CrossTab,Paragraph,SignatureForm,Text
public abstract class Element extends ReportComponent implements GeneralProperties, java.lang.Cloneable
The classElementis 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 methodSection.getElements()in classSection. 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 classElement, each of them is an instance of the subclasses ofElement.- Since:
- 1.0
- See Also:
Section.getElements(),Section.getElementsV(), Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classElement.BorderPropsFOR INTERNAL USE ONLYstatic classElement.CommonPropertiesFOR INTERNAL USE ONLYstatic classElement.ElementTypesFOR INTERNAL USE ONLYprotected static classElement.HyperlinkPropsFOR INTERNAL USE ONLYprotected static classElement.StringPropsFOR INTERNAL USE ONLY
-
Field Summary
Fields Modifier and Type Field Description static intBOXElement is an instance of Box.static intCHARTElement is an instance of Chart.static intCROSSTABElement is an instance of CrossTab.static intCROSSTABSECTIONElement is an instance of CrossTabDescriptionSection.static intDATABASE_PICTUREElement is an instance of DatabasePicture.static intFIELDElement is an instance of Field.static intFIELDPARTElement is an instance of FieldPart.static intFORMFIELDElement is an instance of FormFieldElement.static intINTERACTIVE_SORTINGElement is an instance of InteractiveSortingstatic intJAVABEANElement is an instance of JavaBean.static intLINEElement is an instance of Line.static intPARAGRAPHElement is an instance of Paragraph.static intPICTUREElement is an instance of Picture.static intSIGNATUREElement is an instance of SignatureForm.static intSUBREPORTElement is an instance of Subreport.static intTEXTElement is an instance of Text.static intTEXTPARTElement 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
Constructors Modifier Constructor Description protectedElement(int type, com.inet.report.RendererBase renderer)Constructor of Element with necessary dependencies, calls the full constructor with parentSection=null
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddListener(RDC.ElementRemoveListener erl)Adds a listener.java.lang.Objectcopy()Creates a serializable copy of this Element.intgetBottomLineStyle()Returns the value of the property 'bottom line style'.FormulaFieldgetBottomLineStyleFormula()Returns the formula of the property 'bottom line style'.com.inet.lib.list.IntStackgetBulletValueStack()FOR INTERNAL USE ONLYintgetCanGrowCount()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.FormulaFieldgetCanGrowFormula()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.FormulaFieldgetCloseBorderOnPageBreakFormula()Returns the formula for the property 'close border on page break'.FormulaFieldgetDropShadowFormula()Returns the formula for the property 'drop shadow'.EnginegetEngine()Returns the Engine this Element is associated with.FieldgetField()Returns the field definition element (for example, database field element, prompt field element).intgetForeColor()Returns the fore color of the element.FormulaFieldgetForeColorFormula()Returns the formula fore color of the element.intgetHorAlign()Returns the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.FormulaFieldgetHorAlignFormula()Returns the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.java.lang.StringgetHyperlinkUrl()Returns the target url of the hyperlink which is associated with this element.FormulaFieldgetHyperlinkUrlFormula()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.intgetLeftLineStyle()Returns the value of the property 'left line style'.FormulaFieldgetLeftLineStyleFormula()Returns the formula for the property 'left line style'.com.inet.lib.list.IntStackgetListStack()FOR INTERNAL USE ONLYjava.lang.ObjectgetParent()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.intgetRightLineStyle()Returns the value of the property 'right line style'.FormulaFieldgetRightLineStyleFormula()Returns the formula for the property 'right line style'.FormulaFieldgetSuppressIfDuplicatedFormula()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.FormulaFieldgetTightHorizontalFormula()Returns the formula for the property 'tight horizontal'.java.lang.StringgetToolTipsText()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.FormulaFieldgetToolTipsTextFormula()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.intgetTopLineStyle()Returns the value of the property 'top line style'.FormulaFieldgetTopLineStyleFormula()Returns the formula of the property 'top line style'.java.lang.StringgetTypeAsString()FOR INTERNAL USE ONLYintindexOf()Returns the current index of this element in section (z-order).booleanisCanGrow()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.booleanisCloseBorderOnPageBreak()Returns the value of the property 'close border on page break'.protected booleanisCloseBorderOnPageBreakInternal()FOR INTERNAL USE ONLYbooleanisDropShadow()Returns the value of the property 'drop shadow'.booleanisInCrossTab()FOR INTERNAL USE ONLYbooleanisSuppressIfDuplicated()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.booleanisTightHorizontal()Returns the value of the property 'tight horizontal'.java.lang.StringparamString()Creates and return a String representation for debugging.NodeParserparseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,java.lang.Object> parserMap)FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidparseText(java.lang.String textData, java.util.Map<java.lang.String,java.lang.Object> parserMap)FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidremoveListener(RDC.ElementRemoveListener erl)Removes a previously added listener.voidsetBottomLineStyle(int newValue)Sets the value of the property 'bottom line style'.voidsetBottomLineStyleFormula(FormulaField newFormula)Sets the formula for the property 'bottom line style'.voidsetBulletValueStack(com.inet.lib.list.IntStack bulletValueStack)FOR INTERNAL USE ONLYvoidsetCanGrow(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.voidsetCanGrowCount(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.voidsetCanGrowFormula(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.voidsetCloseBorderOnPageBreak(boolean newValue)Sets the value of the property 'close border on page break'.voidsetCloseBorderOnPageBreakFormula(FormulaField newFormula)Sets the formula for the property 'close border on page break'.voidsetDropShadow(boolean newValue)Sets the value of the property 'drop shadow'.voidsetDropShadowFormula(FormulaField newFormula)Sets the formula for the property 'drop shadow'.voidsetField(Field newField)Sets the field definition element (for example, DatabaseField element, prompt field element).voidsetForeColor(int newValue)Sets the value of the property 'fore color'.voidsetForeColorFormula(FormulaField newFormula)Sets the formula fore color of the element.voidsetHorAlign(int value)Sets the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.voidsetHorAlignFormula(FormulaField newFormula)Sets the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.voidsetHyperlinkUrl(java.lang.String url)Sets the target location of a hyperlink which is assoziated with this element.
This modify also the hyperlink type.voidsetHyperlinkUrlFormula(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.voidsetIndex(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).voidsetLeftLineStyle(int newValue)Sets the value of the property 'left line style'.voidsetLeftLineStyleFormula(FormulaField newFormula)Sets the formula for the property 'left line style'.voidsetListStack(com.inet.lib.list.IntStack listStack)FOR INTERNAL USE ONLYvoidsetReferences()FOR INTERNAL USE ONLYvoidsetRightLineStyle(int newValue)Sets the value of the property 'right line style'.voidsetRightLineStyleFormula(FormulaField newFormula)Sets the formula for the property 'right line style'.voidsetSuppressIfDuplicated(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.voidsetSuppressIfDuplicatedFormula(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.voidsetTightHorizontal(boolean newValue)Sets the value of the property 'tight horizontal'.voidsetTightHorizontalFormula(FormulaField newFormula)Sets the formula for the property 'tight horizontal'.voidsetToolTipsText(java.lang.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.voidsetToolTipsTextFormula(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.voidsetTopLineStyle(int newValue)Sets the value of the property 'top line style'.voidsetTopLineStyleFormula(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 Detail
-
TEXT
public static final int TEXT
Element is an instance of Text.- See Also:
Text, Constant Field Values
-
FIELD
public static final int FIELD
Element is an instance of Field.- See Also:
FieldElement, Constant Field Values
-
LINE
public static final int LINE
Element is an instance of Line.- See Also:
Line, Constant Field Values
-
BOX
public static final int BOX
Element is an instance of Box.- See Also:
Box, Constant Field Values
-
CHART
public static final int CHART
Element is an instance of Chart.- See Also:
Chart2, Constant Field Values
-
PICTURE
public static final int PICTURE
Element is an instance of Picture.- See Also:
Picture, Constant Field Values
-
SUBREPORT
public static final int SUBREPORT
Element is an instance of Subreport.- See Also:
Subreport, Constant Field Values
-
DATABASE_PICTURE
public static final int DATABASE_PICTURE
Element is an instance of DatabasePicture.- See Also:
DatabasePicture, Constant Field Values
-
CROSSTAB
public static final int CROSSTAB
Element is an instance of CrossTab.- See Also:
CrossTab, Constant Field Values
-
CROSSTABSECTION
public static final int CROSSTABSECTION
Element is an instance of CrossTabDescriptionSection.- See Also:
CrossTabDescriptionSection, Constant Field Values
-
PARAGRAPH
public static final int PARAGRAPH
Element is an instance of Paragraph.- See Also:
Paragraph, Constant Field Values
-
TEXTPART
public static final int TEXTPART
Element is an instance of TextPart.- See Also:
TextPart, Constant Field Values
-
FIELDPART
public static final int FIELDPART
Element is an instance of FieldPart.- See Also:
FieldPart, Constant Field Values
-
JAVABEAN
public static final int JAVABEAN
Element is an instance of JavaBean.- See Also:
JavaBean, Constant Field Values
-
SIGNATURE
public static final int SIGNATURE
Element is an instance of SignatureForm.- See Also:
SignatureForm, Constant Field Values
-
FORMFIELD
public static final int FORMFIELD
Element is an instance of FormFieldElement.- See Also:
FormFieldElement, Constant Field Values
-
INTERACTIVE_SORTING
public static final int INTERACTIVE_SORTING
Element is an instance of InteractiveSorting- See Also:
InteractiveSorting, Constant Field Values
-
-
Constructor Detail
-
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 Detail
-
copy
public java.lang.Object copy() throws ReportExceptionCreates 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:
Section.pasteElement(java.lang.Object)
-
paramString
public java.lang.String paramString()
Creates and return a String representation for debugging.- Overrides:
paramStringin classReportComponent- Returns:
- String representation of this Element for debugging purposes
- Since:
- 4.0
-
getField
public Field getField()
Returns the field definition element (for example, database field element, prompt field element).- Returns:
FieldThe current value of the 'field' property.- Since:
- 3.0
-
setField
public void setField(Field newField)
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
public java.lang.Object getParent()
Returns the parent element in object hierarchie (here: Section or null).- Returns:
- The parent element in object hierarchie.
- Since:
- 3.0
-
getEngine
public Engine 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-1is returned.- Specified by:
indexOfin classReportComponent- Returns:
- The index (z-order) of this Element in the parent section or
-1if the Element was not found in the parent section. - Since:
- 3.0
- See Also:
setIndex(int)
-
setIndex
public void setIndex(int zPos) throws ReportExceptionChanges 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:
indexOf()
-
getTypeAsString
public java.lang.String 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
public void setForeColorFormula(FormulaField newFormula)
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
public FormulaField 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:
FormulaFieldThe 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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
java.lang.IllegalArgumentException- if newValue is no valid line style- Since:
- 3.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
getBottomLineStyleFormula
public FormulaField 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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
setBottomLineStyleFormula
public void setBottomLineStyleFormula(FormulaField newFormula)
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
java.lang.IllegalArgumentException- if newValue is no valid line style- Since:
- 3.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
getTopLineStyleFormula
public FormulaField 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:
FormulaFieldThe formula of the property 'top line style'.- Since:
- 6.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
setTopLineStyleFormula
public void setTopLineStyleFormula(FormulaField newFormula)
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
java.lang.IllegalArgumentException- if newValue is no valid line style- Since:
- 3.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
setLeftLineStyleFormula
public void setLeftLineStyleFormula(FormulaField newFormula)
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
getLeftLineStyleFormula
public FormulaField 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:
FormulaFieldThe formula for the property 'left line style'.- Since:
- 3.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
java.lang.IllegalArgumentException- if newValue is no valid line style- Since:
- 3.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
setRightLineStyleFormula
public void setRightLineStyleFormula(FormulaField newFormula)
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:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
getRightLineStyleFormula
public FormulaField 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:
FormulaFieldThe formula for the property 'right line style'.- Since:
- 3.0
- See Also:
BorderProperties.NO_LINE,BorderProperties.LINE_STYLE_SINGLE,BorderProperties.LINE_STYLE_DOUBLE,BorderProperties.LINE_STYLE_DASHED,BorderProperties.LINE_STYLE_DOTTED
-
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-trueif the value should be set, elsefalse.- Since:
- 3.0
-
setTightHorizontalFormula
public void setTightHorizontalFormula(FormulaField newFormula)
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
public FormulaField 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:
FormulaFieldThe formula for the property 'tight horizontal'.- Since:
- 3.0
-
getHyperlinkUrlFormula
public FormulaField 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:
FormulaFieldThe formula of the property 'hyperlink url'.- Since:
- 4.0
-
setHyperlinkUrlFormula
public 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. 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
public void setHyperlinkUrl(java.lang.String url)
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
public java.lang.String 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:
setSuppressIfDuplicatedin 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:
isSuppressIfDuplicatedin interfaceGeneralProperties- Returns:
- The value of the property 'suppress if duplicated'.
-
setSuppressIfDuplicatedFormula
public 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.- Specified by:
setSuppressIfDuplicatedFormulain interfaceGeneralProperties- Parameters:
newFormula- The new formula for the property 'suppress if duplicated'.
-
getSuppressIfDuplicatedFormula
public FormulaField 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:
getSuppressIfDuplicatedFormulain 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:
getCanGrowCountin 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:
setCanGrowCountin interfaceGeneralProperties- Parameters:
newValue- The new value of the property 'can grow count'.- Throws:
java.lang.IllegalArgumentException- when newValue < 0
-
getHorAlignFormula
public FormulaField getHorAlignFormula()
Returns the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
getHorAlignFormulain interfaceGeneralProperties- Returns:
- FormulaField The formula for the property 'horizontal alignment'.
-
setHorAlignFormula
public void setHorAlignFormula(FormulaField newFormula)
Sets the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
setHorAlignFormulain 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:
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT,GeneralProperties.ALIGN_HORIZONTAL_LEFT,GeneralProperties.ALIGN_HORIZONTAL_CENTER,GeneralProperties.ALIGN_HORIZONTAL_RIGHT,GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
-
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:
setHorAlignin interfaceGeneralProperties- Parameters:
value- The new value of the property 'horizontal alignment'.- Throws:
java.lang.IllegalArgumentException- If the value given is not one of the provided constants- See Also:
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT,GeneralProperties.ALIGN_HORIZONTAL_LEFT,GeneralProperties.ALIGN_HORIZONTAL_CENTER,GeneralProperties.ALIGN_HORIZONTAL_RIGHT,GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
-
getHorAlign
public int getHorAlign()
Returns the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.- Specified by:
getHorAlignin interfaceGeneralProperties- Returns:
- Possible return values are default, left, center, right or justified.
- See Also:
GeneralProperties.ALIGN_HORIZONTAL_DEFAULT,GeneralProperties.ALIGN_HORIZONTAL_LEFT,GeneralProperties.ALIGN_HORIZONTAL_CENTER,GeneralProperties.ALIGN_HORIZONTAL_RIGHT,GeneralProperties.ALIGN_HORIZONTAL_JUSTIFIED
-
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:
isCanGrowin 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:
setCanGrowin interfaceGeneralProperties- Parameters:
canGrow- The new value of the property 'can grow'
-
getCanGrowFormula
public FormulaField 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:
getCanGrowFormulain interfaceGeneralProperties- Returns:
- FormulaField The formula of the property 'can grow'.
-
setCanGrowFormula
public 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. If this property is disabled the content will be truncated when its size is larger than the container.- Specified by:
setCanGrowFormulain 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
public void setCloseBorderOnPageBreakFormula(FormulaField newFormula)
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
public FormulaField 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
public void setDropShadowFormula(FormulaField newFormula)
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
public FormulaField 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
public java.lang.String 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:
getToolTipsTextin interfaceGeneralProperties- Returns:
- The value of the property 'tool tips text'.
-
setToolTipsText
public void setToolTipsText(java.lang.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. Use it for little notes.- Specified by:
setToolTipsTextin interfaceGeneralProperties- Parameters:
newValue- The new value of the property 'tool tips text'.
-
getToolTipsTextFormula
public FormulaField 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:
getToolTipsTextFormulain interfaceGeneralProperties- Returns:
- FormulaField The formula of the property 'tool tips text'.
-
setToolTipsTextFormula
public 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. Use it for little notes.- Specified by:
setToolTipsTextFormulain interfaceGeneralProperties- Parameters:
newFormula- The new formula for the property 'tool tips text'.
-
addListener
public void addListener(RDC.ElementRemoveListener erl)
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
public void removeListener(RDC.ElementRemoveListener erl)
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:
setReferencesin interfacecom.inet.report.ReferenceHolder- Overrides:
setReferencesin classReportComponent
-
getPropertyFormulas
public java.util.List<FormulaField> 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 descendantReportComponentof this one. To get the property formulas for descendantReportComponentuseReportComponent.getSubComponents()- Overrides:
getPropertyFormulasin 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, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,java.lang.Object> parserMap) throws FatalParserException
FOR 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:
parseElementin interfaceNodeParser- Overrides:
parseElementin 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
public void parseText(java.lang.String textData, java.util.Map<java.lang.String,java.lang.Object> parserMap)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:
parseTextin interfaceNodeParser- Overrides:
parseTextin classReportComponent- Parameters:
textData- text encountered and to be storedparserMap- The map of current Parser.
-
-