Class IzClasspathContainerPage

  • All Implemented Interfaces:
    org.eclipse.jdt.ui.wizards.IClasspathContainerPage, org.eclipse.jdt.ui.wizards.IClasspathContainerPageExtension, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

    public class IzClasspathContainerPage
    extends org.eclipse.jface.wizard.WizardPage
    implements org.eclipse.jdt.ui.wizards.IClasspathContainerPage, org.eclipse.jdt.ui.wizards.IClasspathContainerPageExtension
    The iizi classpath container page allows the user to create a new or edit an existing classpath container entry.

    Clients implementing this interface may also implement IClasspathContainerPageExtension to get additional context before this page is opened.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ID
      The page ID.
      • Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

        ERROR, INFORMATION, NONE, WARNING
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void createControl​(org.eclipse.swt.widgets.Composite parent)
      Create contents of the wizard.
      boolean finish()
      Called when the classpath container wizard is closed by selecting the finish button.
      org.eclipse.jdt.core.IClasspathEntry getSelection()
      Returns the edited or created classpath container entry.
      void initialize​(org.eclipse.jdt.core.IJavaProject project, org.eclipse.jdt.core.IClasspathEntry[] currentEntries)
      Method initialize() is called before IClasspathContainerPage.setSelection to give additional information about the context the classpath container entry is configured in.
      void setSelection​(org.eclipse.jdt.core.IClasspathEntry containerEntry)
      Sets the classpath container entry to be edited or null if a new entry should be created.
      • Methods inherited from class org.eclipse.jface.wizard.WizardPage

        canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
      • Methods inherited from class org.eclipse.jface.dialogs.DialogPage

        convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

        dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
      • Methods inherited from interface org.eclipse.jface.wizard.IWizardPage

        canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard
    • Constructor Detail

      • IzClasspathContainerPage

        public IzClasspathContainerPage()
        Constructor.
    • Method Detail

      • initialize

        public void initialize​(org.eclipse.jdt.core.IJavaProject project,
                               org.eclipse.jdt.core.IClasspathEntry[] currentEntries)
        Method initialize() is called before IClasspathContainerPage.setSelection to give additional information about the context the classpath container entry is configured in. This information only reflects the underlying dialogs current selection state. The user still can make changes after the the classpath container pages has been closed or decide to cancel the operation.
        Specified by:
        initialize in interface org.eclipse.jdt.ui.wizards.IClasspathContainerPageExtension
        Parameters:
        project - The project the new or modified entry is added to. The project does not have to exist. Project can be null.
        currentEntries - The class path entries currently selected to be set as the projects classpath. This can also include the entry to be edited.
      • setSelection

        public void setSelection​(org.eclipse.jdt.core.IClasspathEntry containerEntry)
        Sets the classpath container entry to be edited or null if a new entry should be created.
        Specified by:
        setSelection in interface org.eclipse.jdt.ui.wizards.IClasspathContainerPage
        Parameters:
        containerEntry - The classpath entry to edit or null. If not null then the classpath entry must be of kind IClasspathEntry.CPE_CONTAINER
      • getSelection

        public org.eclipse.jdt.core.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 .
        Specified by:
        getSelection in interface org.eclipse.jdt.ui.wizards.IClasspathContainerPage
        Returns:
        the classpath entry edited or created on the page.
      • createControl

        public void createControl​(org.eclipse.swt.widgets.Composite parent)
        Create contents of the wizard.
        Specified by:
        createControl in interface org.eclipse.jface.dialogs.IDialogPage
      • finish

        public 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. As this is not the case for iizi, nothing is done here bt to return true.

        Specified by:
        finish in interface org.eclipse.jdt.ui.wizards.IClasspathContainerPage
        Returns:
        As the operation was successful. Only when returned true, the wizard will close.