|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IObjectFormat
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 |
---|
ObjectFormatConditionFormulas getConditionFormulas()
Returns the condition formulas used to override the ObjectFormat
object settings.
ObjectFormatConditionFormulas
object containing the condition formulas
used to override the ObjectFormat
object settings.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.
String
.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.
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.
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.
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.
true
if objects are kept together on the same page, and false
otherwise.boolean getEnableSuppress()
Returns true
if the object is suppressed, and false
otherwise.
true
if the object is suppressed, and false
otherwise.Alignment getHorizontalAlignment()
Returns the horizontal alignment for the field.
Alignment
object that specifies the horizontal alignment for the field.java.lang.String getHyperlinkText()
Returns the hyperlink text content.
String
that specifies the hyperlink text content.HyperlinkType getHyperlinkType()
Returns the type of hyperlink.
HyperlinkType
object that contains the type of hyperlink.java.lang.String getToolTipText()
Returns the text found in the tooltip text.
String
that specifies the tooltip text.TextRotationAngle getTextRotationAngle()
Returns the text rotation angle.
TextRotationAngle
object that specifies the text rotation angle.boolean getEnableRepeatOnHorizontalPages()
void setConditionFormulas(ObjectFormatConditionFormulas conditionFormulas)
Sets the condition formulas used to override the ObjectFormat
object settings.
conditionFormulas
- An ObjectFormatConditionFormulas
object containing the
condition formulas used to override the ObjectFormat
object settings.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.
pVal
- A String
for the class name of the report object used in a CSS.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.
pVal
- true
if the object frame is expanded vertically, and false
otherwise.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.
pVal
- true
if the border is closed on a page break, and false
otherwise.void setEnableKeepTogether(boolean pVal)
Sets whether objects are kept together on the same page.
pVal
- true
if objects are kept together on the same page, and false
otherwise.void setEnableSuppress(boolean pVal)
Sets whether the object is suppressed.
pVal
- true
if the object is suppressed, and false
otherwise.void setHorizontalAlignment(Alignment pVal)
Sets the horizontal alignment for the field.
pVal
- An Alignment
object that specifies the horizontal alignment for the field.void setHyperlinkText(java.lang.String pVal)
Sets the hyperlink text content.
pVal
- A String
that specifies the hyperlink text content.void setHyperlinkType(HyperlinkType pVal)
Sets the type of hyperlink.
pVal
- A HyperlinkType
object that contains the type of hyperlink.void setToolTipText(java.lang.String pToolTipText)
Sets the text found in the tooltip text.
pToolTipText
- A String
that specifies the tooltip text.void setTextRotationAngle(TextRotationAngle textRotationAngle)
Sets the text rotation angle.
textRotationAngle
- A TextRotationAngle
object that specifies the text
rotation angle.void setEnableRepeatOnHorizontalPages(boolean bEnableRepeatOnHorizontalPages)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |