com.inet.report

Interface BoxProperties

All Known Implementing Classes:

Box

public interface BoxProperties

Interface for elements that displays boxes-like elements with round edges.

This class is part of the RDC.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
int	getBackColor() Returns the value of the property 'back color'.
FormulaField	getBackColorFormula() Returns the formula for the property 'back color'.
FormulaField	getCloseBorderOnPageBreakFormula() Returns the formula for the property 'close border on page break'.
int	getCornerEllipseHeight() Returns the value of the property 'corner ellipse height'.
int	getCornerEllipseWidth() Returns the value of the property 'corner ellipse width'.
FormulaField	getDropShadowFormula() Returns the formula for the property 'drop shadow'.
boolean	isCloseBorderOnPageBreak() Returns the value of the property 'close border on page break'.
boolean	isDropShadow() Gets the value of the property 'drop shadow'.
void	setBackColor(int backColor) Sets the value of the property 'back color'.
void	setBackColorFormula(FormulaField newFormula) Sets the formula for the property 'back color'.
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	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'.
void	setDropShadow(boolean newValue) Sets the value of the property 'drop shadow'.
void	setDropShadowFormula(FormulaField newFormula) Sets the formula for the property 'drop shadow'.

Method Detail

setCloseBorderOnPageBreak

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:

7.0

isCloseBorderOnPageBreak

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:

7.0

setCloseBorderOnPageBreakFormula

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:

7.0

getCloseBorderOnPageBreakFormula

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:

7.0

setDropShadow

void setDropShadow(boolean newValue)

Sets the value of the property 'drop shadow'. If this property is enabled, a drop shadow will be printed (below and to the right). Otherwise no shadow will be pinted.

Parameters:

newValue - true if the property should be set, else false.

Since:

7.0

isDropShadow

boolean isDropShadow()

Gets the value of the property 'drop shadow'. If this property is enabled, a drop shadow will be printed (below and to the right). Otherwise no shadow will be pinted.

Returns:

true if the property is set, else false.

Since:

7.0

setDropShadowFormula

void setDropShadowFormula(FormulaField newFormula)

Sets the formula for the property 'drop shadow'. If this property is enabled, a drop shadow will be printed (below and to the right). Otherwise no shadow will be pinted.

Parameters:

newFormula - The new formula for the property 'drop shadow'.

Since:

7.0

getDropShadowFormula

FormulaField getDropShadowFormula()

Returns the formula for the property 'drop shadow'. If this property is enabled, a drop shadow will be printed (below and to the right). Otherwise no shadow will be pinted.

Returns:

FormulaField The formula for the property 'drop shadow'.

Since:

7.0

setBackColor

void setBackColor(int backColor)

Sets the value of the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.

Parameters:

backColor - the new value of the property 'backColor'.

Since:

7.0

See Also:

RDC.COLOR_AQUA, RDC.COLOR_BLACK, RDC.COLOR_BLUE, RDC.COLOR_FUCHSIA, RDC.COLOR_GRAY, RDC.COLOR_GREEN, RDC.COLOR_LIME, RDC.COLOR_MAROON, RDC.COLOR_NO_COLOR, RDC.COLOR_OLIVE, RDC.COLOR_PURPLE, RDC.COLOR_RED, RDC.COLOR_SILVER, RDC.COLOR_TEAL, RDC.COLOR_WHITE, RDC.COLOR_YELLOW

getBackColor

int getBackColor()

Returns the value of the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.

Returns:

The value of the property 'backColor'.

Since:

7.0

See Also:

RDC.COLOR_AQUA, RDC.COLOR_BLACK, RDC.COLOR_BLUE, RDC.COLOR_FUCHSIA, RDC.COLOR_GRAY, RDC.COLOR_GREEN, RDC.COLOR_LIME, RDC.COLOR_MAROON, RDC.COLOR_NO_COLOR, RDC.COLOR_OLIVE, RDC.COLOR_PURPLE, RDC.COLOR_RED, RDC.COLOR_SILVER, RDC.COLOR_TEAL, RDC.COLOR_WHITE, RDC.COLOR_YELLOW

setBackColorFormula

void setBackColorFormula(FormulaField newFormula)

Sets the formula for the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.

Parameters:

newFormula - The new fromula for the property 'back color'.

Since:

10.0

See Also:

RDC.COLOR_AQUA, RDC.COLOR_BLACK, RDC.COLOR_BLUE, RDC.COLOR_FUCHSIA, RDC.COLOR_GRAY, RDC.COLOR_GREEN, RDC.COLOR_LIME, RDC.COLOR_MAROON, RDC.COLOR_NO_COLOR, RDC.COLOR_OLIVE, RDC.COLOR_PURPLE, RDC.COLOR_RED, RDC.COLOR_SILVER, RDC.COLOR_TEAL, RDC.COLOR_WHITE, RDC.COLOR_YELLOW

getBackColorFormula

FormulaField getBackColorFormula()

Returns the formula for the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.

Returns:

FormulaField The formula of the property 'back color'.

Since:

10.0

See Also:

RDC.COLOR_AQUA, RDC.COLOR_BLACK, RDC.COLOR_BLUE, RDC.COLOR_FUCHSIA, RDC.COLOR_GRAY, RDC.COLOR_GREEN, RDC.COLOR_LIME, RDC.COLOR_MAROON, RDC.COLOR_NO_COLOR, RDC.COLOR_OLIVE, RDC.COLOR_PURPLE, RDC.COLOR_RED, RDC.COLOR_SILVER, RDC.COLOR_TEAL, RDC.COLOR_WHITE, RDC.COLOR_YELLOW

getCornerEllipseHeight

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.

Returns:

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

Since:

3.0

setCornerEllipseHeight

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.

Parameters:

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

Since:

3.0

getCornerEllipseWidth

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.

Returns:

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

Since:

3.0

setCornerEllipseWidth

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.

Parameters:

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

Since:

3.0