Faceted Project Framework
Version 1.3

org.eclipse.wst.common.project.facet.ui
Interface IWizardContext


public interface IWizardContext

The interface exposed to the facet action wizard pages that allows them to gather information about the wizard state.

Author:
Konstantin Komissarchik

Method Summary
 IFacetedProject.Action getAction(IFacetedProject.Action.Type type, IProjectFacetVersion fv)
          Finds the action of specified type that applies to the specified facet, if such action exists.
 Set getActions()
          Returns the set of actions currently specified by the user.
 Object getConfig(IProjectFacetVersion fv, IFacetedProject.Action.Type type, String pjname)
          Do not use! This method is internal and will be removed.
 String getProjectName()
          Returns the name of the project that the wizard is operating on.
 Set getSelectedProjectFacets()
          Returns the set of facets currently selected in the wizard.
 boolean isProjectFacetSelected(IProjectFacetVersion fv)
          Determines whether the specified facet is currently selected in the wizard.
 

Method Detail

getProjectName

String getProjectName()
Returns the name of the project that the wizard is operating on. If the wizard is in the project creation mode, the project will not yet exist in the workspace.

Returns:
the name of the project that the wizard is operating on

getSelectedProjectFacets

Set getSelectedProjectFacets()
Returns the set of facets currently selected in the wizard. If the wizard is in the add/remove facets mode (vs. project creation), this method will return the set of facets currently installed in a project after being modified by the current set of actions.

Returns:
the set of facets currently selected in the wizard (element type: IProjectFacetVersion)

isProjectFacetSelected

boolean isProjectFacetSelected(IProjectFacetVersion fv)
Determines whether the specified facet is currently selected in the wizard. See getSelectedProjectFacets() for more information.

Parameters:
fv - the project facet version object
Returns:
true if an only if the provided project facet is currently selected in the wizard

getActions

Set getActions()
Returns the set of actions currently specified by the user.

Returns:
the set of actions currently specified by the user

getAction

IFacetedProject.Action getAction(IFacetedProject.Action.Type type,
                                 IProjectFacetVersion fv)
Finds the action of specified type that applies to the specified facet, if such action exists. If the wizard is in the add/remove facets mode (vs. project creation), you cannot depend on finding the install action for a required facet as that facet may have already been installed.

Parameters:
type - the action type
fv - the project facet version object
Returns:
the action object or null

getConfig

Object getConfig(IProjectFacetVersion fv,
                 IFacetedProject.Action.Type type,
                 String pjname)
                 throws CoreException
Do not use! This method is internal and will be removed.

Throws:
CoreException

Faceted Project Framework
Version 1.3

Copyright (c) 2008 BEA Systems, Inc. and others. All rights reserved.