| java.lang.Object
 org.eclipse.ui.internal.registry.RegistryReader
org.eclipse.ui.internal.registry.WizardsRegistryReader
| WizardsRegistryReader | | public class WizardsRegistryReader extends RegistryReader (Code) | | Instances access the registry that is provided at creation time
in order to determine the contained Wizards
|
| Method Summary | |
| protected void | addNewElementToResult(WorkbenchWizardElement element, IConfigurationElement config)
| | protected boolean | areWizardsRead()
| | protected WizardCollectionElement | createCollectionElement(WizardCollectionElement parent, String id, String pluginId, String label)
Create and answer a new WizardCollectionElement, configured as a
child of parent
org.eclipse.ui.internal.model.WizardCollectionElement
Parameters:
parent - org.eclipse.ui.internal.model.WizardCollectionElement
Parameters:
id - the id of the new collection
Parameters:
pluginId - the originating plugin id of the collection, if any. | | protected void | createEmptyWizardCollection()
Creates empty element collection. | | protected WorkbenchWizardElement | createWizardElement(IConfigurationElement element)
Returns a new WorkbenchWizardElement configured according to the parameters
contained in the passed Registry. | | public WorkbenchWizardElement | findWizard(String id)
Returns the first wizard with a given id. | | protected String | getCategoryStringFor(IConfigurationElement config)
Return the appropriate category (tree location) for this Wizard. | | protected WizardCollectionElement | getChildWithID(WizardCollectionElement parent, String id)
Go through the children of the passed parent and answer the child
with the passed name. | | public WorkbenchWizardElement[] | getPrimaryWizards()
Returns the list of wizards that are considered 'primary'.
The return value for this method is cached since computing its value
requires non-trivial work. | | protected Object[] | getWizardCollectionElements()
| | public WizardCollectionElement | getWizardElements()
Returns a list of wizards, project and not.
The return value for this method is cached since computing its value
requires non-trivial work. | | protected void | moveElementToUncategorizedCategory(WizardCollectionElement root, WorkbenchWizardElement element)
Moves given element to "Other" category, previously creating one if missing. | | public boolean | readElement(IConfigurationElement element)
Implement this method to read element attributes. | | protected void | readWizards()
Reads the wizards in a registry. | | public void | setInitialCollection(WizardCollectionElement wizards)
Set the initial wizard set for supplemental reading via dynamic plugin loading. |
| FULL_EXAMPLES_WIZARD_CATEGORY | | final public static String FULL_EXAMPLES_WIZARD_CATEGORY(Code) | | Examples wizard category id
|
| GENERAL_WIZARD_CATEGORY | | final public static String GENERAL_WIZARD_CATEGORY(Code) | | General wizard category id
|
| UNCATEGORIZED_WIZARD_CATEGORY | | final public static String UNCATEGORIZED_WIZARD_CATEGORY(Code) | | Other wizard category id
|
| WizardsRegistryReader | | public WizardsRegistryReader(String pluginId, String pluginPointId)(Code) | | Create an instance of this class.
Parameters:
pluginId - the plugin id
Parameters:
pluginPointId - java.lang.String |
| areWizardsRead | | protected boolean areWizardsRead()(Code) | | Returns whether the wizards have been read already
|
| createCollectionElement | | protected WizardCollectionElement createCollectionElement(WizardCollectionElement parent, String id, String pluginId, String label)(Code) | | Create and answer a new WizardCollectionElement, configured as a
child of parent
org.eclipse.ui.internal.model.WizardCollectionElement
Parameters:
parent - org.eclipse.ui.internal.model.WizardCollectionElement
Parameters:
id - the id of the new collection
Parameters:
pluginId - the originating plugin id of the collection, if any. null otherwise.
Parameters:
label - java.lang.String |
| createEmptyWizardCollection | | protected void createEmptyWizardCollection()(Code) | | Creates empty element collection. Overrider to fill
initial elements, if needed.
|
| createWizardElement | | protected WorkbenchWizardElement createWizardElement(IConfigurationElement element)(Code) | | Returns a new WorkbenchWizardElement configured according to the parameters
contained in the passed Registry.
May answer null if there was not enough information in the Extension to create
an adequate wizard
|
| findWizard | | public WorkbenchWizardElement findWizard(String id)(Code) | | Returns the first wizard with a given id.
Parameters:
id - wizard id to search for WorkbenchWizardElement matching the given id, if found; null otherwise |
| getCategoryStringFor | | protected String getCategoryStringFor(IConfigurationElement config)(Code) | | Return the appropriate category (tree location) for this Wizard.
If a category is not specified then return a default one.
|
| getChildWithID | | protected WizardCollectionElement getChildWithID(WizardCollectionElement parent, String id)(Code) | | Go through the children of the passed parent and answer the child
with the passed name. If no such child is found then return null.
org.eclipse.ui.internal.model.WizardCollectionElement
Parameters:
parent - org.eclipse.ui.internal.model.WizardCollectionElement
Parameters:
id - java.lang.String |
| getPrimaryWizards | | public WorkbenchWizardElement[] getPrimaryWizards()(Code) | | Returns the list of wizards that are considered 'primary'.
The return value for this method is cached since computing its value
requires non-trivial work.
the primary wizards |
| getWizardCollectionElements | | protected Object[] getWizardCollectionElements()(Code) | | |
| getWizardElements | | public WizardCollectionElement getWizardElements()(Code) | | Returns a list of wizards, project and not.
The return value for this method is cached since computing its value
requires non-trivial work.
the wizard collection |
| readElement | | public boolean readElement(IConfigurationElement element)(Code) | | Implement this method to read element attributes.
|
| readWizards | | protected void readWizards()(Code) | | Reads the wizards in a registry.
This implementation uses a defering strategy. All of the elements
(categories, wizards) are read. The categories are created as the read occurs.
The wizards are just stored for later addition after the read completes.
This ensures that wizard categorization is performed after all categories
have been read.
|
| setInitialCollection | | public void setInitialCollection(WizardCollectionElement wizards)(Code) | | Set the initial wizard set for supplemental reading via dynamic plugin loading.
Parameters:
wizards - the wizards
since:
3.1 |
|
|