Class RowHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.ITableRowModel

public class RowHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.ITableRowModel
Represents one row in a Grid or Table. Each row contains some number of cells. And one row can define its height.
See Also:
  • TableRow
  • Constructor Details

    • RowHandle

      public RowHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Constructs the handle for a row with the given design and element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
      Parameters:
      module - the module
      element - the model representation of the element
  • Method Details

    • getCells

      public SlotHandle getCells()
      Returns the cell slot of row. Through SlotHandle, each cell can be obtained.
      Returns:
      the handle to the cell slot
      See Also:
    • getHeight

      public DimensionHandle getHeight()
      Gets a handle to deal with the row's height.
      Returns:
      a DimensionHandle for the row's height.
    • getBookmark

      public String getBookmark()
      Returns the bookmark of this row.
      Returns:
      the bookmark of this row
    • setBookmark

      public void setBookmark(String value) throws SemanticException
      Sets the bookmark of this row.
      Parameters:
      value - the bookmark to set
      Throws:
      SemanticException - if the property is locked.
    • visibilityRulesIterator

      public Iterator visibilityRulesIterator()
      Returns visibility rules defined on the table row. The element in the iterator is the corresponding StructureHandle that deal with a Hide in the list.
      Returns:
      the iterator for visibility rules defined on this row.
      See Also:
    • getOnPrepare

      public String getOnPrepare()
      Gets the on-prepare script of the group. Startup phase. No data binding yet. The design of an element can be changed here.
      Returns:
      the on-prepare script of the group
    • getOnCreate

      public String getOnCreate()
      Gets the on-finish script of the group. Presentation phase. The report item has been read from the report document, but not sent to emitter yet.
      Returns:
      the on-finish script of the group
    • getOnRender

      public String getOnRender()
      Gets the on-finish script of the group. Presentation phase. The report item has been read from the report document, but not sent to emitter yet.
      Returns:
      the on-finish script of the group
    • setOnPrepare

      public void setOnPrepare(String script) throws SemanticException
      Sets the on-prepare script of the group element.
      Parameters:
      script - the script to set
      Throws:
      SemanticException - if the method is locked.
      See Also:
    • setOnCreate

      public void setOnCreate(String script) throws SemanticException
      Sets the on-create script of the group element.
      Parameters:
      script - the script to set
      Throws:
      SemanticException - if the method is locked.
      See Also:
    • setOnRender

      public void setOnRender(String script) throws SemanticException
      Sets the on-render script of the group element.
      Parameters:
      script - the script to set
      Throws:
      SemanticException - if the method is locked.
      See Also:
    • suppressDuplicates

      public boolean suppressDuplicates()
      Tests whether to suppress duplicates rows with same content.
      Returns:
      true if suppress duplicates rows with same content, otherwise false.
      See Also:
    • setSuppressDuplicates

      public void setSuppressDuplicates(boolean value) throws SemanticException
      Sets the flag whether to suppress duplicates rows with same content.
      Parameters:
      value - true if suppress duplicates rows with same content, otherwise false.
      Throws:
      SemanticException - If the expression is invalid.
      See Also:
    • repeatable

      public boolean repeatable()
      Gets repeatable value. This property is used to control the output of a row is repeated on every page or just once.
      Returns:
      the repeatable value.
    • setRepeatable

      public void setRepeatable(boolean repeatable) throws SemanticException
      Sets the repeatable value. This property is used to control the output of a row is repeated on every page or just once.
      Parameters:
      repeatable - the repeatable value.
      Throws:
      SemanticException - if this value is locked.
    • getBookmarkDisplayName

      public String getBookmarkDisplayName()
      Gets the display name of the bookmark.
      Returns:
      the display name of the bookmark.
    • setBookmarkDisplayName

      public void setBookmarkDisplayName(String bookmarkDisplayName) throws SemanticException
      Sets the display name of the bookmark.
      Parameters:
      bookmarkDisplayName - the display name of the bookmark to set
      Throws:
      SemanticException
    • getTagType

      public String getTagType()
      Returns the tag type of this label item.
      Returns:
      the tag type value
    • setTagType

      public void setTagType(String tagType) throws SemanticException
      Sets the tag type of this label item.
      Parameters:
      tag - type the tag type
      Throws:
      SemanticException - if the property is locked.
    • getLanguage

      public String getLanguage()
      Returns the language of this label item.
      Returns:
      the language
    • setLanguage

      public void setLanguage(String language) throws SemanticException
      Sets the language of this label item.
      Parameters:
      language - the language
      Throws:
      SemanticException - if the property is locked.