Package com.inet.report
Class AbstractLineElement
java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
com.inet.report.AbstractLineElement
- All Implemented Interfaces:
BorderProperties
,GeneralProperties
,LineProperties
,NodeParser
,com.inet.report.ReferenceHolder
,Serializable
,Cloneable
public abstract class AbstractLineElement
extends Element
implements LineProperties, BorderProperties
This class is an abstract implementation of the interface LineProperties.
- Since:
- 6.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
FOR INTERNAL USE ONLYNested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
Field Summary
Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART
Fields inherited from interface com.inet.report.BorderProperties
LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE
Fields inherited from interface com.inet.report.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
-
Method Summary
Modifier and TypeMethodDescriptionfinal int
Return the same as getLineStyle()Returns the value of the property 'end section'.int
Returns the height of an element.final int
Return the same as getLineStyle()final int
Returns the value of the property 'line style', with one of the following line styles: single line, double line, dashed line, dotted line or no line.int
Returns the value of the property 'line width'.final int
Return the same as getLineStyle()final int
Return the same as getLineStyle()int
getWidth()
Returns the width of an element.int
getX2()
Returns the x position of the element in the end section, if the element does not end in the same section as it begins.int
getY2()
Returns the x position of the element in the end section, if the element does not end in the same section as it begins.boolean
Gets the value of the property 'extend to bottom of section when printing'.boolean
Returntrue
, if this element span over more than one sectionparseElement
(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
setEndSection
(Section newValue) Sets the value of the property 'end section'.final void
setExtendToBottomOfSectionWhenPrinting
(boolean newValue) Sets the value of the property 'extend to bottom of section when printing'.final void
setHeight
(int h) Sets the height of an element.void
setLineStyle
(int lineStyle) Sets the value of the property 'line style' with one of the different line styles single line, double line, dashed line, dotted line or no line.final void
setLineWidth
(int newValue) Sets the value of the property 'line width'.final void
setWidth
(int w) Sets the width of an element.void
setX2
(int x2) Sets the x position of the element in the end section, if the element does not end in the same section as it begins.void
setY2
(int y2) Sets the y position of the element in the end section, if the element does not end in the same section as it begins.final boolean
Methods inherited from class com.inet.report.Element
addListener, copy, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyleFormula, getListStack, getParent, getPropertyFormulas, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyleFormula, getTypeAsString, indexOf, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, paramString, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setReferences, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSubComponents, getSuppressFormula, getType, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, setBackColor, setBackColorFormula, setCustomData, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, 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.BorderProperties
getBackColor, getBackColorFormula, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyleFormula, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyleFormula, isCloseBorderOnPageBreak, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setTightHorizontal, setTightHorizontalFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
Methods inherited from interface com.inet.report.LineProperties
getForeColor, getSuppressFormula, getX, getY, isSuppress, setForeColor, setSuppress, setSuppressFormula, setX, setY
-
Method Details
-
setExtendToBottomOfSectionWhenPrinting
public final void setExtendToBottomOfSectionWhenPrinting(boolean newValue) Sets the value of the property 'extend to bottom of section when printing'. Use this property if you want to extend the line/box to the bottom of section.- Specified by:
setExtendToBottomOfSectionWhenPrinting
in interfaceLineProperties
- Parameters:
newValue
-true
if the property should be set, elsefalse
.- Since:
- 7.0
-
isExtendToBottomOfSectionWhenPrinting
public boolean isExtendToBottomOfSectionWhenPrinting()Gets the value of the property 'extend to bottom of section when printing'. If this property is true, the vertical line will extend up to the end of the section when printing.- Specified by:
isExtendToBottomOfSectionWhenPrinting
in interfaceLineProperties
- Returns:
true
if the line will be extended, otherwisefalse
.- Since:
- 7.0
-
setLineWidth
public final void setLineWidth(int newValue) Sets the value of the property 'line width'. With this property you can specify the width of the line of the line/box.- Specified by:
setLineWidth
in interfaceLineProperties
- Parameters:
newValue
- The new value of the property 'line width'.- Since:
- 7.0
-
getLineWidth
public int getLineWidth()Returns the value of the property 'line width'. With this property you can specify the width of the line of the line/box.- Specified by:
getLineWidth
in interfaceLineProperties
- Returns:
- The current value of the property 'line width'.
- Since:
- 7.0
-
setLineStyle
public void setLineStyle(int lineStyle) Sets the value of the property 'line style' with 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 4 values, it inserts a line with the given style.- Specified by:
setLineStyle
in interfaceLineProperties
- Parameters:
lineStyle
- The new value of the property 'line style'.- Throws:
IllegalArgumentException
- if newValue is a invalid line style- Since:
- 7.0
- See Also:
-
BorderPropertiesConstants.NO_LINE
BorderPropertiesConstants.LINE_STYLE_SINGLE
BorderPropertiesConstants.LINE_STYLE_DOUBLE
BorderPropertiesConstants.LINE_STYLE_DASHED
BorderPropertiesConstants.LINE_STYLE_DOTTED
-
getLineStyle
public final int getLineStyle()Returns the value of the property 'line style', with one of the following line styles: single line, double line, dashed line, dotted line or no line.- Specified by:
getLineStyle
in interfaceLineProperties
- Returns:
- The current value of the property 'line style'.
- Since:
- 7.0
- See Also:
-
BorderPropertiesConstants.NO_LINE
BorderPropertiesConstants.LINE_STYLE_SINGLE
BorderPropertiesConstants.LINE_STYLE_DOUBLE
BorderPropertiesConstants.LINE_STYLE_DASHED
BorderPropertiesConstants.LINE_STYLE_DOTTED
-
getLeftLineStyle
public final int getLeftLineStyle()Return the same as getLineStyle()- Specified by:
getLeftLineStyle
in interfaceBorderProperties
- Overrides:
getLeftLineStyle
in classElement
- Returns:
- The current value of the property 'line style'.
- Since:
- 10.0
- See Also:
-
getTopLineStyle
public final int getTopLineStyle()Return the same as getLineStyle()- Specified by:
getTopLineStyle
in interfaceBorderProperties
- Overrides:
getTopLineStyle
in classElement
- Returns:
- The current value of the property 'line style'.
- Since:
- 10.0
- See Also:
-
getRightLineStyle
public final int getRightLineStyle()Return the same as getLineStyle()- Specified by:
getRightLineStyle
in interfaceBorderProperties
- Overrides:
getRightLineStyle
in classElement
- Returns:
- The current value of the property 'line style'.
- Since:
- 10.0
- See Also:
-
getBottomLineStyle
public final int getBottomLineStyle()Return the same as getLineStyle()- Specified by:
getBottomLineStyle
in interfaceBorderProperties
- Overrides:
getBottomLineStyle
in classElement
- Returns:
- The current value of the property 'line style'.
- Since:
- 10.0
- See Also:
-
setX2
public void setX2(int x2) Sets the x position of the element in the end section, if the element does not end in the same section as it begins. The unit is in twips.- Specified by:
setX2
in interfaceLineProperties
- Parameters:
x2
- The x position in twips.- Throws:
IllegalArgumentException
- if x2 is negative- Since:
- 7.0
-
getX2
public int getX2()Returns the x position of the element in the end section, if the element does not end in the same section as it begins. The unit is in twips.- Specified by:
getX2
in interfaceLineProperties
- Returns:
- The x position in the end section in twips.
- Since:
- 7.0
-
setY2
public void setY2(int y2) Sets the y position of the element in the end section, if the element does not end in the same section as it begins. The unit is in twips.- Specified by:
setY2
in interfaceLineProperties
- Parameters:
y2
- The y position in twips.- Throws:
IllegalArgumentException
- if y2 is negative- Since:
- 7.0
-
getY2
public int getY2()Returns the x position of the element in the end section, if the element does not end in the same section as it begins. The unit is in twips.- Specified by:
getY2
in interfaceLineProperties
- Returns:
- The x position in the end section in twips.
- Since:
- 7.0
-
getEndSection
Returns the value of the property 'end section'. When the line should span some sections, you have to specify the end-section of the line.- Specified by:
getEndSection
in interfaceLineProperties
- Returns:
- The section in that the line ends if the line goes across more than one section.
- Since:
- 7.0
-
setEndSection
Sets the value of the property 'end section'. When the line should span some sections, you have to specify the end-section of the line.- Specified by:
setEndSection
in interfaceLineProperties
- Parameters:
newValue
- The section in that the line should ends, if the line should go across more than one section.- Since:
- 7.0
-
getWidth
public int getWidth()Returns the width of an element. Use the 'element width' property to change the width of the element. The unit is in twips.- Specified by:
getWidth
in interfaceLineProperties
- Overrides:
getWidth
in classReportComponent
- Returns:
- The width in twips.
- Since:
- 7.0
-
getHeight
public int getHeight()Returns the height of an element. Use the 'element height' property to change the width of the element. The unit is in twips.- Specified by:
getHeight
in interfaceLineProperties
- Overrides:
getHeight
in classReportComponent
- Returns:
- The width in twips.
- Throws:
UnsupportedOperationException
- if this element spans multiple sections- Since:
- 7.0
-
setWidth
public final void setWidth(int w) Sets the width of an element. Use the 'element width' property to change the width of the element. The unit is in twips.- Specified by:
setWidth
in interfaceLineProperties
- Overrides:
setWidth
in classReportComponent
- Parameters:
w
- The width in twips.- Throws:
UnsupportedOperationException
- if this element spans multiple sectionsIllegalArgumentException
- if w is negative- Since:
- 7.0
-
setHeight
public final void setHeight(int h) Sets the height of an element. Use the 'element height' property to change the width of the element. The unit is in twips.- Specified by:
setHeight
in interfaceLineProperties
- Overrides:
setHeight
in classReportComponent
- Parameters:
h
- The width in twips.- Throws:
UnsupportedOperationException
- if this element spans multiple sectionsIllegalArgumentException
- if h is negative- Since:
- 7.0
-
spansMultipleSections
public final boolean spansMultipleSections()Returns whether this element spans multiple sections or not.
Line
andBox
are the only elements which can span multiple section. If this method returns true the end section can be identified by callinggetEndSection()
.- Returns:
True
if this elements spans multiple sections,false
otherwise.- Since:
- 7.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 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 classElement
- 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 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 classElement
- Parameters:
text
- text encountered and to be storedparserMap
- The map of current Parser.
-
isMultiSectionElement
public boolean isMultiSectionElement()Returntrue
, if this element span over more than one section- Returns:
true
, if this element span over more than one section- Since:
- 11.1
-