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

All Superinterfaces:
IClone
All Known Implementing Classes:
ObjectFormat

public interface IObjectFormat
extends IClone

This interface is used to format different kinds of ReportObject objects.


Method Summary
 ObjectFormatConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the ObjectFormat object settings.
 java.lang.String getCssClass()
          Returns the specified class name for the report object.
 boolean getEnableCanGrow()
           Returns true if the object frame is expanded vertically, and false otherwise.
 boolean getEnableCloseAtPageBreak()
           Returns true if the border is closed on a page break, and false otherwise.
 boolean getEnableKeepTogether()
           Returns true if objects are kept together on the same page, and false otherwise.
 boolean getEnableRepeatOnHorizontalPages()
           
 boolean getEnableSuppress()
           Returns true if the object is suppressed, and false otherwise.
 Alignment getHorizontalAlignment()
           Returns the horizontal alignment for the field.
 java.lang.String getHyperlinkText()
           Returns the hyperlink text content.
 HyperlinkType getHyperlinkType()
           Returns the type of hyperlink.
 TextRotationAngle getTextRotationAngle()
           Returns the text rotation angle.
 java.lang.String getToolTipText()
           Returns the text found in the tooltip text.
 void setConditionFormulas(ObjectFormatConditionFormulas conditionFormulas)
           Sets the condition formulas used to override the ObjectFormat object settings.
 void setCssClass(java.lang.String pVal)
           Sets the CSS class name.
 void setEnableCanGrow(boolean pVal)
           Sets whether the object frame is expanded vertically.
 void setEnableCloseAtPageBreak(boolean pVal)
           Sets whether the border is closed on a page break.
 void setEnableKeepTogether(boolean pVal)
           Sets whether objects are kept together on the same page.
 void setEnableRepeatOnHorizontalPages(boolean bEnableRepeatOnHorizontalPages)
           
 void setEnableSuppress(boolean pVal)
           Sets whether the object is suppressed.
 void setHorizontalAlignment(Alignment pVal)
           Sets the horizontal alignment for the field.
 void setHyperlinkText(java.lang.String pVal)
           Sets the hyperlink text content.
 void setHyperlinkType(HyperlinkType pVal)
           Sets the type of hyperlink.
 void setTextRotationAngle(TextRotationAngle textRotationAngle)
           Sets the text rotation angle.
 void setToolTipText(java.lang.String pToolTipText)
           Sets the text found in the tooltip text.
 

Method Detail

getConditionFormulas

ObjectFormatConditionFormulas getConditionFormulas()

Returns the condition formulas used to override the ObjectFormat object settings.

Returns:
An ObjectFormatConditionFormulas object containing the condition formulas used to override the ObjectFormat object settings.

getCssClass

java.lang.String getCssClass()

Returns the specified class name for the report object. This class name can be used in a cascading style sheet (CSS) to indicate a unique style for the selected report object.

Returns:
The class name for the report object (used in a CSS) as a String.

getEnableCanGrow

boolean getEnableCanGrow()

Returns true if the object frame is expanded vertically, and false otherwise. Setting this to true is useful for objects that contain variable length strings, such as memo fields. If this is set to false, the data will be truncated when the value is larger than the frame.

Returns:
true if the object frame is expanded vertically, and false otherwise.

getEnableCloseAtPageBreak

boolean getEnableCloseAtPageBreak()

Returns true if the border is closed on a page break, and false otherwise. If an object has a border and the object is split over two pages, you have two options: set to true to put a border around each part of the split object, or set to false to display each part of the object with a partial border.

Returns:
true if the border is closed on a page break, and false otherwise.

getEnableKeepTogether

boolean getEnableKeepTogether()

Returns true if objects are kept together on the same page, and false otherwise.

Returns:
true if objects are kept together on the same page, and false otherwise.

getEnableSuppress

boolean getEnableSuppress()

Returns true if the object is suppressed, and false otherwise.

Returns:
true if the object is suppressed, and false otherwise.

getHorizontalAlignment

Alignment getHorizontalAlignment()

Returns the horizontal alignment for the field.

Returns:
An Alignment object that specifies the horizontal alignment for the field.

getHyperlinkText

java.lang.String getHyperlinkText()

Returns the hyperlink text content.

Returns:
A String that specifies the hyperlink text content.

getHyperlinkType

HyperlinkType getHyperlinkType()

Returns the type of hyperlink.

Returns:
A HyperlinkType object that contains the type of hyperlink.

getToolTipText

java.lang.String getToolTipText()

Returns the text found in the tooltip text.

Returns:
A String that specifies the tooltip text.

getTextRotationAngle

TextRotationAngle getTextRotationAngle()

Returns the text rotation angle.

Returns:
A TextRotationAngle object that specifies the text rotation angle.

getEnableRepeatOnHorizontalPages

boolean getEnableRepeatOnHorizontalPages()

setConditionFormulas

void setConditionFormulas(ObjectFormatConditionFormulas conditionFormulas)

Sets the condition formulas used to override the ObjectFormat object settings.

Parameters:
conditionFormulas - An ObjectFormatConditionFormulas object containing the condition formulas used to override the ObjectFormat object settings.

setCssClass

void setCssClass(java.lang.String pVal)

Sets the CSS class name. This method enables you to apply classes to report objects and to sections of a report, instead of manually changing the formatting of the report.

Parameters:
pVal - A String for the class name of the report object used in a CSS.

setEnableCanGrow

void setEnableCanGrow(boolean pVal)

Sets whether the object frame is expanded vertically. Setting this to true is useful for objects that contain variable length strings, such as memo fields. If this is set to false, the data will be truncated when the value is larger than the frame.

Parameters:
pVal - true if the object frame is expanded vertically, and false otherwise.

setEnableCloseAtPageBreak

void setEnableCloseAtPageBreak(boolean pVal)

Sets whether the border is closed on a page break. If an object has a border and the object is split over two pages, you have two options: set to true to put a border around each part of the split object, or set to false to display each part of the object with a partial border.

Parameters:
pVal - true if the border is closed on a page break, and false otherwise.

setEnableKeepTogether

void setEnableKeepTogether(boolean pVal)

Sets whether objects are kept together on the same page.

Parameters:
pVal - true if objects are kept together on the same page, and false otherwise.

setEnableSuppress

void setEnableSuppress(boolean pVal)

Sets whether the object is suppressed.

Parameters:
pVal - true if the object is suppressed, and false otherwise.

setHorizontalAlignment

void setHorizontalAlignment(Alignment pVal)

Sets the horizontal alignment for the field.

Parameters:
pVal - An Alignment object that specifies the horizontal alignment for the field.

setHyperlinkText

void setHyperlinkText(java.lang.String pVal)

Sets the hyperlink text content.

Parameters:
pVal - A String that specifies the hyperlink text content.

setHyperlinkType

void setHyperlinkType(HyperlinkType pVal)

Sets the type of hyperlink.

Parameters:
pVal - A HyperlinkType object that contains the type of hyperlink.

setToolTipText

void setToolTipText(java.lang.String pToolTipText)

Sets the text found in the tooltip text.

Parameters:
pToolTipText - A String that specifies the tooltip text.

setTextRotationAngle

void setTextRotationAngle(TextRotationAngle textRotationAngle)

Sets the text rotation angle.

Parameters:
textRotationAngle - A TextRotationAngle object that specifies the text rotation angle.

setEnableRepeatOnHorizontalPages

void setEnableRepeatOnHorizontalPages(boolean bEnableRepeatOnHorizontalPages)