|
|||||||||
| 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
public class ReportObject
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 |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
IBorder |
getBorder()
Returns the border as an IBorder. |
BorderMargins |
getBorderMargins()
For internal use only |
IObjectFormat |
getFormat()
Returns the object format as an IObjectFormat. |
IFormula |
getFormula(TranslatableStringId id)
For internal use only |
int |
getHeight()
Returns the height of the report object. |
java.lang.String |
getImageKey()
For internal use only. |
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()
For internal use only |
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. |
IClone |
getTranslatableObject()
For internal use only |
java.lang.String |
getTranslatableString(TranslatableStringId id)
For internal use only |
java.util.List |
getTranslatableStringIds()
For internal use only |
java.lang.String |
getTranslatableStringLabelResourceID(TranslatableStringId id)
For internal use only |
int |
getVersion()
For internal use only |
int |
getWidth()
Returns the width for the report object. |
boolean |
hasContent(java.lang.Object srcReportObject)
|
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)
For internal use only. |
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)
For internal use only |
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 |
setTranslatableString(TranslatableStringId id,
java.lang.String newText)
For internal use only |
void |
setVersion(int version)
For internal use only |
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 |
|---|
public ReportObject(IReportObject src)
public ReportObject()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
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.
public void endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only.
public IBorder getBorder()
IReportObjectReturns the border as an IBorder.
IBorder defines the color and the line styles
of a report object's border.
getBorder in interface IReportObjectIBorder.public ObjectReplacementConditionFormulas getReplacementConditionFormulas()
IReportObject
getReplacementConditionFormulas in interface IReportObjectpublic IObjectFormat getFormat()
IReportObjectReturns the object format as an IObjectFormat.
IObjectFormat is used to format different kinds of ReportObject objects.
getFormat in interface IReportObjectIObjectFormat.public int getHeight()
IReportObjectReturns the height of the report object.
getHeight in interface IReportObjectint.public ReportObjectKind getKind()
IReportObjectReturns the kind for the report object as a ReportObjectKind.
getKind in interface IReportObjectReportObjectKind.public int getLeft()
IReportObjectReturns the position of the report option relative to the left side of the section.
getLeft in interface IReportObjectint.public java.lang.String getLinkedURI()
IReportObjectReturns the linked repository URI.
The repository is a central location used to store and manage report objects.
getLinkedURI in interface IReportObjectURI as a String.public int getVersion()
public java.lang.String getName()
IReportObjectReturns the name of the report object.
getName in interface IReportObjectString.public IReportPartBookmark getReportPartBookmark()
IReportObjectReturns the IReportPartBookmark for the report object.
getReportPartBookmark in interface IReportObjectIReportPartBookmark for the report object.public int getSectionCode()
IReportObjectReturns the section code for the report object. Report objects are added
to sections in the report. For more information see ISection and
Section.
getSectionCode in interface IReportObjectint.public java.lang.String getSectionName()
IReportObjectReturns the section name for the report object. Report objects are added
to sections in the report. For more information see ISection and
Section.
getSectionName in interface IReportObjectString.public int getTop()
IReportObjectReturns the position of the report object relative to the top of the section.
getTop in interface IReportObjectint.public int getWidth()
IReportObjectReturns the width for the report object.
getWidth in interface IReportObjectint.public boolean hasContent(java.lang.Object srcReportObject)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only.
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOExceptionpublic void setBorder(IBorder border)
IReportObjectSets the border as an IBorder.
IBorder defines the color and the line styles
of a report object's border.
setBorder in interface IReportObjectborder - The border as an IBorder.public void setReplacementConditionFormulas(ObjectReplacementConditionFormulas conditionFormulas)
IReportObject
setReplacementConditionFormulas in interface IReportObjectpublic void setFormat(IObjectFormat objectFormat)
IReportObjectSets the object format as an IObjectFormat.
IObjectFormat is used to format different kinds of ReportObject objects.
setFormat in interface IReportObjectobjectFormat - The object format as an IObjectFormat.public void setHeight(int height)
IReportObjectSets the height of the report object.
setHeight in interface IReportObjectheight - The height in twips as an int.public void setKind(ReportObjectKind kind)
public void setLeft(int left)
IReportObjectSets the position of the report option relative to the left side of the section.
setLeft in interface IReportObjectleft - The position of the report option relative
to the left side of the section in twips as an int.public void setLinkedURI(java.lang.String URI)
IReportObjectSets the linked repository URI.
The repository is a central location used to store and manage report objects.
setLinkedURI in interface IReportObjectURI - The linked repository URI as a String.public void setVersion(int version)
public void setName(java.lang.String name)
IReportObjectSets the name of the report object.
setName in interface IReportObjectname - The name of the report object as a String.public void setReportPartBookmark(IReportPartBookmark bookmark)
IReportObjectSets the IReportPartBookmark for the report object.
setReportPartBookmark in interface IReportObjectbookmark - The IReportPartBookmark for the report object.public void setSectionCode(int sectionCode)
IReportObjectSets the section code for the report object. Report objects are added
to sections in the report. For more information see ISection and
Section.
setSectionCode in interface IReportObjectsectionCode - The section code for the report object as an int.public void setSectionName(java.lang.String sectionName)
IReportObjectSets the section name for the report object. Report objects are added
to sections in the report. For more information see ISection and
Section.
setSectionName in interface IReportObjectsectionName - The section name for the report object as a String.public void setTop(int top)
IReportObjectSets the position for the top of the report object relative to the object above it in the section.
setTop in interface IReportObjecttop - The position for the top of the report object
in twips as an int.public void setWidth(int width)
IReportObjectSets the width for the report object.
setWidth in interface IReportObjectwidth - The width for the report object
in twips as an int.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only.
public BorderMargins getBorderMargins()
IReportObject
getBorderMargins in interface IReportObjectpublic java.util.List getTranslatableStringIds()
public java.lang.String getTranslatableString(TranslatableStringId id)
public void setTranslatableString(TranslatableStringId id,
java.lang.String newText)
public java.lang.String getTranslatableStringLabelResourceID(TranslatableStringId id)
public IFormula getFormula(TranslatableStringId id)
public IClone getTranslatableObject()
public java.lang.String getImageKey()
For internal use only.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||