|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportObject
This interface is used to get and set values for 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
interfaces inherit. IReportObject
contains methods that are common
to all report objects.
Method Summary | |
---|---|
IBorder |
getBorder()
Returns the border as an IBorder . |
BorderMargins |
getBorderMargins()
Calculates and returns the thickness of the sides of the IBorder returned by getBorder() . |
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()
Deprecated. Replaced by IRepositoryObject::getLinkedURI() |
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 |
getWidth()
Returns the width for the report object. |
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 |
setLeft(int left)
Sets the position of the report option relative to the left side of the section. |
void |
setLinkedURI(java.lang.String URI)
Deprecated. |
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 |
setWidth(int width)
Sets the width for the report object. |
Method Detail |
---|
IBorder getBorder()
Returns the border as an IBorder
.
IBorder
defines the color and the line styles
of a report object's border.
IBorder
.BorderMargins getBorderMargins()
getBorder()
. Never returns null.
ObjectReplacementConditionFormulas getReplacementConditionFormulas()
Returns the conditional formulas as ObjectReplacementConditionFormulas
.
Conditional formulas are used to override the reportobject's size and position property settings.
ObjectReplacementConditionFormulas
.IObjectFormat getFormat()
Returns the object format as an IObjectFormat
.
IObjectFormat
is used to format different kinds of ReportObject objects.
IObjectFormat
.int getHeight()
Returns the height of the report object.
int
.ReportObjectKind getKind()
Returns the kind for the report object as a ReportObjectKind
.
ReportObjectKind
.int getLeft()
Returns the position of the report option relative to the left side of the section.
int
.java.lang.String getLinkedURI()
Returns the linked repository URI
.
The repository is a central location used to store and manage report objects.
URI
as a String
.java.lang.String getName()
Returns the name of the report object.
String
.IReportPartBookmark getReportPartBookmark()
Returns the IReportPartBookmark
for the report object.
IReportPartBookmark
for the report object.int getSectionCode()
Returns the section code for the report object. Report objects are added
to sections in the report. For more information see ISection
and
Section
.
int
.java.lang.String getSectionName()
Returns the section name for the report object. Report objects are added
to sections in the report. For more information see ISection
and
Section
.
String
.int getTop()
Returns the position of the report object relative to the top of the section.
int
.int getWidth()
Returns the width for the report object.
int
.void setBorder(IBorder border)
Sets the border as an IBorder
.
IBorder
defines the color and the line styles
of a report object's border.
border
- The border as an IBorder
.void setReplacementConditionFormulas(ObjectReplacementConditionFormulas conditionFormulas)
Sets the conditional formulas as ObjectReplacementConditionFormulas
.
Conditional formulas are used to override the reportobject's size and position property settings.
conditionFormulas
- Conditional formulas as ObjectReplacementConditionFormulas
.void setFormat(IObjectFormat objectFormat)
Sets the object format as an IObjectFormat
.
IObjectFormat
is used to format different kinds of ReportObject objects.
objectFormat
- The object format as an IObjectFormat
.void setHeight(int height)
Sets the height of the report object.
height
- The height in twips as an int
.void setLeft(int left)
Sets the position of the report option relative to the left side of the section.
left
- The position of the report option relative
to the left side of the section in twips as an int
.void setLinkedURI(java.lang.String URI)
Sets the linked repository URI
.
The repository is a central location used to store and manage report objects.
URI
- The linked repository URI
as a String
.void setName(java.lang.String name)
Sets the name of the report object.
name
- The name of the report object as a String
.void setReportPartBookmark(IReportPartBookmark bookmark)
Sets the IReportPartBookmark
for the report object.
bookmark
- The IReportPartBookmark
for the report object.void setSectionCode(int sectionCode)
Sets the section code for the report object. Report objects are added
to sections in the report. For more information see ISection
and
Section
.
sectionCode
- The section code for the report object as an int
.void setSectionName(java.lang.String sectionName)
Sets the section name for the report object. Report objects are added
to sections in the report. For more information see ISection
and
Section
.
sectionName
- The section name for the report object as a String
.void setTop(int top)
Sets the position for the top of the report object relative to the object above it in the section.
top
- The position for the top of the report object
in twips as an int
.void setWidth(int width)
Sets the width for the report object.
width
- The width for the report object
in twips as an int
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |