Interface IClasspathContainerPage

  • All Superinterfaces:
    IDialogPage, IWizardPage

    public interface IClasspathContainerPage
    extends IWizardPage
    A classpath container page allows the user to create a new or edit an existing classpath container entry.

    Clients should implement this interface and include the name of their class in an extension contributed to the jdt.ui's classpath container page extension point (named org.eclipse.jdt.ui.classpathContainerPage ).

    Clients implementing this interface may subclass from org.eclipse.jface.wizard.WizardPage.

    Clients implementing this interface may also implement IClasspathContainerPageExtension to get additional context before this page is opened.
    Since:
    2.0
    • Method Detail

      • finish

        boolean finish()
        Called when the classpath container wizard is closed by selecting the finish button. Implementers typically override this method to store the page result (new/changed classpath entry returned in getSelection) into its model.
        Returns:
        if the operation was successful. Only when returned true, the wizard will close.
      • getSelection

        IClasspathEntry getSelection()
        Returns the edited or created classpath container entry. This method may return null if no classpath container entry exists. The returned classpath entry is of kind IClasspathEntry.CPE_CONTAINER .
        Returns:
        the classpath entry edited or created on the page.
      • setSelection

        void setSelection​(IClasspathEntry containerEntry)
        Sets the classpath container entry to be edited or null if a new entry should be created.
        Parameters:
        containerEntry - the classpath entry to edit or null. If not null then the classpath entry must be of kind IClasspathEntry.CPE_CONTAINER