Class TOCHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.TOCHandle
Represents an "TOC" attached to an element.Obtain an instance of this class
by calling the
getTOCHandle
method on the handle of an element
that defines an action.-
Field Summary
FieldsFields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
Constructor Summary
ConstructorsConstructorDescriptionTOCHandle
(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context) Deprecated.TOCHandle
(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context) Construct an handle to deal with the toc structure. -
Method Summary
Modifier and TypeMethodDescriptionGets back-ground-color property.Gets border-bottom-width property.Returns the style of the border bottom line.Gets border-bottom-width property.Gets border-left-color property.Gets border-left-style property.Gets border-left-width property.Gets border-right-color property.Gets border-right-style property.Gets border-right-width property.Gets border-top-color property.Gets border-top-style property.Gets border-top-width property.getColor()
Gets font color property.Gets date time format property.Gets date time format category property.Gets expression of TOC.Gets font family property.Gets font size property.Returns the font style handle for the style.Returns the font variant in a string.Returns the font weight of the highlight rule.Gets number align property.Gets number format property.Gets number format category property.Returns a handle to work with the style properties of toc element.Gets string format property.Returns the category of a string format for a toc.Gets style of TOC.Returns the value of text align property.Returns the value of direction property.Gets text indent property.Returns the value of the line through property.Returns the value of the overline property.Returns the value of the text transform property.Returns the value of the underline property.void
setExpression
(String expression) Sets expression of TOC.void
setStyleName
(String styleName) Sets style of TOC.void
setTextDirection
(String value) Sets the Bidi direction property.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Field Details
-
defaultTOCPrefixName
Default TOC style's prefix name.- See Also:
-
-
Constructor Details
-
TOCHandle
public TOCHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context) Construct an handle to deal with the toc structure.- Parameters:
element
- the element that defined the action.context
- context to the toc property.
-
TOCHandle
@Deprecated public TOCHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef context) Deprecated.Construct an handle to deal with the toc structure.- Parameters:
element
- the element that defined the action.context
- context to the toc property
-
-
Method Details
-
getExpression
Gets expression of TOC.- Returns:
- expression of TOC.
-
setExpression
Sets expression of TOC.- Parameters:
expression
- expression of TOC- Throws:
SemanticException
- semantic exception
-
getStyleName
Gets style of TOC.- Returns:
- style name of TOC
-
setStyleName
Sets style of TOC.- Parameters:
styleName
- style name- Throws:
SemanticException
-
getPrivateStyle
Returns a handle to work with the style properties of toc element. Use a style handle to work with the specific getter/setter methods for each style property. The style handle is not necessary to work with style properties generically.Note a key difference between this method and the
getStyle( )
method. This method returns a handle to the this element. ThegetStyle( )
method returns a handle to the shared style, if any, that this element references.- Returns:
- a style handle to work with the style properties of this element.
Returns
null
if this element does not have style properties.
-
getBorderTopStyle
Gets border-top-style property.- Returns:
- border-top-style property
-
getBorderTopWidth
Gets border-top-width property.- Returns:
- border-top-width property
-
getBorderTopColor
Gets border-top-color property.- Returns:
- border-top-color property
-
getBorderLeftStyle
Gets border-left-style property.- Returns:
- border-left-style property
-
getBorderLeftWidth
Gets border-left-width property.- Returns:
- border-left-width property
-
getBorderLeftColor
Gets border-left-color property.- Returns:
- border-left-color property
-
getBorderBottomStyle
Returns the style of the border bottom line. The return value is one of the CSS (pre-defined) values seeDesignChoiceConstants
. They are:LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
- Returns:
- the border bottom style
-
getBorderBottomWidth
Gets border-bottom-width property.- Returns:
- border-bottom-width property
-
getBorderBottomColor
Gets border-bottom-width property.- Returns:
- border-bottom-width property
-
getBorderRightStyle
Gets border-right-style property.- Returns:
- border-right-style property
-
getBorderRightWidth
Gets border-right-width property.- Returns:
- border-right-width property
-
getBorderRightColor
Gets border-right-color property.- Returns:
- border-right-color property
-
getBackgroundColor
Gets back-ground-color property.- Returns:
- back-ground-color property
-
getDateTimeFormat
Gets date time format property.- Returns:
- date time format property
-
getDateTimeFormatCategory
Gets date time format category property.- Returns:
- date time format category property
-
getNumberFormat
Gets number format property.- Returns:
- number format property
-
getNumberFormatCategory
Gets number format category property.- Returns:
- number format category property
-
getNumberAlign
Gets number align property.- Returns:
- number align property
-
getStringFormat
Gets string format property.- Returns:
- string format property
-
getStringFormatCategory
Returns the category of a string format for a toc.- Returns:
- the category of a string format
-
getFontFamily
Gets font family property.- Returns:
- font family property
-
getFontSize
Gets font size property.- Returns:
- font size property
-
getFontStyle
Returns the font style handle for the style. The return value is defined inDesignChoiceConstants
and can be one of:FONT_STYLE_NORMAL
FONT_STYLE_ITALIC
FONT_STYLE_OBLIQUE
- Returns:
- the font style in string.
-
getFontWeight
Returns the font weight of the highlight rule. The return value is defined inDesignChoiceConstants
and can be one of:FONT_WEIGHT_NORMAL
FONT_WEIGHT_BOLD
FONT_WEIGHT_BOLDER
FONT_WEIGHT_LIGHTER
FONT_WEIGHT_100
FONT_WEIGHT_200
FONT_WEIGHT_300
FONT_WEIGHT_400
FONT_WEIGHT_500
FONT_WEIGHT_600
FONT_WEIGHT_700
FONT_WEIGHT_800
FONT_WEIGHT_900
- Returns:
- the font weight in string.
-
getFontVariant
Returns the font variant in a string. The return value is defined inDesignChoiceConstants
and can be one of:FONT_VARIANT_NORMAL
FONT_VARIANT_SMALL_CAPS
- Returns:
- the font variant in a string.
-
getColor
Gets font color property.- Returns:
- font color property
-
getTextUnderline
Returns the value of the underline property. The returned value is defined inDesignChoiceConstants
and can be one of:TEXT_UNDERLINE_NONE
TEXT_UNDERLINE_UNDERLINE
- Returns:
- the value of the underline property
-
getTextOverline
Returns the value of the overline property. The returned value is defined inDesignChoiceConstants
and can be one of:TEXT_OVERLINE_NONE
TEXT_OVERLINE_OVERLINE
- Returns:
- the value of the overline property
-
getTextLineThrough
Returns the value of the line through property. The returned value is defined inDesignChoiceConstants
and can be one of:TEXT_LINE_THROUGH_NONE
TEXT_LINE_THROUGH_LINE_THROUGH
- Returns:
- the text line through
-
getTextAlign
Returns the value of text align property. The return value is defined inDesignChoiceConstants
and can be one of:TEXT_ALIGN_LEFT
TEXT_ALIGN_CENTER
TEXT_ALIGN_RIGHT
TEXT_ALIGN_JUSTIFY
- Returns:
- the value of text align property
-
getTextDirection
Returns the value of direction property. The return value is defined inDesignChoiceConstants
and can be one of:BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
- Returns:
- the value of direction property
-
setTextDirection
Sets the Bidi direction property. The input value is defined inDesignChoiceConstants
and can be one of:BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
- Parameters:
value
- the new direction value- Throws:
SemanticException
- if the value is not one of the above.
-
getTextIndent
Gets text indent property.- Returns:
- text indent property
-
getTextTransform
Returns the value of the text transform property. The return value is defined inDesignChoiceConstants
and can be one of:TRANSFORM_CAPITALIZE
TRANSFORM_UPPERCASE
TRANSFORM_LOWERCASE
TRANSFORM_NONE
- Returns:
- the value of the transform property
-