com.crystaldecisions.sdk.occa.report.definition
Interface IBoxObject

All Superinterfaces:
IClone, IDrawingObject, IReportObject
All Known Implementing Classes:
BoxObject

public interface IBoxObject
extends IDrawingObject

This interface defines a box object, which is the only object aside from a line that can span several sections. As such, you must specify which section the box ends in. The section of origin is specified when you add the IBoxObject object. The coordinates of a box (its dimensions) are specified by its Bottom, Top, Left, and Right properties. [Top,Left] specifies the x,y coordinate pair of the top left-hand corner of the box, relative to the section that it starts in. Similarly, [Bottom,Right] specifies the x,y coordinate pair of the bottom right-hand corner of the box relative to the section the box ends in. This means that if the box crosses a section boundary you can have two coordinate pairs such as the following: (0,0),(0,0). For more information on how a box behaves, see the Crystal Reports online help.


Method Summary
 boolean getAlwaysCloseBorder()
           
 int getCornerEllipseHeight()
           Returns the corner ellipse height.
 int getCornerEllipseWidth()
           Returns the corner ellipse width.
 java.awt.Color getFillColor()
           Returns the color that fills the box.
 int getFillColorValue()
          Deprecated. internal use only
 void setAlwaysCloseBorder(boolean alwaysCloseBorder)
           
 void setCornerEllipseHeight(int cornerEllipseHeight)
           Sets the corner ellipse height.
 void setCornerEllipseWidth(int cornerEllipseWidth)
           Sets the corner ellipse width.
 void setFillColor(java.awt.Color fillColor)
           Sets the color that fills the box.
 void setFillColorValue(int fillColor)
          Deprecated. internal use only
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IDrawingObject
getBottom, getEnableExtendToBottomOfSection, getEndSectionName, getLineColor, getLineColorValue, getLineStyle, getLineThickness, getRight, setBottom, setEnableExtendToBottomOfSection, setEndSectionName, setLineColor, setLineColorValue, setLineStyle, setLineThickness, setRight
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Method Detail

getCornerEllipseHeight

int getCornerEllipseHeight()

Returns the corner ellipse height.

Returns:
An int that specifies the corner ellipse height.

getCornerEllipseWidth

int getCornerEllipseWidth()

Returns the corner ellipse width.

Returns:
An int that specifies the corner ellipse width.

getFillColor

java.awt.Color getFillColor()

Returns the color that fills the box.

Returns:
A java.awt.Color object that specifies the color that fills the box.

getFillColorValue

int getFillColorValue()
Deprecated. internal use only


getAlwaysCloseBorder

boolean getAlwaysCloseBorder()

setCornerEllipseHeight

void setCornerEllipseHeight(int cornerEllipseHeight)

Sets the corner ellipse height.

Parameters:
cornerEllipseHeight - An int that specifies the corner ellipse height.

setCornerEllipseWidth

void setCornerEllipseWidth(int cornerEllipseWidth)

Sets the corner ellipse width.

Parameters:
cornerEllipseWidth - An int that specifies the corner ellipse width.

setFillColor

void setFillColor(java.awt.Color fillColor)

Sets the color that fills the box.

Parameters:
fillColor - A java.awt.Color object that specifies the color that fills the box.

setFillColorValue

void setFillColorValue(int fillColor)
Deprecated. internal use only


setAlwaysCloseBorder

void setAlwaysCloseBorder(boolean alwaysCloseBorder)