Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.elements.structures
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:
  java.lang.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
`static java.lang.String` | `BACKGROUND_COLOR_MEMBER`
`static java.lang.String` | `BORDER_BOTTOM_COLOR_MEMBER`
`static java.lang.String` | `BORDER_BOTTOM_STYLE_MEMBER`
`static java.lang.String` | `BORDER_BOTTOM_WIDTH_MEMBER`
`static java.lang.String` | `BORDER_LEFT_COLOR_MEMBER`
`static java.lang.String` | `BORDER_LEFT_STYLE_MEMBER`
`static java.lang.String` | `BORDER_LEFT_WIDTH_MEMBER`
`static java.lang.String` | `BORDER_RIGHT_COLOR_MEMBER`
`static java.lang.String` | `BORDER_RIGHT_STYLE_MEMBER`
`static java.lang.String` | `BORDER_RIGHT_WIDTH_MEMBER`
`static java.lang.String` | `BORDER_TOP_COLOR_MEMBER`
`static java.lang.String` | `BORDER_TOP_STYLE_MEMBER`
`static java.lang.String` | `BORDER_TOP_WIDTH_MEMBER`
`static java.lang.String` | `COLOR_MEMBER`
`static java.lang.String` | `DATE_TIME_FORMAT_MEMBER`
`static java.lang.String` | `FONT_FAMILY_MEMBER`
`static java.lang.String` | `FONT_SIZE_MEMBER`
`static java.lang.String` | `FONT_STYLE_MEMBER`
`static java.lang.String` | `FONT_VARIANT_MEMBER`
`static java.lang.String` | `FONT_WEIGHT_MEMBER`
`static java.lang.String` | `NUMBER_ALIGN_MEMBER`
`static java.lang.String` | `NUMBER_FORMAT_MEMBER`
`static java.lang.String` | `STRING_FORMAT_MEMBER`
`static java.lang.String` | `TEXT_ALIGN_MEMBER`
`static java.lang.String` | `TEXT_DIRECTION_MEMBER`
`static java.lang.String` | `TEXT_INDENT_MEMBER`
`static java.lang.String` | `TEXT_LINE_THROUGH_MEMBER`
`static java.lang.String` | `TEXT_OVERLINE_MEMBER`
`static java.lang.String` | `TEXT_TRANSFORM_MEMBER`
`static java.lang.String` | `TEXT_UNDERLINE_MEMBER`
`static java.lang.String` | `TOC_EXPRESSION` TOC expression.
`static java.lang.String` | `TOC_STRUCT` Name of this structure.
`static java.lang.String` | `TOC_STYLE` TOC style.

Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure
`propValues`

Constructor Summary
`TOC()`

Method Summary
`java.lang.String` | `getExpression()` Gets toc expression.
`StructureHandle` | `getHandle(SimpleValueHandle valueHandle)`
`protected java.lang.Object` | `getIntrinsicProperty(java.lang.String propName)`
`java.lang.String` | `getStructName()` Returns the name of the structure definition.
`protected StructureHandle` | `handle(SimpleValueHandle valueHandle, int index)`
`void` | `setExpression(java.lang.String expression)` Sets toc expression.
`protected void` | `setIntrinsicProperty(java.lang.String propName, java.lang.Object value)`
`java.lang.String` | `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
`copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference, validate`

Methods inherited from class java.lang.Object
`finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### TOC_STRUCT

    public static final java.lang.String TOC_STRUCT

  Name of this structure.

  See Also:
    Constant Field Values

### TOC_EXPRESSION

    public static final java.lang.String TOC_EXPRESSION

  TOC expression.

  See Also:
    Constant Field Values

### TOC_STYLE

    public static final java.lang.String TOC_STYLE

  TOC style.

  See Also:
    Constant Field Values

### BORDER_TOP_STYLE_MEMBER

    public static final java.lang.String BORDER_TOP_STYLE_MEMBER

See Also:
  Constant Field Values

### BORDER_TOP_WIDTH_MEMBER

    public static final java.lang.String BORDER_TOP_WIDTH_MEMBER

See Also:
  Constant Field Values

### BORDER_TOP_COLOR_MEMBER

    public static final java.lang.String BORDER_TOP_COLOR_MEMBER

See Also:
  Constant Field Values

### BORDER_LEFT_STYLE_MEMBER

    public static final java.lang.String BORDER_LEFT_STYLE_MEMBER

See Also:
  Constant Field Values

### BORDER_LEFT_WIDTH_MEMBER

    public static final java.lang.String BORDER_LEFT_WIDTH_MEMBER

See Also:
  Constant Field Values

### BORDER_LEFT_COLOR_MEMBER

    public static final java.lang.String BORDER_LEFT_COLOR_MEMBER

See Also:
  Constant Field Values

### BORDER_BOTTOM_STYLE_MEMBER

    public static final java.lang.String BORDER_BOTTOM_STYLE_MEMBER

See Also:
  Constant Field Values

### BORDER_BOTTOM_WIDTH_MEMBER

    public static final java.lang.String BORDER_BOTTOM_WIDTH_MEMBER

See Also:
  Constant Field Values

### BORDER_BOTTOM_COLOR_MEMBER

    public static final java.lang.String BORDER_BOTTOM_COLOR_MEMBER

See Also:
  Constant Field Values

### BORDER_RIGHT_STYLE_MEMBER

    public static final java.lang.String BORDER_RIGHT_STYLE_MEMBER

See Also:
  Constant Field Values

### BORDER_RIGHT_WIDTH_MEMBER

    public static final java.lang.String BORDER_RIGHT_WIDTH_MEMBER

See Also:
  Constant Field Values

### BORDER_RIGHT_COLOR_MEMBER

    public static final java.lang.String BORDER_RIGHT_COLOR_MEMBER

See Also:
  Constant Field Values

### BACKGROUND_COLOR_MEMBER

    public static final java.lang.String BACKGROUND_COLOR_MEMBER

See Also:
  Constant Field Values

### DATE_TIME_FORMAT_MEMBER

    public static final java.lang.String DATE_TIME_FORMAT_MEMBER

See Also:
  Constant Field Values

### NUMBER_FORMAT_MEMBER

    public static final java.lang.String NUMBER_FORMAT_MEMBER

See Also:
  Constant Field Values

### NUMBER_ALIGN_MEMBER

    public static final java.lang.String NUMBER_ALIGN_MEMBER

See Also:
  Constant Field Values

### STRING_FORMAT_MEMBER

    public static final java.lang.String STRING_FORMAT_MEMBER

See Also:
  Constant Field Values

### FONT_FAMILY_MEMBER

    public static final java.lang.String FONT_FAMILY_MEMBER

See Also:
  Constant Field Values

### FONT_SIZE_MEMBER

    public static final java.lang.String FONT_SIZE_MEMBER

See Also:
  Constant Field Values

### FONT_STYLE_MEMBER

    public static final java.lang.String FONT_STYLE_MEMBER

See Also:
  Constant Field Values

### FONT_WEIGHT_MEMBER

    public static final java.lang.String FONT_WEIGHT_MEMBER

See Also:
  Constant Field Values

### FONT_VARIANT_MEMBER

    public static final java.lang.String FONT_VARIANT_MEMBER

See Also:
  Constant Field Values

### COLOR_MEMBER

    public static final java.lang.String COLOR_MEMBER

See Also:
  Constant Field Values

### TEXT_UNDERLINE_MEMBER

    public static final java.lang.String TEXT_UNDERLINE_MEMBER

See Also:
  Constant Field Values

### TEXT_OVERLINE_MEMBER

    public static final java.lang.String TEXT_OVERLINE_MEMBER

See Also:
  Constant Field Values

### TEXT_LINE_THROUGH_MEMBER

    public static final java.lang.String TEXT_LINE_THROUGH_MEMBER

See Also:
  Constant Field Values

### TEXT_ALIGN_MEMBER

    public static final java.lang.String TEXT_ALIGN_MEMBER

See Also:
  Constant Field Values

### TEXT_TRANSFORM_MEMBER

    public static final java.lang.String TEXT_TRANSFORM_MEMBER

See Also:
  Constant Field Values

### TEXT_INDENT_MEMBER

    public static final java.lang.String TEXT_INDENT_MEMBER

See Also:
  Constant Field Values

### TEXT_DIRECTION_MEMBER

    public static final java.lang.String TEXT_DIRECTION_MEMBER

See Also:
  Constant Field Values

Constructor Detail

### TOC

    public TOC()

Method Detail

### handle

    protected StructureHandle handle(SimpleValueHandle valueHandle,
                                     int index)

  Specified by:
    `handle` in class `org.eclipse.birt.report.model.core.Structure`

### getHandle

    public StructureHandle getHandle(SimpleValueHandle valueHandle)

  Overrides:
    `getHandle` in class `org.eclipse.birt.report.model.core.Structure`

### getStructName

    public java.lang.String 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

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`

### getIntrinsicProperty

    protected java.lang.Object getIntrinsicProperty(java.lang.String propName)

  Overrides:
    `getIntrinsicProperty` in class `org.eclipse.birt.report.model.core.PropertyStructure`

### setIntrinsicProperty

    protected void setIntrinsicProperty(java.lang.String propName,
                                        java.lang.Object value)

  Overrides:
    `setIntrinsicProperty` in class `org.eclipse.birt.report.model.core.PropertyStructure`

### setExpression

    public void setExpression(java.lang.String expression)
                       throws SemanticException

  Sets toc expression.

  Parameters:
    `expression` - toc expression
  Throws:
    `SemanticException`

### getExpression

    public java.lang.String getExpression()

  Gets toc expression.

  Returns:
    toc expression

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.