Class ScrolledPageBook

  • All Implemented Interfaces:
    Drawable

    public class ScrolledPageBook
    extends SharedScrolledComposite
    ScrolledPageBook is a class that is capable of stacking several composites (pages), while showing one at a time. The content is scrolled if there is not enough space to fit it in the client area.
    Since:
    3.0
    • Constructor Detail

      • ScrolledPageBook

        public ScrolledPageBook​(Composite parent)
        Creates a new instance in the provided parent
        Parameters:
        parent -
      • ScrolledPageBook

        public ScrolledPageBook​(Composite parent,
                                int style)
        Creates a new instance in the provided parent and with the provided style.
        Parameters:
        parent - the control parent
        style - the style to use
    • Method Detail

      • hasPage

        public boolean hasPage​(Object key)
        Tests if the page under the provided key is currently in the book.
        Parameters:
        key - the page key
        Returns:
        true if page exists, false otherwise.
      • createPage

        public Composite createPage​(Object key)
        Creates a new page for the provided key. Use the returned composite to create children in it.
        Parameters:
        key - the page key
        Returns:
        the newly created page composite
      • getContainer

        public Composite getContainer()
        Returns the page book container.
        Returns:
        the page book container
      • registerPage

        public void registerPage​(Object key,
                                 Control page)
        Registers a page under the privided key to be managed by the page book. The page must be a direct child of the page book container.
        Parameters:
        key - the page key
        page - the page composite to register
        See Also:
        createPage(Object), getContainer()
      • removePage

        public void removePage​(Object key)
        Removes the page under the provided key from the page book. Does nothing if page with that key does not exist.
        Parameters:
        key - the page key.
      • removePage

        public void removePage​(Object key,
                               boolean showEmptyPage)
        Removes the page under the provided key from the page book. Does nothing if page with that key does not exist.
        Parameters:
        key - the page key.
        showEmptyPage - if true, shows the empty page after page removal.
      • showPage

        public void showPage​(Object key)
        Shows the page with the provided key and hides the page previously showing. Does nothing if the page with that key does not exist.
        Parameters:
        key - the page key
      • showEmptyPage

        public void showEmptyPage()
        Shows a page with no children to be used if the desire is to not show any registered page.
      • getCurrentPage

        public Control getCurrentPage()
        Returns the page currently showing.
        Returns:
        the current page