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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportObject
All Implemented Interfaces:
IReportObject, IClone
Direct Known Subclasses:
ChartObject, CrossTabObject, DrawingObject, FieldObject, FlashObject, GraphicObject, MapObject, OlapGridObject, SubreportObject, TextObject

public class ReportObject
extends java.lang.Object
implements IReportObject, IClone

This object specifies how an object looks when it appears on the report. Specifically, it contains information about the object's size and border. It is used as an abstract base from which other objects inherit. ReportObject contains methods that are common to all report objects. When possible, use IReportObject to manipulate this object.


Constructor Summary
ReportObject()
           
ReportObject(IReportObject 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 doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 IBorder getBorder()
          Returns the border as an IBorder.
 BorderMargins getBorderMargins()
          Calculates and returns the thickness of the sides of the IBorder returned by getBorder().
 ControllableMixin getControllableMixin()
           
 IObjectFormat getFormat()
          Returns the object format as an IObjectFormat.
 int getHeight()
          Returns the height of the report object.
 ReportObjectKind getKind()
          Returns the kind for the report object as a ReportObjectKind.
 int getLeft()
          Returns the position of the report option relative to the left side of the section.
 java.lang.String getLinkedURI()
          Returns the linked repository URI.
 java.lang.String getName()
          Returns the name of the report object.
 ObjectReplacementConditionFormulas getReplacementConditionFormulas()
           Returns the conditional formulas as ObjectReplacementConditionFormulas.
 IReportPartBookmark getReportPartBookmark()
          Returns the IReportPartBookmark for the report object.
 int getSectionCode()
          Returns the section code for the report object.
 java.lang.String getSectionName()
          Returns the section name for the report object.
 int getTop()
          Returns the position of the report object relative to the top of the section.
 int getVersion()
           
 int getWidth()
          Returns the width for the report object.
 boolean hasContent(java.lang.Object srcReportObject)
           
 boolean isDirectlyControllable()
           
 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 setBorder(IBorder border)
          Sets the border as an IBorder.
 void setFormat(IObjectFormat objectFormat)
          Sets the object format as an IObjectFormat.
 void setHeight(int height)
          Sets the height of the report object.
 void setKind(ReportObjectKind kind)
           
 void setLeft(int left)
          Sets the position of the report option relative to the left side of the section.
 void setLinkedURI(java.lang.String URI)
          Sets the linked repository URI.
 void setName(java.lang.String name)
          Sets the name of the report object.
 void setReplacementConditionFormulas(ObjectReplacementConditionFormulas conditionFormulas)
           Sets the conditional formulas as ObjectReplacementConditionFormulas.
 void setReportPartBookmark(IReportPartBookmark bookmark)
          Sets the IReportPartBookmark for the report object.
 void setSectionCode(int sectionCode)
          Sets the section code for the report object.
 void setSectionName(java.lang.String sectionName)
          Sets the section name for the report object.
 void setTop(int top)
          Sets the position for the top of the report object relative to the object above it in the section.
 void setVersion(int version)
           
 void setWidth(int width)
          Sets the width for the report object.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportObject

public ReportObject(IReportObject src)

ReportObject

public ReportObject()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

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.


endElement

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

For internal use only.


getBorder

public IBorder getBorder()
Description copied from interface: IReportObject

Returns the border as an IBorder. IBorder defines the color and the line styles of a report object's border.

Specified by:
getBorder in interface IReportObject
Returns:
The border as an IBorder.

getReplacementConditionFormulas

public ObjectReplacementConditionFormulas getReplacementConditionFormulas()
Description copied from interface: IReportObject

Returns the conditional formulas as ObjectReplacementConditionFormulas. Conditional formulas are used to override the reportobject's size and position property settings.

Specified by:
getReplacementConditionFormulas in interface IReportObject
Returns:
Conditional formulas as ObjectReplacementConditionFormulas.

getFormat

public IObjectFormat getFormat()
Description copied from interface: IReportObject

Returns the object format as an IObjectFormat. IObjectFormat is used to format different kinds of ReportObject objects.

Specified by:
getFormat in interface IReportObject
Returns:
The object format as an IObjectFormat.

getHeight

public int getHeight()
Description copied from interface: IReportObject

Returns the height of the report object.

Specified by:
getHeight in interface IReportObject
Returns:
The height in twips as an int.

getKind

public ReportObjectKind getKind()
Description copied from interface: IReportObject

Returns the kind for the report object as a ReportObjectKind.

Specified by:
getKind in interface IReportObject
Returns:
The kind for the report object as a ReportObjectKind.

getLeft

public int getLeft()
Description copied from interface: IReportObject

Returns the position of the report option relative to the left side of the section.

Specified by:
getLeft in interface IReportObject
Returns:
The position of the report option relative to the left side of the section in twips as an int.

getLinkedURI

public java.lang.String getLinkedURI()
Description copied from interface: IReportObject

Returns the linked repository URI. The repository is a central location used to store and manage report objects.

Specified by:
getLinkedURI in interface IReportObject
Returns:
The linked repository URI as a String.

getVersion

public int getVersion()

getName

public java.lang.String getName()
Description copied from interface: IReportObject

Returns the name of the report object.

Specified by:
getName in interface IReportObject
Returns:
The name of the report object as a String.

getReportPartBookmark

public IReportPartBookmark getReportPartBookmark()
Description copied from interface: IReportObject

Returns the IReportPartBookmark for the report object.

Specified by:
getReportPartBookmark in interface IReportObject
Returns:
The IReportPartBookmark for the report object.

getSectionCode

public int getSectionCode()
Description copied from interface: IReportObject

Returns the section code for the report object. Report objects are added to sections in the report. For more information see ISection and Section.

Specified by:
getSectionCode in interface IReportObject
Returns:
The section code for the report object as an int.

getSectionName

public java.lang.String getSectionName()
Description copied from interface: IReportObject

Returns the section name for the report object. Report objects are added to sections in the report. For more information see ISection and Section.

Specified by:
getSectionName in interface IReportObject
Returns:
The section name for the report object as a String.

getTop

public int getTop()
Description copied from interface: IReportObject

Returns the position of the report object relative to the top of the section.

Specified by:
getTop in interface IReportObject
Returns:
The position for the top of the report object in twips as an int.

getWidth

public int getWidth()
Description copied from interface: IReportObject

Returns the width for the report object.

Specified by:
getWidth in interface IReportObject
Returns:
The width for the report object in twips as an int.

hasContent

public boolean hasContent(java.lang.Object srcReportObject)

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.


save

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

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

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

For internal use only.

Throws:
java.io.IOException

setBorder

public void setBorder(IBorder border)
Description copied from interface: IReportObject

Sets the border as an IBorder. IBorder defines the color and the line styles of a report object's border.

Specified by:
setBorder in interface IReportObject
Parameters:
border - The border as an IBorder.

setReplacementConditionFormulas

public void setReplacementConditionFormulas(ObjectReplacementConditionFormulas conditionFormulas)
Description copied from interface: IReportObject

Sets the conditional formulas as ObjectReplacementConditionFormulas. Conditional formulas are used to override the reportobject's size and position property settings.

Specified by:
setReplacementConditionFormulas in interface IReportObject
Parameters:
conditionFormulas - Conditional formulas as ObjectReplacementConditionFormulas.

setFormat

public void setFormat(IObjectFormat objectFormat)
Description copied from interface: IReportObject

Sets the object format as an IObjectFormat. IObjectFormat is used to format different kinds of ReportObject objects.

Specified by:
setFormat in interface IReportObject
Parameters:
objectFormat - The object format as an IObjectFormat.

setHeight

public void setHeight(int height)
Description copied from interface: IReportObject

Sets the height of the report object.

Specified by:
setHeight in interface IReportObject
Parameters:
height - The height in twips as an int.

setKind

public void setKind(ReportObjectKind kind)

setLeft

public void setLeft(int left)
Description copied from interface: IReportObject

Sets the position of the report option relative to the left side of the section.

Specified by:
setLeft in interface IReportObject
Parameters:
left - The position of the report option relative to the left side of the section in twips as an int.

setLinkedURI

public void setLinkedURI(java.lang.String URI)
Description copied from interface: IReportObject

Sets the linked repository URI. The repository is a central location used to store and manage report objects.

Specified by:
setLinkedURI in interface IReportObject
Parameters:
URI - The linked repository URI as a String.

setVersion

public void setVersion(int version)

setName

public void setName(java.lang.String name)
Description copied from interface: IReportObject

Sets the name of the report object.

Specified by:
setName in interface IReportObject
Parameters:
name - The name of the report object as a String.

setReportPartBookmark

public void setReportPartBookmark(IReportPartBookmark bookmark)
Description copied from interface: IReportObject

Sets the IReportPartBookmark for the report object.

Specified by:
setReportPartBookmark in interface IReportObject
Parameters:
bookmark - The IReportPartBookmark for the report object.

setSectionCode

public void setSectionCode(int sectionCode)
Description copied from interface: IReportObject

Sets the section code for the report object. Report objects are added to sections in the report. For more information see ISection and Section.

Specified by:
setSectionCode in interface IReportObject
Parameters:
sectionCode - The section code for the report object as an int.

setSectionName

public void setSectionName(java.lang.String sectionName)
Description copied from interface: IReportObject

Sets the section name for the report object. Report objects are added to sections in the report. For more information see ISection and Section.

Specified by:
setSectionName in interface IReportObject
Parameters:
sectionName - The section name for the report object as a String.

setTop

public void setTop(int top)
Description copied from interface: IReportObject

Sets the position for the top of the report object relative to the object above it in the section.

Specified by:
setTop in interface IReportObject
Parameters:
top - The position for the top of the report object in twips as an int.

setWidth

public void setWidth(int width)
Description copied from interface: IReportObject

Sets the width for the report object.

Specified by:
setWidth in interface IReportObject
Parameters:
width - The width for the report object in twips as an int.

startElement

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

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
Throws:
ReportSDKException

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

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
Returns:
the size that the border adds to this IReportObject