Class MultiViewsHandle

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

    public class MultiViewsHandle
    extends DesignElementHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IMultiViewsModel
    Represents a multiple view element. A view element can contains multiple report items. The container of the view can use inner report items to represents its appearance.
    • Field Detail

      • HOST

        public static final int HOST
        Represents the container of the view does not use any inner view.
        See Also:
        Constant Field Values
      • element

        protected org.eclipse.birt.report.model.elements.AbstractMultiViews element
        The target report element.
    • Constructor Detail

      • MultiViewsHandle

        public MultiViewsHandle​(org.eclipse.birt.report.model.core.Module module,
                                org.eclipse.birt.report.model.elements.AbstractMultiViews element)
        Constructs a handle for the given design and design 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

      • getElement

        public org.eclipse.birt.report.model.core.DesignElement getElement()
        Description copied from class: DesignElementHandle
        Returns the element to which this handle is attached.
        Returns:
        The attached element. Will be null if the handle is not attached.
      • getViews

        protected java.util.List getViews()
        Returns a list containing views.
        Returns:
        a list containing views. Each item is an ReportItemHandle.
      • getCurrentView

        public DesignElementHandle getCurrentView()
        Returns the view that is being used.
        Returns:
        the view that is being used
      • setCurrentViewIndex

        public void setCurrentViewIndex​(int index)
                                 throws SemanticException
        Sets the index for the view to be used.
        Parameters:
        index - a 0-based integer
        Throws:
        SemanticException
      • dropView

        public void dropView​(DesignElementHandle viewElement)
                      throws SemanticException
        Deletes the given view. If the given element was named as the current view, this method also set the current view to HOST.
        Parameters:
        viewElement - the view element
        Throws:
        SemanticException
      • getCurrentViewIndex

        public int getCurrentViewIndex()
        Returns the index for the current view.
        Returns:
        a 0-based integer