Class TOC
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.TOC
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
public class TOC
extends org.eclipse.birt.report.model.core.PropertyStructure
The TOC structure defines a TOC. TOC is table of content.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
TOC expression.static final String
Name of this structure.static final String
TOC style.Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure
propValues
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets toc expression.getHandle
(SimpleValueHandle valueHandle) Gets the specific handle of this structure.protected Object
getIntrinsicProperty
(String propName) Returns the value of a structure property represented as a member variable.Returns the name of the structure definition.protected StructureHandle
handle
(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.void
setExpression
(String expression) Sets toc expression.protected void
setIntrinsicProperty
(String propName, Object value) Sets the value of of a structure property represented as a member variable.toString()
Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure
clone, getLocalProperty, getLocalProperty, setProperty
Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference, validate
-
Field Details
-
TOC_STRUCT
Name of this structure.- See Also:
-
TOC_EXPRESSION
TOC expression.- See Also:
-
TOC_STYLE
TOC style.- See Also:
-
BORDER_TOP_STYLE_MEMBER
- See Also:
-
BORDER_TOP_WIDTH_MEMBER
- See Also:
-
BORDER_TOP_COLOR_MEMBER
- See Also:
-
BORDER_LEFT_STYLE_MEMBER
- See Also:
-
BORDER_LEFT_WIDTH_MEMBER
- See Also:
-
BORDER_LEFT_COLOR_MEMBER
- See Also:
-
BORDER_BOTTOM_STYLE_MEMBER
- See Also:
-
BORDER_BOTTOM_WIDTH_MEMBER
- See Also:
-
BORDER_BOTTOM_COLOR_MEMBER
- See Also:
-
BORDER_RIGHT_STYLE_MEMBER
- See Also:
-
BORDER_RIGHT_WIDTH_MEMBER
- See Also:
-
BORDER_RIGHT_COLOR_MEMBER
- See Also:
-
BACKGROUND_COLOR_MEMBER
- See Also:
-
DATE_TIME_FORMAT_MEMBER
- See Also:
-
NUMBER_FORMAT_MEMBER
- See Also:
-
NUMBER_ALIGN_MEMBER
- See Also:
-
STRING_FORMAT_MEMBER
- See Also:
-
FONT_FAMILY_MEMBER
- See Also:
-
FONT_SIZE_MEMBER
- See Also:
-
FONT_STYLE_MEMBER
- See Also:
-
FONT_WEIGHT_MEMBER
- See Also:
-
FONT_VARIANT_MEMBER
- See Also:
-
COLOR_MEMBER
- See Also:
-
TEXT_UNDERLINE_MEMBER
- See Also:
-
TEXT_OVERLINE_MEMBER
- See Also:
-
TEXT_LINE_THROUGH_MEMBER
- See Also:
-
TEXT_ALIGN_MEMBER
- See Also:
-
TEXT_TRANSFORM_MEMBER
- See Also:
-
TEXT_INDENT_MEMBER
- See Also:
-
TEXT_DIRECTION_MEMBER
- See Also:
-
-
Constructor Details
-
TOC
public TOC()
-
-
Method Details
-
handle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.- Specified by:
handle
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
valueHandle
- the value handle of this structure list property this structure is inindex
- the position of this structure in structure list- Returns:
- the handle of this structure.
-
getHandle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Gets the specific handle of this structure. This structure must be in the element's structure list. The structure handle is transient because the position in the structure list is kept. The position changes if any structure is added, or dropped. So this handle should not be kept.- Overrides:
getHandle
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
valueHandle
- the value handle of this structure list property this structure is in- Returns:
- the handle of this structure. If this structure is not in the
valueHandle
,null
is returned.
-
getStructName
Description copied from interface:IStructure
Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
toString
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.- Overrides:
getIntrinsicProperty
in classorg.eclipse.birt.report.model.core.PropertyStructure
- Parameters:
propName
- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.- Overrides:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.PropertyStructure
- Parameters:
propName
- the name of the property to setvalue
- the property value
-
setExpression
Sets toc expression.- Parameters:
expression
- toc expression- Throws:
SemanticException
-
getExpression
Gets toc expression.- Returns:
- toc expression
-