Class ColumnHandle

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

    public class ColumnHandle
    extends ReportElementHandle
    implements org.eclipse.birt.report.model.elements.interfaces.ITableColumnModel
    Represents a column within a table. The application generally does not create column handles directly. Instead, it uses one of the navigation methods available on other element handles like: TableHandle.
    See Also:
    TableHandle.getColumns(), TableColumn
    • Constructor Detail

      • ColumnHandle

        public ColumnHandle​(org.eclipse.birt.report.model.core.Module module,
                            org.eclipse.birt.report.model.core.DesignElement element)
        Constructs a handle for the given design and a column 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 column element
    • Method Detail

      • getRepeatCount

        public int getRepeatCount()
        Returns the repeat count for this column. The repeat count is the number of contiguous table or grid columns described by this column definition. It simplifies the design because one column definition can describe a group of adjacent columns.
        Returns:
        the number of contiguous columns described by this column definition
      • setRepeatCount

        public void setRepeatCount​(int count)
                            throws SemanticException
        Sets the repeat count for this column.
        Parameters:
        count - the number of contiguous columns described by this column definition
        Throws:
        SemanticException - if the property is locked.
        See Also:
        getRepeatCount()
      • getWidth

        public DimensionHandle getWidth()
        Gets the column width as a dimension handle.
        Returns:
        a dimension handle to for the column width.
      • getAlignment

        @Deprecated
        public java.lang.String getAlignment()
        Deprecated.
        Gets the column alignment.
        Returns:
        the column alignment
      • suppressDuplicates

        public boolean suppressDuplicates()
        Get the suppress duplicates property of this column.
        Returns:
        a boolean value which indicates if this column is suppress duplicates.
      • setSuppressDuplicates

        public void setSuppressDuplicates​(boolean suppressDuplicates)
        Set the suppress duplicates property of this column.
        Parameters:
        suppressDuplicates - the suppress duplicates value.
      • visibilityRulesIterator

        public java.util.Iterator visibilityRulesIterator()
        Returns visibility rules defined on the table column. The element in the iterator is the corresponding StructureHandle that deal with a HideRuleHandle in the list.
        Returns:
        the iterator for visibility rules.
        See Also:
        HideRule
      • convertWidthToAbsoluteValue

        public void convertWidthToAbsoluteValue()
                                         throws SemanticException
        Converts width of the column to an absolute value if possible.
        Throws:
        SemanticException