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

All Superinterfaces:
IClone, IReportObject
All Known Subinterfaces:
IBoxObject, ILineObject
All Known Implementing Classes:
BoxObject, DrawingObject, LineObject

public interface IDrawingObject
extends IReportObject

This interface is used to draw an object in your report object. You can specify the line thickness, style, and color, and the positioning of the drawn object.


Method Summary
 int getBottom()
           Returns the position of the bottom of the object.
 boolean getEnableExtendToBottomOfSection()
           Returns true if the object will be extended to the bottom of the section, and false otherwise.
 java.lang.String getEndSectionName()
           Returns the section name which specifies where the drawing object ends.
 java.awt.Color getLineColor()
           Returns the color for the line (for the border).
 int getLineColorValue()
          Deprecated. internal use only
 LineStyle getLineStyle()
           Returns the style for the line (for the border).
 int getLineThickness()
           Returns the line thickness (for the border).
 int getRight()
           Returns the position of the right side of the object.
 void setBottom(int bottom)
           Sets the position of the bottom of the object.
 void setEnableExtendToBottomOfSection(boolean enableExtendToBottomOfSection)
           Sets whether the object will be extended to the bottom of the section.
 void setEndSectionName(java.lang.String endSectionName)
           Sets the section name which specifies where the drawing object ends.
 void setLineColor(java.awt.Color lineColor)
           Sets the color for the line (for the border).
 void setLineColorValue(int lineColor)
          Deprecated. internal use only
 void setLineStyle(LineStyle lineStyle)
           Sets the style for the line (for the border).
 void setLineThickness(int lineThickness)
           Sets the line thickness (for the border).
 void setRight(int right)
           Sets the position of the right side of the object.
 
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

getBottom

int getBottom()

Returns the position of the bottom of the object.

Returns:
An int that specifies the position of the bottom of the object.

getEnableExtendToBottomOfSection

boolean getEnableExtendToBottomOfSection()

Returns true if the object will be extended to the bottom of the section, and false otherwise.

Returns:
true if the object will be extended to the bottom of the section, and false otherwise.

getEndSectionName

java.lang.String getEndSectionName()

Returns the section name which specifies where the drawing object ends.

Returns:
A String containing the section name which specifies where the drawing object ends.

getLineColor

java.awt.Color getLineColor()

Returns the color for the line (for the border).

Returns:
A java.awt.Color object that specifies the color for the line.

getLineColorValue

int getLineColorValue()
Deprecated. internal use only


getLineStyle

LineStyle getLineStyle()

Returns the style for the line (for the border).

Returns:
A LineStyle object that specifies the style for the line.

getLineThickness

int getLineThickness()

Returns the line thickness (for the border).

Returns:
An int that specifies the line thickness.

getRight

int getRight()

Returns the position of the right side of the object.

Returns:
An int that specifies the position of the right side of the object.

setBottom

void setBottom(int bottom)

Sets the position of the bottom of the object.

Parameters:
bottom - An int that specifies the position of the bottom of the object.

setEnableExtendToBottomOfSection

void setEnableExtendToBottomOfSection(boolean enableExtendToBottomOfSection)

Sets whether the object will be extended to the bottom of the section.

Parameters:
enableExtendToBottomOfSection - true if the object will be extended to the bottom of the section, and false otherwise.

setEndSectionName

void setEndSectionName(java.lang.String endSectionName)

Sets the section name which specifies where the drawing object ends.

Parameters:
endSectionName - A String containing the section name which specifies where the drawing object ends.

setLineColor

void setLineColor(java.awt.Color lineColor)

Sets the color for the line (for the border).

Parameters:
lineColor - A java.awt.Color object that specifies the color for the line.

setLineColorValue

void setLineColorValue(int lineColor)
Deprecated. internal use only


setLineStyle

void setLineStyle(LineStyle lineStyle)

Sets the style for the line (for the border).

Parameters:
lineStyle - A LineStyle object that specifies the style for the line.

setLineThickness

void setLineThickness(int lineThickness)

Sets the line thickness (for the border).

Parameters:
lineThickness - An int that specifies the line thickness.

setRight

void setRight(int right)

Sets the position of the right side of the object.

Parameters:
right - An int that specifies the position of the right side of the object.