|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
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 | |
---|---|
static java.lang.String |
defaultTOCPrefixName
Default TOC style's prefix name. |
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
TOCHandle(DesignElementHandle element,
org.eclipse.birt.report.model.core.MemberRef ref)
Construct an handle to deal with the toc structure. |
Method Summary | |
---|---|
ColorHandle |
getBackgroundColor()
Gets back-ground-color property. |
ColorHandle |
getBorderBottomColor()
Gets border-bottom-width property. |
java.lang.String |
getBorderBottomStyle()
Returns the style of the border bottom line. |
DimensionHandle |
getBorderBottomWidth()
Gets border-bottom-width property. |
ColorHandle |
getBorderLeftColor()
Gets border-left-color property. |
java.lang.String |
getBorderLeftStyle()
Gets border-left-style property. |
DimensionHandle |
getBorderLeftWidth()
Gets border-left-width property. |
ColorHandle |
getBorderRightColor()
Gets border-right-color property. |
java.lang.String |
getBorderRightStyle()
Gets border-right-style property. |
DimensionHandle |
getBorderRightWidth()
Gets border-right-width property. |
ColorHandle |
getBorderTopColor()
Gets border-top-color property. |
java.lang.String |
getBorderTopStyle()
Gets border-top-style property. |
DimensionHandle |
getBorderTopWidth()
Gets border-top-width property. |
ColorHandle |
getColor()
Gets font color property. |
java.lang.String |
getDateTimeFormat()
Gets date time format property. |
java.lang.String |
getDateTimeFormatCategory()
Gets date time format category property. |
java.lang.String |
getExpression()
Gets expression of TOC. |
FontHandle |
getFontFamily()
Gets font family property. |
DimensionHandle |
getFontSize()
Gets font size property. |
java.lang.String |
getFontStyle()
Returns the font style handle for the style. |
java.lang.String |
getFontVariant()
Returns the font variant in a string. |
java.lang.String |
getFontWeight()
Returns the font weight of the highlight rule. |
java.lang.String |
getNumberAlign()
Gets number align property. |
java.lang.String |
getNumberFormat()
Gets number format property. |
java.lang.String |
getNumberFormatCategory()
Gets number format category property. |
PrivateStyleHandle |
getPrivateStyle()
Returns a handle to work with the style properties of toc element. |
java.lang.String |
getStringFormat()
Gets string format property. |
java.lang.String |
getStringFormatCategory()
Returns the category of a string format for a toc. |
java.lang.String |
getStyleName()
Gets style of TOC. |
java.lang.String |
getTextAlign()
Returns the value of text align property. |
java.lang.String |
getTextDirection()
Returns the value of direction property. |
DimensionHandle |
getTextIndent()
Gets text indent property. |
java.lang.String |
getTextLineThrough()
Returns the value of the line through property. |
java.lang.String |
getTextOverline()
Returns the value of the overline property. |
java.lang.String |
getTextTransform()
Returns the value of the text transform property. |
java.lang.String |
getTextUnderline()
Returns the value of the underline property. |
void |
setExpression(java.lang.String expression)
Sets expression of TOC. |
void |
setStyleName(java.lang.String styleName)
Sets style of TOC. |
void |
setTextDirection(java.lang.String value)
Sets the Bidi direction property. |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String defaultTOCPrefixName
Constructor Detail |
---|
public TOCHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
element
- the element that defined the action.ref
- reference to the toc property.Method Detail |
---|
public java.lang.String getExpression()
public void setExpression(java.lang.String expression) throws SemanticException
expression
- expression of TOC
SemanticException
- semantic exceptionpublic java.lang.String getStyleName()
public void setStyleName(java.lang.String styleName) throws SemanticException
styleName
- style name
SemanticException
public PrivateStyleHandle getPrivateStyle()
Note a key difference between this method and the
getStyle( )
method. This method returns a handle to the
this element. The getStyle( )
method returns a
handle to the shared style, if any, that this element references.
null
if this element does not have style
properties.public java.lang.String getBorderTopStyle()
public DimensionHandle getBorderTopWidth()
public ColorHandle getBorderTopColor()
public java.lang.String getBorderLeftStyle()
public DimensionHandle getBorderLeftWidth()
public ColorHandle getBorderLeftColor()
public java.lang.String getBorderBottomStyle()
DesignChoiceConstants
.
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
public DimensionHandle getBorderBottomWidth()
public ColorHandle getBorderBottomColor()
public java.lang.String getBorderRightStyle()
public DimensionHandle getBorderRightWidth()
public ColorHandle getBorderRightColor()
public ColorHandle getBackgroundColor()
public java.lang.String getDateTimeFormat()
public java.lang.String getDateTimeFormatCategory()
public java.lang.String getNumberFormat()
public java.lang.String getNumberFormatCategory()
public java.lang.String getNumberAlign()
public java.lang.String getStringFormat()
public java.lang.String getStringFormatCategory()
public FontHandle getFontFamily()
public DimensionHandle getFontSize()
public java.lang.String getFontStyle()
DesignChoiceConstants
and can be one of:
FONT_STYLE_NORMAL
FONT_STYLE_ITALIC
FONT_STYLE_OBLIQUE
public java.lang.String getFontWeight()
DesignChoiceConstants
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
public java.lang.String getFontVariant()
DesignChoiceConstants
and can be one of:
FONT_VARIANT_NORMAL
FONT_VARIANT_SMALL_CAPS
public ColorHandle getColor()
public java.lang.String getTextUnderline()
DesignChoiceConstants
and can be one of:
TEXT_UNDERLINE_NONE
TEXT_UNDERLINE_UNDERLINE
public java.lang.String getTextOverline()
DesignChoiceConstants
and can be one of:
TEXT_OVERLINE_NONE
TEXT_OVERLINE_OVERLINE
public java.lang.String getTextLineThrough()
DesignChoiceConstants
and can be one of:
TEXT_LINE_THROUGH_NONE
TEXT_LINE_THROUGH_LINE_THROUGH
public java.lang.String getTextAlign()
DesignChoiceConstants
and can be one of:
TEXT_ALIGN_LEFT
TEXT_ALIGN_CENTER
TEXT_ALIGN_RIGHT
TEXT_ALIGN_JUSTIFY
public java.lang.String getTextDirection()
DesignChoiceConstants
and can be one of:
BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
public void setTextDirection(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
BIDI_DIRECTION_LTR
BIDI_DIRECTION_RTL
value
- the new direction value
SemanticException
- if the value is not one of the above.public DimensionHandle getTextIndent()
public java.lang.String getTextTransform()
DesignChoiceConstants
and can be one of:
TRANSFORM_CAPITALIZE
TRANSFORM_UPPERCASE
TRANSFORM_LOWERCASE
TRANSFORM_NONE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |