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

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

public abstract class DrawingObject
extends ReportObject
implements IDrawingObject, IClone

This object 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.


Constructor Summary
DrawingObject()
           
 
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, com.crystaldecisions.xml.serialization.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.
 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.
 boolean hasContent(java.lang.Object reportObject)
           
 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(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 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.
 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.ReportObject
doControllerModification, enumerateMembers, getBorder, getBorderMargins, 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.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
 

Constructor Detail

DrawingObject

public DrawingObject()
Method Detail

clone

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

copyTo

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

createMember

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

For internal use only.

Overrides:
createMember in class ReportObject

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.

Overrides:
endElement in class ReportObject

getBottom

public int getBottom()
Description copied from interface: IDrawingObject

Returns the position of the bottom of the object.

Specified by:
getBottom in interface IDrawingObject
Returns:
An int that specifies the position of the bottom of the object.

getEnableExtendToBottomOfSection

public boolean getEnableExtendToBottomOfSection()
Description copied from interface: IDrawingObject

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

Specified by:
getEnableExtendToBottomOfSection in interface IDrawingObject
Returns:
true if the object will be extended to the bottom of the section, and false otherwise.

getEndSectionName

public java.lang.String getEndSectionName()
Description copied from interface: IDrawingObject

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

Specified by:
getEndSectionName in interface IDrawingObject
Returns:
A String containing the section name which specifies where the drawing object ends.

getLineColor

public java.awt.Color getLineColor()
Description copied from interface: IDrawingObject

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

Specified by:
getLineColor in interface IDrawingObject
Returns:
A java.awt.Color object that specifies the color for the line.

getLineColorValue

public int getLineColorValue()
Deprecated. internal use only

Specified by:
getLineColorValue in interface IDrawingObject

getLineStyle

public LineStyle getLineStyle()
Description copied from interface: IDrawingObject

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

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

getLineThickness

public int getLineThickness()
Description copied from interface: IDrawingObject

Returns the line thickness (for the border).

Specified by:
getLineThickness in interface IDrawingObject
Returns:
An int that specifies the line thickness.

getRight

public int getRight()
Description copied from interface: IDrawingObject

Returns the position of the right side of the object.

Specified by:
getRight in interface IDrawingObject
Returns:
An int that specifies the position of the right side of the object.

hasContent

public boolean hasContent(java.lang.Object reportObject)
Overrides:
hasContent in class ReportObject

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.

Overrides:
readElement in class ReportObject

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

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

save

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

For internal use only.

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

saveContents

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

For internal use only.

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

setBottom

public void setBottom(int bottom)
Description copied from interface: IDrawingObject

Sets the position of the bottom of the object.

Specified by:
setBottom in interface IDrawingObject
Parameters:
bottom - An int that specifies the position of the bottom of the object.

setEnableExtendToBottomOfSection

public void setEnableExtendToBottomOfSection(boolean enableExtendToBottomOfSection)
Description copied from interface: IDrawingObject

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

Specified by:
setEnableExtendToBottomOfSection in interface IDrawingObject
Parameters:
enableExtendToBottomOfSection - true if the object will be extended to the bottom of the section, and false otherwise.

setEndSectionName

public void setEndSectionName(java.lang.String endSectionName)
Description copied from interface: IDrawingObject

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

Specified by:
setEndSectionName in interface IDrawingObject
Parameters:
endSectionName - A String containing the section name which specifies where the drawing object ends.

setLineColor

public void setLineColor(java.awt.Color lineColor)
Description copied from interface: IDrawingObject

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

Specified by:
setLineColor in interface IDrawingObject
Parameters:
lineColor - A java.awt.Color object that specifies the color for the line.

setLineColorValue

public void setLineColorValue(int lineColor)
Deprecated. internal use only

Specified by:
setLineColorValue in interface IDrawingObject

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
Parameters:
lineStyle - A LineStyle object that specifies the style for the line.

setLineThickness

public void setLineThickness(int lineThickness)
Description copied from interface: IDrawingObject

Sets the line thickness (for the border).

Specified by:
setLineThickness in interface IDrawingObject
Parameters:
lineThickness - An int that specifies the line thickness.

setRight

public void setRight(int right)
Description copied from interface: IDrawingObject

Sets the position of the right side of the object.

Specified by:
setRight in interface IDrawingObject
Parameters:
right - An int that specifies the position of the right side of the object.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.

Overrides:
startElement in class ReportObject