|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPathEntryContainerPage
A path container page allows the user to create a new or edit an existing patch container entry.
Clients should implement this interface and include the name of their
class in an extension contributed to the cdt.ui's path container page
extension point (named org.eclipse.cdt.ui.pathContainerPage
).
Clients implementing this interface may subclass from
org.eclipse.jface.wizard.WizardPage
.
Method Summary | |
---|---|
boolean |
finish()
Called when the path container wizard is closed by selecting the finish button. |
org.eclipse.cdt.core.model.IContainerEntry[] |
getNewContainers()
Method 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 interface org.eclipse.jface.wizard.IWizardPage |
---|
canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard |
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
---|
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible |
Method Detail |
---|
void initialize(org.eclipse.cdt.core.model.ICProject project, org.eclipse.cdt.core.model.IPathEntry[] currentEntries)
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.
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.boolean finish()
true
, the wizard will close.org.eclipse.cdt.core.model.IContainerEntry[] getNewContainers()
getNewContainers()
is called to get the the newly added containers.
void setSelection(org.eclipse.cdt.core.model.IContainerEntry containerEntry)
null
if a new entry should be created.
containerEntry
- the path entry to edit or null
.
If unequals null
then the path entry must be of
kind IPathEntry.CDT_CONTAINER
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |