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 Details

  • Constructor Details

    • TOC

      public TOC()
  • Method Details

    • handle

      protected StructureHandle handle(SimpleValueHandle valueHandle, int index)
      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 class org.eclipse.birt.report.model.core.Structure
      Parameters:
      valueHandle - the value handle of this structure list property this structure is in
      index - the position of this structure in structure list
      Returns:
      the handle of this structure.
    • getHandle

      public StructureHandle getHandle(SimpleValueHandle valueHandle)
      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 class org.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

      public 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 String toString()
      Overrides:
      toString in class Object
    • getIntrinsicProperty

      protected Object getIntrinsicProperty(String propName)
      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 class org.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

      protected void setIntrinsicProperty(String propName, Object value)
      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 class org.eclipse.birt.report.model.core.PropertyStructure
      Parameters:
      propName - the name of the property to set
      value - the property value
    • setExpression

      public void setExpression(String expression) throws SemanticException
      Sets toc expression.
      Parameters:
      expression - toc expression
      Throws:
      SemanticException
    • getExpression

      public String getExpression()
      Gets toc expression.
      Returns:
      toc expression