com.crystaldecisions.sdk.occa.report.definition
Class BoxObject

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportObject
      extended by com.crystaldecisions.sdk.occa.report.definition.DrawingObject
          extended by com.crystaldecisions.sdk.occa.report.definition.BoxObject
All Implemented Interfaces:
IBoxObject, IDrawingObject, IReportObject, IClone

public class BoxObject
extends DrawingObject
implements IBoxObject, IClone

This object implements 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 BoxObject. 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). When possible, use the IBoxObject interface.


Constructor Summary
BoxObject()
           
BoxObject(IBoxObject src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 boolean getAlwaysCloseBorder()
           
 BorderMargins getBorderMargins()
          Calculates and returns the thickness of the sides of the IBorder returned by getBorder().
 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
 LineStyle getLineStyle()
           Returns the style for the line (for the border).
 boolean hasContent(java.lang.Object srcBoxObject)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void setAlwaysCloseBorder(boolean bAlwaysCloseBorder)
           
 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
 void setLineStyle(LineStyle lineStyle)
           Sets the style for the line (for the border).
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.DrawingObject
getBottom, getEnableExtendToBottomOfSection, getEndSectionName, getLineColor, getLineColorValue, getLineThickness, getRight, setBottom, setEnableExtendToBottomOfSection, setEndSectionName, setLineColor, setLineColorValue, setLineThickness, setRight
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.ReportObject
doControllerModification, enumerateMembers, getBorder, getControllableMixin, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getVersion, getWidth, isDirectlyControllable, setBorder, setFormat, setHeight, setKind, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setVersion, setWidth
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IDrawingObject
getBottom, getEnableExtendToBottomOfSection, getEndSectionName, getLineColor, getLineColorValue, getLineThickness, getRight, setBottom, setEnableExtendToBottomOfSection, setEndSectionName, setLineColor, setLineColorValue, setLineThickness, setRight
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Constructor Detail

BoxObject

public BoxObject(IBoxObject src)

BoxObject

public BoxObject()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class DrawingObject

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class DrawingObject

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.

Overrides:
createMember in class DrawingObject

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: DrawingObject

For internal use only.

Overrides:
endElement in class DrawingObject

getCornerEllipseHeight

public int getCornerEllipseHeight()
Description copied from interface: IBoxObject

Returns the corner ellipse height.

Specified by:
getCornerEllipseHeight in interface IBoxObject
Returns:
An int that specifies the corner ellipse height.

getCornerEllipseWidth

public int getCornerEllipseWidth()
Description copied from interface: IBoxObject

Returns the corner ellipse width.

Specified by:
getCornerEllipseWidth in interface IBoxObject
Returns:
An int that specifies the corner ellipse width.

getFillColor

public java.awt.Color getFillColor()
Description copied from interface: IBoxObject

Returns the color that fills the box.

Specified by:
getFillColor in interface IBoxObject
Returns:
A java.awt.Color object that specifies the color that fills the box.

getFillColorValue

public int getFillColorValue()
Deprecated. internal use only

Specified by:
getFillColorValue in interface IBoxObject

getLineStyle

public LineStyle getLineStyle()
Description copied from interface: IDrawingObject

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

Specified by:
getLineStyle in interface IDrawingObject
Overrides:
getLineStyle in class DrawingObject
Returns:
A LineStyle object that specifies the style for the line.

getAlwaysCloseBorder

public boolean getAlwaysCloseBorder()
Specified by:
getAlwaysCloseBorder in interface IBoxObject

hasContent

public boolean hasContent(java.lang.Object srcBoxObject)
Overrides:
hasContent in class DrawingObject

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: DrawingObject

For internal use only.

Overrides:
readElement in class DrawingObject

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Overrides:
save in class DrawingObject
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Overrides:
save in class DrawingObject
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: DrawingObject

For internal use only.

Overrides:
saveContents in class DrawingObject
Throws:
java.io.IOException

setCornerEllipseHeight

public void setCornerEllipseHeight(int cornerEllipseHeight)
Description copied from interface: IBoxObject

Sets the corner ellipse height.

Specified by:
setCornerEllipseHeight in interface IBoxObject
Parameters:
cornerEllipseHeight - An int that specifies the corner ellipse height.

setCornerEllipseWidth

public void setCornerEllipseWidth(int cornerEllipseWidth)
Description copied from interface: IBoxObject

Sets the corner ellipse width.

Specified by:
setCornerEllipseWidth in interface IBoxObject
Parameters:
cornerEllipseWidth - An int that specifies the corner ellipse width.

setFillColor

public void setFillColor(java.awt.Color fillColor)
Description copied from interface: IBoxObject

Sets the color that fills the box.

Specified by:
setFillColor in interface IBoxObject
Parameters:
fillColor - A java.awt.Color object that specifies the color that fills the box.

setFillColorValue

public void setFillColorValue(int fillColor)
Deprecated. internal use only

Specified by:
setFillColorValue in interface IBoxObject

setLineStyle

public void setLineStyle(LineStyle lineStyle)
Description copied from interface: IDrawingObject

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

Specified by:
setLineStyle in interface IDrawingObject
Overrides:
setLineStyle in class DrawingObject
Parameters:
lineStyle - A LineStyle object that specifies the style for the line.

setAlwaysCloseBorder

public void setAlwaysCloseBorder(boolean bAlwaysCloseBorder)
Specified by:
setAlwaysCloseBorder in interface IBoxObject

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
Description copied from class: DrawingObject

For internal use only.

Overrides:
startElement in class DrawingObject

getBorderMargins

public BorderMargins getBorderMargins()
Description copied from interface: IReportObject
Calculates and returns the thickness of the sides of the IBorder returned by getBorder(). Never returns null.

Specified by:
getBorderMargins in interface IReportObject
Overrides:
getBorderMargins in class ReportObject
Returns:
the size that the border adds to this IReportObject