|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ReportObject
com.crystaldecisions.sdk.occa.report.definition.DrawingObject
com.crystaldecisions.sdk.occa.report.definition.BoxObject
public class BoxObject
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 |
---|
public BoxObject(IBoxObject src)
public BoxObject()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
clone
in class DrawingObject
public void copyTo(java.lang.Object destObject, boolean deepCopy)
copyTo
in class DrawingObject
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.
createMember
in class DrawingObject
public void endElement(java.lang.String eleName, java.util.Map objState)
DrawingObject
For internal use only.
endElement
in class DrawingObject
public int getCornerEllipseHeight()
IBoxObject
Returns the corner ellipse height.
getCornerEllipseHeight
in interface IBoxObject
int
that specifies the corner ellipse height.public int getCornerEllipseWidth()
IBoxObject
Returns the corner ellipse width.
getCornerEllipseWidth
in interface IBoxObject
int
that specifies the corner ellipse width.public java.awt.Color getFillColor()
IBoxObject
Returns the color that fills the box.
getFillColor
in interface IBoxObject
java.awt.Color
object that specifies the color that fills the box.public int getFillColorValue()
getFillColorValue
in interface IBoxObject
public LineStyle getLineStyle()
IDrawingObject
Returns the style for the line (for the border).
getLineStyle
in interface IDrawingObject
getLineStyle
in class DrawingObject
LineStyle
object that specifies the style for the line.public boolean getAlwaysCloseBorder()
getAlwaysCloseBorder
in interface IBoxObject
public boolean hasContent(java.lang.Object srcBoxObject)
hasContent
in class DrawingObject
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
DrawingObject
For internal use only.
readElement
in class DrawingObject
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class DrawingObject
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class DrawingObject
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
DrawingObject
For internal use only.
saveContents
in class DrawingObject
java.io.IOException
public void setCornerEllipseHeight(int cornerEllipseHeight)
IBoxObject
Sets the corner ellipse height.
setCornerEllipseHeight
in interface IBoxObject
cornerEllipseHeight
- An int
that specifies the corner ellipse height.public void setCornerEllipseWidth(int cornerEllipseWidth)
IBoxObject
Sets the corner ellipse width.
setCornerEllipseWidth
in interface IBoxObject
cornerEllipseWidth
- An int
that specifies the corner ellipse width.public void setFillColor(java.awt.Color fillColor)
IBoxObject
Sets the color that fills the box.
setFillColor
in interface IBoxObject
fillColor
- A java.awt.Color
object that specifies the color that fills the box.public void setFillColorValue(int fillColor)
setFillColorValue
in interface IBoxObject
public void setLineStyle(LineStyle lineStyle)
IDrawingObject
Sets the style for the line (for the border).
setLineStyle
in interface IDrawingObject
setLineStyle
in class DrawingObject
lineStyle
- A LineStyle
object that specifies the style for the line.public void setAlwaysCloseBorder(boolean bAlwaysCloseBorder)
setAlwaysCloseBorder
in interface IBoxObject
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
DrawingObject
For internal use only.
startElement
in class DrawingObject
public BorderMargins getBorderMargins()
IReportObject
getBorder()
. Never returns null.
getBorderMargins
in interface IReportObject
getBorderMargins
in class ReportObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |