com.crystaldecisions.sdk.occa.report.definition
Interface IReportObject

All Superinterfaces:
IClone
All Known Subinterfaces:
IBlobFieldObject, IBoxObject, IChartObject, ICrossTabObject, IDrawingObject, IFieldHeadingObject, IFieldObject, IFlashObject, IGraphicObject, ILineObject, IMapObject, IOlapGridObject, IPictureObject, ISubreportObject, ITextObject
All Known Implementing Classes:
BlobFieldObject, BoxObject, ChartObject, CrossTabObject, DrawingObject, FieldHeadingObject, FieldObject, FlashObject, GraphicObject, LineObject, MapObject, OlapGridObject, PictureObject, ReportObject, SubreportObject, TextObject

public interface IReportObject
extends IClone

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

getBorder

IBorder getBorder()

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

Returns:
The border as an IBorder.

getBorderMargins

BorderMargins getBorderMargins()
Calculates and returns the thickness of the sides of the IBorder returned by getBorder(). Never returns null.

Returns:
the size that the border adds to this IReportObject

getReplacementConditionFormulas

ObjectReplacementConditionFormulas getReplacementConditionFormulas()

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

Returns:
Conditional formulas as ObjectReplacementConditionFormulas.

getFormat

IObjectFormat getFormat()

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

Returns:
The object format as an IObjectFormat.

getHeight

int getHeight()

Returns the height of the report object.

Returns:
The height in twips as an int.

getKind

ReportObjectKind getKind()

Returns the kind for the report object as a ReportObjectKind.

Returns:
The kind for the report object as a ReportObjectKind.

getLeft

int getLeft()

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

Returns:
The position of the report option relative to the left side of the section in twips as an int.

getLinkedURI

java.lang.String getLinkedURI()
Deprecated. Replaced by IRepositoryObject::getLinkedURI()

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

Returns:
The linked repository URI as a String.

getName

java.lang.String getName()

Returns the name of the report object.

Returns:
The name of the report object as a String.

getReportPartBookmark

IReportPartBookmark getReportPartBookmark()

Returns the IReportPartBookmark for the report object.

Returns:
The IReportPartBookmark for the report object.

getSectionCode

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.

Returns:
The section code for the report object as an int.

getSectionName

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.

Returns:
The section name for the report object as a String.

getTop

int getTop()

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

Returns:
The position for the top of the report object in twips as an int.

getWidth

int getWidth()

Returns the width for the report object.

Returns:
The width for the report object in twips as an int.

setBorder

void setBorder(IBorder border)

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

Parameters:
border - The border as an IBorder.

setReplacementConditionFormulas

void setReplacementConditionFormulas(ObjectReplacementConditionFormulas conditionFormulas)

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

Parameters:
conditionFormulas - Conditional formulas as ObjectReplacementConditionFormulas.

setFormat

void setFormat(IObjectFormat objectFormat)

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

Parameters:
objectFormat - The object format as an IObjectFormat.

setHeight

void setHeight(int height)

Sets the height of the report object.

Parameters:
height - The height in twips as an int.

setLeft

void setLeft(int left)

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

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

setLinkedURI

void setLinkedURI(java.lang.String URI)
Deprecated. 

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

Parameters:
URI - The linked repository URI as a String.

setName

void setName(java.lang.String name)

Sets the name of the report object.

Parameters:
name - The name of the report object as a String.

setReportPartBookmark

void setReportPartBookmark(IReportPartBookmark bookmark)

Sets the IReportPartBookmark for the report object.

Parameters:
bookmark - The IReportPartBookmark for the report object.

setSectionCode

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.

Parameters:
sectionCode - The section code for the report object as an int.

setSectionName

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.

Parameters:
sectionName - The section name for the report object as a String.

setTop

void setTop(int top)

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

Parameters:
top - The position for the top of the report object in twips as an int.

setWidth

void setWidth(int width)

Sets the width for the report object.

Parameters:
width - The width for the report object in twips as an int.