|
|||||||||
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 |
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 |
---|
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()
IReportObject
Returns the border as an IBorder
.
IBorder
defines the color and the line styles
of a report object's border.
getBorder
in interface IReportObject
IBorder
.public ObjectReplacementConditionFormulas getReplacementConditionFormulas()
IReportObject
Returns the conditional formulas as ObjectReplacementConditionFormulas
.
Conditional formulas are used to override the reportobject's size and position property settings.
getReplacementConditionFormulas
in interface IReportObject
ObjectReplacementConditionFormulas
.public IObjectFormat getFormat()
IReportObject
Returns the object format as an IObjectFormat
.
IObjectFormat
is used to format different kinds of ReportObject objects.
getFormat
in interface IReportObject
IObjectFormat
.public int getHeight()
IReportObject
Returns the height of the report object.
getHeight
in interface IReportObject
int
.public ReportObjectKind getKind()
IReportObject
Returns the kind for the report object as a ReportObjectKind
.
getKind
in interface IReportObject
ReportObjectKind
.public int getLeft()
IReportObject
Returns the position of the report option relative to the left side of the section.
getLeft
in interface IReportObject
int
.public java.lang.String getLinkedURI()
IReportObject
Returns the linked repository URI
.
The repository is a central location used to store and manage report objects.
getLinkedURI
in interface IReportObject
URI
as a String
.public int getVersion()
public java.lang.String getName()
IReportObject
Returns the name of the report object.
getName
in interface IReportObject
String
.public IReportPartBookmark getReportPartBookmark()
IReportObject
Returns the IReportPartBookmark
for the report object.
getReportPartBookmark
in interface IReportObject
IReportPartBookmark
for the report object.public int getSectionCode()
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
.
getSectionCode
in interface IReportObject
int
.public java.lang.String getSectionName()
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
.
getSectionName
in interface IReportObject
String
.public int getTop()
IReportObject
Returns the position of the report object relative to the top of the section.
getTop
in interface IReportObject
int
.public int getWidth()
IReportObject
Returns the width for the report object.
getWidth
in interface IReportObject
int
.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.IOException
public void setBorder(IBorder border)
IReportObject
Sets the border as an IBorder
.
IBorder
defines the color and the line styles
of a report object's border.
setBorder
in interface IReportObject
border
- The border as an IBorder
.public void setReplacementConditionFormulas(ObjectReplacementConditionFormulas conditionFormulas)
IReportObject
Sets the conditional formulas as ObjectReplacementConditionFormulas
.
Conditional formulas are used to override the reportobject's size and position property settings.
setReplacementConditionFormulas
in interface IReportObject
conditionFormulas
- Conditional formulas as ObjectReplacementConditionFormulas
.public void setFormat(IObjectFormat objectFormat)
IReportObject
Sets the object format as an IObjectFormat
.
IObjectFormat
is used to format different kinds of ReportObject objects.
setFormat
in interface IReportObject
objectFormat
- The object format as an IObjectFormat
.public void setHeight(int height)
IReportObject
Sets the height of the report object.
setHeight
in interface IReportObject
height
- The height in twips as an int
.public void setKind(ReportObjectKind kind)
public void setLeft(int left)
IReportObject
Sets the position of the report option relative to the left side of the section.
setLeft
in interface IReportObject
left
- 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)
IReportObject
Sets the linked repository URI
.
The repository is a central location used to store and manage report objects.
setLinkedURI
in interface IReportObject
URI
- The linked repository URI
as a String
.public void setVersion(int version)
public void setName(java.lang.String name)
IReportObject
Sets the name of the report object.
setName
in interface IReportObject
name
- The name of the report object as a String
.public void setReportPartBookmark(IReportPartBookmark bookmark)
IReportObject
Sets the IReportPartBookmark
for the report object.
setReportPartBookmark
in interface IReportObject
bookmark
- The IReportPartBookmark
for the report object.public void setSectionCode(int sectionCode)
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
.
setSectionCode
in interface IReportObject
sectionCode
- The section code for the report object as an int
.public void setSectionName(java.lang.String sectionName)
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
.
setSectionName
in interface IReportObject
sectionName
- The section name for the report object as a String
.public void setTop(int top)
IReportObject
Sets the position for the top of the report object relative to the object above it in the section.
setTop
in interface IReportObject
top
- The position for the top of the report object
in twips as an int
.public void setWidth(int width)
IReportObject
Sets the width for the report object.
setWidth
in interface IReportObject
width
- 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 ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
public BorderMargins getBorderMargins()
IReportObject
getBorder()
. Never returns null.
getBorderMargins
in interface IReportObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |