Package org.esa.snap.ui.assistant

Interface AssistantPage

All Known Implementing Classes:
AbstractAssistantPage, AbstractLayerSourceAssistantPage, CollectionLayerAssistantPage, SelectLayerSourceAssistantPage
public interface AssistantPage
An AssistantPage is part of a sequence of pages.
It is used by an AssistantPane to assists the user to accomplish a specific task by stepping through the pages.

  • Method Details

    • getPageTitle

      String getPageTitle()
      Gets the title of the page.
      Returns:
      The page title.

    • getPageComponent

      Component getPageComponent()
      Gets the component of the page.
      Returns:
      The page component.

    • hasNextPage

      boolean hasNextPage()
      Returns:
      true, if a next page is available

    • getNextPage

      AssistantPage getNextPage()
      Called only if validatePage() and hasNextPage() return true.
      Returns:
      the next page, or null if no next page exists or the page could not be created.

    • validatePage

      boolean validatePage()
      Called from AssistantPageContext.updateState() in order to validate user inputs.
      Returns:
      true, if the current page is valid

    • canFinish

      boolean canFinish()
      Determines if the page can finish the current assitant or not.
      Returns:
      true if the page can perform finish, otherwise false

    • performFinish

      boolean performFinish()
      Ccalled only if validatePage() and canFinish() return true.
      Returns:
      true if finishing was successful, otherwise false.

    • performCancel

      void performCancel()
      Cancels the current execution of the assitant. Implementors shall release allocated resources.

    • canHelp

      boolean canHelp()
      Determines if the page can show help information.
      Returns:
      true if the page can show help information, otherwise false

    • performHelp

      void performHelp()
      Only called if @link #canHelp ()} returns true.

    • setContext

      void setContext(AssistantPageContext pageContext)
      Sets the current context for this page.
      Parameters:
      pageContext - The context of the page.

    • getContext

      AssistantPageContext getContext()
      Gets the current context for this page.
      Returns:
      The context of the page.