org.eclipse.cdt.internal.ui.dialogs.cpaths
Class CPathContainerDefaultPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.wizard.WizardPage
          extended by org.eclipse.cdt.internal.ui.wizards.NewElementWizardPage
              extended by org.eclipse.cdt.internal.ui.dialogs.cpaths.CPathContainerDefaultPage
All Implemented Interfaces:
IPathEntryContainerPage, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

public class CPathContainerDefaultPage
extends NewElementWizardPage
implements IPathEntryContainerPage


Field Summary
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
CPathContainerDefaultPage()
          Constructor for ClasspathContainerDefaultPage.
 
Method Summary
 void createControl(org.eclipse.swt.widgets.Composite parent)
           
 boolean finish()
          Called when the path container wizard is closed by selecting the finish button.
 org.eclipse.cdt.core.model.IContainerEntry[] getNewContainers()
          Method IPathEntryContainerPage.getNewContainers() is called to get the the newly added containers.
 void initialize(org.eclipse.cdt.core.model.ICProject project, org.eclipse.cdt.core.model.IPathEntry[] currentEntries)
          Method initialize() is called before ICPathContainerPage.setSelection to give additional information about the context the path container entry is configured in.
 void setSelection(org.eclipse.cdt.core.model.IContainerEntry containerEntry)
          Sets the path container entry to be edited or null if a new entry should be created.
 
Methods inherited from class org.eclipse.cdt.internal.ui.wizards.NewElementWizardPage
setVisible
 
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
dispose, getControl, getDescription, getErrorMessage, getMessage, getMessageType, getTitle, performHelp, setMessage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.wizard.IWizardPage
canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
 

Constructor Detail

CPathContainerDefaultPage

public CPathContainerDefaultPage()
Constructor for ClasspathContainerDefaultPage.

Method Detail

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)
Specified by:
createControl in interface org.eclipse.jface.dialogs.IDialogPage

finish

public boolean finish()
Description copied from interface: IPathEntryContainerPage
Called when the path container wizard is closed by selecting the finish button. Implementers typically override this method to store the page result (new/changed path entry returned in getSelection) into its model.

Specified by:
finish in interface IPathEntryContainerPage
Returns:
if the operation was succesful. Only when returned true, the wizard will close.

getNewContainers

public org.eclipse.cdt.core.model.IContainerEntry[] getNewContainers()
Description copied from interface: IPathEntryContainerPage
Method IPathEntryContainerPage.getNewContainers() is called to get the the newly added containers.

Specified by:
getNewContainers in interface IPathEntryContainerPage
Returns:
the path entries created on this page.

initialize

public void initialize(org.eclipse.cdt.core.model.ICProject project,
                       org.eclipse.cdt.core.model.IPathEntry[] currentEntries)
Description copied from interface: IPathEntryContainerPage
Method initialize() is called before ICPathContainerPage.setSelection to give additional information about the context the path container entry is configured in. This information only reflects the underlying dialogs current selection state. The user still can make changes after the the path container pages has been closed or decide to cancel the operation.

Specified by:
initialize in interface IPathEntryContainerPage
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 path entries currently selected to be set as the projects path. This can also include the entry to be edited.

setSelection

public void setSelection(org.eclipse.cdt.core.model.IContainerEntry containerEntry)
Description copied from interface: IPathEntryContainerPage
Sets the path container entry to be edited or null if a new entry should be created.

Specified by:
setSelection in interface IPathEntryContainerPage
Parameters:
containerEntry - the path entry to edit or null. If unequals null then the path entry must be of kind IPathEntry.CDT_CONTAINER