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.

Since:

1.0

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, 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 Type	Method and Description
int	getCornerEllipseHeight() Returns the value of the property 'corner ellipse height'.
int	getCornerEllipseWidth() Returns the value of the property 'corner ellipse width'.
java.util.List<? extends ReportComponent>	getSubComponents() Returns all ReportComponents that are descendants of this one.
boolean	isCloseBorderOnPageBreak() Returns the value of the property 'close border on page break'.
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, setEndSection, setExtendToBottomOfSectionWhenPrinting, setHeight, setLineStyle, setLineWidth, setWidth, setX2, setY2, spansMultipleSections

Methods inherited from class com.inet.report.Element

addListener, copy, 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, getBottomLineStyleFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getForeColor, getForeColorFormula, getLeftLineStyleFormula, getRightLineStyleFormula, getTightHorizontalFormula, getTopLineStyleFormula, isDropShadow, isTightHorizontal, setBackColor, setBackColorFormula, setBottomLineStyle, setBottomLineStyleFormula, 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.parser.NodeParser

isDOMParser, parseDOM, parseElement, parseEndElement, parseText

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

Since:

3.0

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

Since:

3.0

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

Since:

3.0

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

Since:

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

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

getSubComponents

public java.util.List<? extends ReportComponent> getSubComponents()

Returns all ReportComponents that are descendants of this one. E.G. this will return all Element of a Section. But it's as well useful for CrossTabs or Text elements which have additional elements.

Specified by:

getSubComponents in class ReportComponent

Returns:

a list with all sub components which can be empty as well; will be null if the component has no descendants