Class ListingHandle

  • All Implemented Interfaces:
    IReportItemMethodContext, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IInternalReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IListingElementModel, org.eclipse.birt.report.model.elements.interfaces.IReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel
    Direct Known Subclasses:
    ListHandle, TableHandle

    public abstract class ListingHandle
    extends ReportItemHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IListingElementModel
    Represents slots and common properties in the two list-oriented elements: table and list. A listing has on-start, on-row and on-finish script properties as well as detail, footer, groups and header slots.

    • The on-start script called before the first row is retrieved from the data set for this element. Called after the data set is open but before the header band is created.
    • The on-row script called for each row retrieved from the data set for this element, but before creating any content for that row.
    • The on-finish script called after the last row is read from the data set for this element, but before the footer band is created.
    See Also:
    ListingElement, SlotHandle
    • Constructor Detail

      • ListingHandle

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

      • getHeader

        public SlotHandle getHeader()
        Returns the header slot. The header slot represents subsections that print at the start of the listing.
        Returns:
        a handle to the header slot
      • getFooter

        public SlotHandle getFooter()
        Returns the footer slot. The footer slot represents subsections that print at the end of the listing.
        Returns:
        a handle to the footer slot
      • getDetail

        public SlotHandle getDetail()
        Returns the detail slot. The detail slot represents subsections that print for each row in the data set.
        Returns:
        a handle to the detail slot
      • getGroups

        public SlotHandle getGroups()
        Returns the group slot. The group slot represents the grouping levels within the report. Groups appear with the most general first, the most detailed last.
        Returns:
        a handle to the group slot
      • sortsIterator

        public java.util.Iterator sortsIterator()
        Returns the iterator for sort list defined on a table or list. The element in the iterator is the corresponding StructureHandle that deal with a SortKey in the list.
        Returns:
        the iterator for SortKey structure list defined on a table or list.
      • filtersIterator

        public java.util.Iterator<FilterConditionHandle> filtersIterator()
        Returns the iterator for filter list defined on a table or list. The element in the iterator is the corresponding StructureHandle that deal with a FilterCond in the list.
        Returns:
        the iterator for FilterCond structure list defined on a table or list.
      • getPageBreakInterval

        public int getPageBreakInterval()
        Returns the page break interval value
        Returns:
        the page break interval value
      • setPageBreakInterval

        public void setPageBreakInterval​(int pageBreakInterval)
                                  throws SemanticException
        Sets the page break interval value
        Parameters:
        pageBreakInterval - the page break interval
        Throws:
        SemanticException - if the parameter is not a valid integer
      • repeatHeader

        public boolean repeatHeader()
        Tests whether to repeat the headings at the top of each page.
        Returns:
        true if repeat the headings, otherwise false.
      • setRepeatHeader

        public void setRepeatHeader​(boolean value)
                             throws SemanticException
        Sets whether to repeat the headings at the top of each page.
        Parameters:
        value - true if repeat the headings, otherwise false.
        Throws:
        SemanticException - if the property is locked.
      • isSortByGroups

        public boolean isSortByGroups()
        Determines whether the result set of this element will be sorted by the group keys.
        Returns:
        true if sorted by the groups, otherwise false
      • setSortByGroups

        public void setSortByGroups​(boolean isSortByGroups)
                             throws SemanticException
        Sets whether the result set of this element will be sorted by the group keys.
        Parameters:
        isSortByGroups - true if sorted by the groups, otherwise false
        Throws:
        SemanticException - if the property is locked