com.inet.report
Class Box

java.lang.Object
  com.inet.report.ReportComponent
      com.inet.report.Element
          com.inet.report.AbstractLineElement
              com.inet.report.Box

All Implemented Interfaces:

BorderProperties, BoxProperties, GeneralProperties, HyperlinkProperties, LineProperties, NodeParser, com.inet.report.ReferenceHolder, java.io.Serializable, java.lang.Cloneable

public class Box
extends AbstractLineElement
implements BoxProperties, HyperlinkProperties

This class represents a box in the report. You can use boxes to enclose other visible elements in the report or to create some graphics. A box can inserted in a single section (use Section.addBox(int, int, int, int)method in class Section) and can span some sections (use method Section.addBox(int, int, int, int, int, Section)in class Section). In second case the last argument of the Section.addBox(int, int, int, int, int, Section) method is the section in that the box will end.
A box differs from borders of an object in the report. Boxes have freeform size and position, where borders has fixed size and are positioned around the bordered object. The border of a field will drawed around each coming value, where a box enclose all. A border cann't be enclose nothing, a box can placed everywhere in the report and don't need to enclose something. No border can span some sections.
If you want to change the color of the box, use methods Element.setForeColor(int) to change the color of the border and method ReportComponent.setBackColor(int) to change the background color of the box inheritated from Element.

This class is part of the RDC.

See Also:

Section.addBox(int,int,int,int), Section.addBox(int,int,int,int,int,Section), Section.remove(Element), Section.getElements(), Section.getElementsV(), Serialized Form

Field Summary

Fields inherited from class com.inet.report.Element

BOX, CHART, CROSSTAB, CROSSTABCELL, CROSSTABCOLUMN, CROSSTABROW, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, 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

int	getCornerEllipseHeight() Returns the value of the property 'corner ellipse height'.
int	getCornerEllipseWidth() Returns the value of the property 'corner ellipse width'.
boolean	isCloseBorderOnPageBreak() Returns the value of the property 'close border on page break'.
NodeParser	parseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML Parses 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.
void	setCloseBorderOnPageBreak(boolean newValue) Sets the value of the property 'close border on page break'.
void	setCornerEllipseHeight(int newValue) Sets the value of the property 'corner ellipse height'.
void	setCornerEllipseWidth(int newValue) Sets the value of the property 'corner ellipse width'.

Methods inherited from class com.inet.report.AbstractLineElement

getBottomLineStyle, getEndSection, getHeight, getLeftLineStyle, getLineStyle, getLineWidth, getRightLineStyle, getTopLineStyle, getWidth, getX2, getY2, isExtendToBottomOfSectionWhenPrinting, isMultiSectionElement, parseText, setEndSection, setExtendToBottomOfSectionWhenPrinting, setHeight, setLineStyle, setLineWidth, setWidth, setX2, setY2, spansMultipleSections

Methods inherited from class com.inet.report.Element

addListener, copy, copyXML2, getBottomLineStyleFormula, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyleFormula, getParent, getPropertyFormulas, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyleFormula, indexOf, isCanGrow, isDropShadow, isSuppressIfDuplicated, isTightHorizontal, paramString, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula

Methods inherited from class com.inet.report.ReportComponent

getBackColor, getBackColorFormula, getKeepTogetherFormula, getSuppressFormula, getType, getX, getY, isKeepTogether, isSuppress, setBackColor, setBackColorFormula, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setX, setY

Methods inherited from interface com.inet.report.BoxProperties

getBackColor, getBackColorFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, isDropShadow, setBackColor, setBackColorFormula, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula

Methods inherited from interface com.inet.report.HyperlinkProperties

getHyperlinkUrl, getHyperlinkUrlFormula, setHyperlinkUrl, setHyperlinkUrlFormula

Methods inherited from interface com.inet.report.LineProperties

getForeColor, getSuppressFormula, getX, getY, isSuppress, setForeColor, setSuppress, setSuppressFormula, setX, setY

Methods inherited from interface com.inet.report.BorderProperties

getBackColor, getBackColorFormula, setBackColor, setBackColorFormula

Methods inherited from interface com.inet.report.GeneralProperties

getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula

Methods inherited from interface com.inet.report.parser.NodeParser

isDOMParser, parseDOM, parseEndElement

Method Detail

getCornerEllipseHeight

public int getCornerEllipseHeight()

Returns the value of the property 'corner ellipse height'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.

Specified by:

getCornerEllipseHeight in interface BoxProperties

Returns:

The current value of the property 'corner ellipse height'.

setCornerEllipseHeight

public void setCornerEllipseHeight(int newValue)

Sets the value of the property 'corner ellipse height'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.

Specified by:

setCornerEllipseHeight in interface BoxProperties

Parameters:

newValue - The new value of the property 'corner ellipse height'.

Throws:

java.lang.IllegalArgumentException - if newValue is negative

getCornerEllipseWidth

public int getCornerEllipseWidth()

Returns the value of the property 'corner ellipse width'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.

Specified by:

getCornerEllipseWidth in interface BoxProperties

Returns:

The current value of the property 'corner ellipse width'.

setCornerEllipseWidth

public void setCornerEllipseWidth(int newValue)

Sets the value of the property 'corner ellipse width'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.

Specified by:

setCornerEllipseWidth in interface BoxProperties

Parameters:

newValue - The new value of the property 'corner ellipse width'.

Throws:

java.lang.IllegalArgumentException - if newValue is negative

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).

Specified by:

isCloseBorderOnPageBreak in interface BorderProperties

Specified by:

isCloseBorderOnPageBreak in interface BoxProperties

Overrides:

isCloseBorderOnPageBreak in class Element

Returns:

FormulaField The value of the property 'close border on page break'.

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).

Specified by:

setCloseBorderOnPageBreak in interface BorderProperties

Specified by:

setCloseBorderOnPageBreak in interface BoxProperties

Overrides:

setCloseBorderOnPageBreak in class Element

Parameters:

newValue - The new value of the property 'close border on page break'.

parseElement

public NodeParser parseElement(com.inet.report.parser.XMLTag group,
                               java.lang.String tag,
                               org.xml.sax.Attributes atts,
                               java.util.Map parserMap)
                        throws FatalParserException

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

Parses 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 interface NodeParser

Overrides:

parseElement in class AbstractLineElement

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 parsed

atts - The set of attributes in the current XMLTag

parserMap - 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.