Interface Wizard

  • All Known Implementing Classes:
    AbstractWizard

    public interface Wizard
    Things a Wizard needs to implement
    • Method Detail

      • start

        void start()
        Start the Wizard
      • getPages

        List<WizardPage> getPages()
        Provide a list of pages
        Returns:
      • getPageWidget

        com.google.gwt.user.client.ui.Widget getPageWidget​(int pageNumber)
        Return the widget for a particular page
        Parameters:
        pageNumber - The index of of the page
        Returns:
      • pageSelected

        void pageSelected​(int pageNumber)
        A page has been selected from the UI
        Parameters:
        pageNumber -
      • getTitle

        String getTitle()
        Provide a title
        Returns:
      • getPreferredHeight

        int getPreferredHeight()
        The preferred height of the page
        Returns:
      • getPreferredWidth

        int getPreferredWidth()
        The preferred width of the page
        Returns:
      • isComplete

        void isComplete​(org.uberfire.client.callbacks.Callback<Boolean> callback)
        Is the Wizard complete; i.e. has all the necessary information for all pages in the Wizard been captured. What constitutes necessary data is up to the Wizard implementation, but a login page might consider the User ID and Password as necessary.
        Parameters:
        callback - True if the page is complete
      • complete

        void complete()
        The Wizard has been completed
      • close

        void close()
        The Wizard has been closed