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
-
public class TOCHandle extends StructureHandle
Represents an "TOC" attached to an element.Obtain an instance of this class by calling thegetTOCHandlemethod on the handle of an element that defines an action.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringdefaultTOCPrefixNameDefault TOC style's prefix name.-
Fields 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
Constructors Constructor Description TOCHandle(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorHandlegetBackgroundColor()Gets back-ground-color property.ColorHandlegetBorderBottomColor()Gets border-bottom-width property.java.lang.StringgetBorderBottomStyle()Returns the style of the border bottom line.DimensionHandlegetBorderBottomWidth()Gets border-bottom-width property.ColorHandlegetBorderLeftColor()Gets border-left-color property.java.lang.StringgetBorderLeftStyle()Gets border-left-style property.DimensionHandlegetBorderLeftWidth()Gets border-left-width property.ColorHandlegetBorderRightColor()Gets border-right-color property.java.lang.StringgetBorderRightStyle()Gets border-right-style property.DimensionHandlegetBorderRightWidth()Gets border-right-width property.ColorHandlegetBorderTopColor()Gets border-top-color property.java.lang.StringgetBorderTopStyle()Gets border-top-style property.DimensionHandlegetBorderTopWidth()Gets border-top-width property.ColorHandlegetColor()Gets font color property.java.lang.StringgetDateTimeFormat()Gets date time format property.java.lang.StringgetDateTimeFormatCategory()Gets date time format category property.java.lang.StringgetExpression()Gets expression of TOC.FontHandlegetFontFamily()Gets font family property.DimensionHandlegetFontSize()Gets font size property.java.lang.StringgetFontStyle()Returns the font style handle for the style.java.lang.StringgetFontVariant()Returns the font variant in a string.java.lang.StringgetFontWeight()Returns the font weight of the highlight rule.java.lang.StringgetNumberAlign()Gets number align property.java.lang.StringgetNumberFormat()Gets number format property.java.lang.StringgetNumberFormatCategory()Gets number format category property.PrivateStyleHandlegetPrivateStyle()Returns a handle to work with the style properties of toc element.java.lang.StringgetStringFormat()Gets string format property.java.lang.StringgetStringFormatCategory()Returns the category of a string format for a toc.java.lang.StringgetStyleName()Gets style of TOC.java.lang.StringgetTextAlign()Returns the value of text align property.java.lang.StringgetTextDirection()Returns the value of direction property.DimensionHandlegetTextIndent()Gets text indent property.java.lang.StringgetTextLineThrough()Returns the value of the line through property.java.lang.StringgetTextOverline()Returns the value of the overline property.java.lang.StringgetTextTransform()Returns the value of the text transform property.java.lang.StringgetTextUnderline()Returns the value of the underline property.voidsetExpression(java.lang.String expression)Sets expression of TOC.voidsetStyleName(java.lang.String styleName)Sets style of TOC.voidsetTextDirection(java.lang.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 Detail
-
defaultTOCPrefixName
public static final java.lang.String defaultTOCPrefixName
Default TOC style's prefix name.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
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 Detail
-
getExpression
public java.lang.String getExpression()
Gets expression of TOC.- Returns:
- expression of TOC.
-
setExpression
public void setExpression(java.lang.String expression) throws SemanticExceptionSets expression of TOC.- Parameters:
expression- expression of TOC- Throws:
SemanticException- semantic exception
-
getStyleName
public java.lang.String getStyleName()
Gets style of TOC.- Returns:
- style name of TOC
-
setStyleName
public void setStyleName(java.lang.String styleName) throws SemanticExceptionSets style of TOC.- Parameters:
styleName- style name- Throws:
SemanticException
-
getPrivateStyle
public PrivateStyleHandle 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
nullif this element does not have style properties.
-
getBorderTopStyle
public java.lang.String getBorderTopStyle()
Gets border-top-style property.- Returns:
- border-top-style property
-
getBorderTopWidth
public DimensionHandle getBorderTopWidth()
Gets border-top-width property.- Returns:
- border-top-width property
-
getBorderTopColor
public ColorHandle getBorderTopColor()
Gets border-top-color property.- Returns:
- border-top-color property
-
getBorderLeftStyle
public java.lang.String getBorderLeftStyle()
Gets border-left-style property.- Returns:
- border-left-style property
-
getBorderLeftWidth
public DimensionHandle getBorderLeftWidth()
Gets border-left-width property.- Returns:
- border-left-width property
-
getBorderLeftColor
public ColorHandle getBorderLeftColor()
Gets border-left-color property.- Returns:
- border-left-color property
-
getBorderBottomStyle
public java.lang.String 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_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Returns:
- the border bottom style
-
getBorderBottomWidth
public DimensionHandle getBorderBottomWidth()
Gets border-bottom-width property.- Returns:
- border-bottom-width property
-
getBorderBottomColor
public ColorHandle getBorderBottomColor()
Gets border-bottom-width property.- Returns:
- border-bottom-width property
-
getBorderRightStyle
public java.lang.String getBorderRightStyle()
Gets border-right-style property.- Returns:
- border-right-style property
-
getBorderRightWidth
public DimensionHandle getBorderRightWidth()
Gets border-right-width property.- Returns:
- border-right-width property
-
getBorderRightColor
public ColorHandle getBorderRightColor()
Gets border-right-color property.- Returns:
- border-right-color property
-
getBackgroundColor
public ColorHandle getBackgroundColor()
Gets back-ground-color property.- Returns:
- back-ground-color property
-
getDateTimeFormat
public java.lang.String getDateTimeFormat()
Gets date time format property.- Returns:
- date time format property
-
getDateTimeFormatCategory
public java.lang.String getDateTimeFormatCategory()
Gets date time format category property.- Returns:
- date time format category property
-
getNumberFormat
public java.lang.String getNumberFormat()
Gets number format property.- Returns:
- number format property
-
getNumberFormatCategory
public java.lang.String getNumberFormatCategory()
Gets number format category property.- Returns:
- number format category property
-
getNumberAlign
public java.lang.String getNumberAlign()
Gets number align property.- Returns:
- number align property
-
getStringFormat
public java.lang.String getStringFormat()
Gets string format property.- Returns:
- string format property
-
getStringFormatCategory
public java.lang.String getStringFormatCategory()
Returns the category of a string format for a toc.- Returns:
- the category of a string format
-
getFontFamily
public FontHandle getFontFamily()
Gets font family property.- Returns:
- font family property
-
getFontSize
public DimensionHandle getFontSize()
Gets font size property.- Returns:
- font size property
-
getFontStyle
public java.lang.String getFontStyle()
Returns the font style handle for the style. The return value is defined inDesignChoiceConstantsand can be one of:FONT_STYLE_NORMALFONT_STYLE_ITALICFONT_STYLE_OBLIQUE
- Returns:
- the font style in string.
-
getFontWeight
public java.lang.String getFontWeight()
Returns the font weight of the highlight rule. The return value is defined inDesignChoiceConstantsand can be one of:FONT_WEIGHT_NORMALFONT_WEIGHT_BOLDFONT_WEIGHT_BOLDERFONT_WEIGHT_LIGHTERFONT_WEIGHT_100FONT_WEIGHT_200FONT_WEIGHT_300FONT_WEIGHT_400FONT_WEIGHT_500FONT_WEIGHT_600FONT_WEIGHT_700FONT_WEIGHT_800FONT_WEIGHT_900
- Returns:
- the font weight in string.
-
getFontVariant
public java.lang.String getFontVariant()
Returns the font variant in a string. The return value is defined inDesignChoiceConstantsand can be one of:FONT_VARIANT_NORMALFONT_VARIANT_SMALL_CAPS
- Returns:
- the font variant in a string.
-
getColor
public ColorHandle getColor()
Gets font color property.- Returns:
- font color property
-
getTextUnderline
public java.lang.String getTextUnderline()
Returns the value of the underline property. The returned value is defined inDesignChoiceConstantsand can be one of:TEXT_UNDERLINE_NONETEXT_UNDERLINE_UNDERLINE
- Returns:
- the value of the underline property
-
getTextOverline
public java.lang.String getTextOverline()
Returns the value of the overline property. The returned value is defined inDesignChoiceConstantsand can be one of:TEXT_OVERLINE_NONETEXT_OVERLINE_OVERLINE
- Returns:
- the value of the overline property
-
getTextLineThrough
public java.lang.String getTextLineThrough()
Returns the value of the line through property. The returned value is defined inDesignChoiceConstantsand can be one of:TEXT_LINE_THROUGH_NONETEXT_LINE_THROUGH_LINE_THROUGH
- Returns:
- the text line through
-
getTextAlign
public java.lang.String getTextAlign()
Returns the value of text align property. The return value is defined inDesignChoiceConstantsand can be one of:TEXT_ALIGN_LEFTTEXT_ALIGN_CENTERTEXT_ALIGN_RIGHTTEXT_ALIGN_JUSTIFY
- Returns:
- the value of text align property
-
getTextDirection
public java.lang.String getTextDirection()
Returns the value of direction property. The return value is defined inDesignChoiceConstantsand can be one of:BIDI_DIRECTION_LTRBIDI_DIRECTION_RTL
- Returns:
- the value of direction property
-
setTextDirection
public void setTextDirection(java.lang.String value) throws SemanticExceptionSets the Bidi direction property. The input value is defined inDesignChoiceConstantsand can be one of:BIDI_DIRECTION_LTRBIDI_DIRECTION_RTL
- Parameters:
value- the new direction value- Throws:
SemanticException- if the value is not one of the above.
-
getTextIndent
public DimensionHandle getTextIndent()
Gets text indent property.- Returns:
- text indent property
-
getTextTransform
public java.lang.String getTextTransform()
Returns the value of the text transform property. The return value is defined inDesignChoiceConstantsand can be one of:TRANSFORM_CAPITALIZETRANSFORM_UPPERCASETRANSFORM_LOWERCASETRANSFORM_NONE
- Returns:
- the value of the transform property
-
-