| java.lang.Object
 org.eclipse.ui.internal.cheatsheets.registry.RegistryReader
org.eclipse.ui.internal.cheatsheets.registry.CheatSheetRegistryReader
| CheatSheetRegistryReader | | public class CheatSheetRegistryReader extends RegistryReader implements IRegistryChangeListener(Code) | | Instances access the registry that is provided at creation time
in order to determine the contained CheatSheet Contents
|
| Inner Class :public class TaskEditorNode | |
| Inner Class :public class TaskExplorerNode | |
| Method Summary | |
| protected void | addNewElementToResult(CheatSheetElement element, IConfigurationElement config, AdaptableList result)
Adds new cheatsheet to the provided collection. | | protected CheatSheetElement | createCheatSheetElement(IConfigurationElement element)
Returns a new CheatSheetElement configured according to the parameters
contained in the passed Registry. | | protected CheatSheetCollectionElement | createCollectionElement(CheatSheetCollectionElement parent, String pluginId, String id, String label)
| | protected AdaptableList | createEmptyCheatSheetCollection()
Creates empty element collection. | | public CheatSheetElement | findCheatSheet(String id)
Returns the first cheatsheet
with a given id. | | public TaskEditorNode | findTaskEditor(String id)
Returns the first task editor
with a given id. | | public TaskExplorerNode | findTaskExplorer(String id)
Returns the first task explorer
with a given id. | | protected String | getCategoryStringFor(IConfigurationElement config)
Return the appropriate category (tree location) for this CheatSheet. | | public AdaptableList | getCheatSheets()
Returns a list of cheatsheets, project and not.
The return value for this method is cached since computing its value
requires non-trivial work. | | protected CheatSheetCollectionElement | getChildWithID(CheatSheetCollectionElement parent, String id)
Go through the children of the passed parent and answer the child
with the passed name. | | public String[] | getExplorerIds()
| | public static CheatSheetRegistryReader | getInstance()
Returns a list of cheatsheets, project and not.
The return value for this method is cached since computing its value
requires non-trivial work. | | protected boolean | initializeCheatSheet(CheatSheetElement element, IConfigurationElement config)
Initialize the passed element's properties based on the contents of
the passed registry. | | protected void | moveElementToUncategorizedCategory(CheatSheetCollectionElement root, CheatSheetElement element)
Moves given element to "Other" category, previously creating one if missing. | | protected void | readCheatSheets()
Reads the cheatsheets in a registry. | | protected boolean | readElement(IConfigurationElement element)
Implement this method to read element attributes. | | public ArrayList | readItemExtensions()
| | public void | registryChanged(IRegistryChangeEvent event)
| | public void | stop()
|
| ATT_CONTENTFILE | | final public static String ATT_CONTENTFILE(Code) | | |
| ATT_LISTENERCLASS | | final protected static String ATT_LISTENERCLASS(Code) | | |
| CHEAT_SHEET_CONTENT | | final public static String CHEAT_SHEET_CONTENT(Code) | | |
| TAG_CHEATSHEET | | final public static String TAG_CHEATSHEET(Code) | | |
| TAG_ITEM_EXTENSION | | final protected static String TAG_ITEM_EXTENSION(Code) | | |
| TAG_TASK_EDITOR | | final protected static String TAG_TASK_EDITOR(Code) | | |
| TAG_TASK_EXPLORER | | final protected static String TAG_TASK_EXPLORER(Code) | | |
| cheatsheets | | protected AdaptableList cheatsheets(Code) | | |
| taskExplorers | | protected Map taskExplorers(Code) | | |
| addNewElementToResult | | protected void addNewElementToResult(CheatSheetElement element, IConfigurationElement config, AdaptableList result)(Code) | | Adds new cheatsheet to the provided collection. Override to
provide more logic.
This implementation uses a defering strategy. For more info see
readCheatSheets.
|
| createCheatSheetElement | | protected CheatSheetElement createCheatSheetElement(IConfigurationElement element)(Code) | | Returns a new CheatSheetElement 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 cheatsheet
|
| createCollectionElement | | protected CheatSheetCollectionElement createCollectionElement(CheatSheetCollectionElement parent, String pluginId, String id, String label)(Code) | | Create and answer a new CheatSheetCollectionElement, configured as a
child of parent
org.eclipse.ui.internal.model.CheatSheetCollectionElement
Parameters:
parent - org.eclipse.ui.internal.model.CheatSheetCollectionElement
Parameters:
childName - java.lang.String |
| createEmptyCheatSheetCollection | | protected AdaptableList createEmptyCheatSheetCollection()(Code) | | Creates empty element collection. Overrider to fill
initial elements, if needed.
|
| findTaskEditor | | public TaskEditorNode findTaskEditor(String id)(Code) | | Returns the first task editor
with a given id.
|
| findTaskExplorer | | public TaskExplorerNode findTaskExplorer(String id)(Code) | | Returns the first task explorer
with a given id.
|
| getCategoryStringFor | | protected String getCategoryStringFor(IConfigurationElement config)(Code) | | Return the appropriate category (tree location) for this CheatSheet.
If a category is not specified then return a default one.
|
| getCheatSheets | | public AdaptableList getCheatSheets()(Code) | | Returns a list of cheatsheets, project and not.
The return value for this method is cached since computing its value
requires non-trivial work.
|
| getChildWithID | | protected CheatSheetCollectionElement getChildWithID(CheatSheetCollectionElement 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.CheatSheetCollectionElement
Parameters:
parent - org.eclipse.ui.internal.model.CheatSheetCollectionElement
Parameters:
childName - java.lang.String |
| getExplorerIds | | public String[] getExplorerIds()(Code) | | Get the list of explorer ids
an iterator for the explorer ids |
| getInstance | | public static CheatSheetRegistryReader getInstance()(Code) | | Returns a list of cheatsheets, project and not.
The return value for this method is cached since computing its value
requires non-trivial work.
|
| initializeCheatSheet | | protected boolean initializeCheatSheet(CheatSheetElement element, IConfigurationElement config)(Code) | | Initialize the passed element's properties based on the contents of
the passed registry. Answer a boolean indicating whether the element
was able to be adequately initialized.
boolean
Parameters:
element - CheatSheetElement
Parameters:
extension - Extension |
| readCheatSheets | | protected void readCheatSheets()(Code) | | Reads the cheatsheets in a registry.
This implementation uses a defering strategy. All of the elements
(categories, cheatsheets) are read. The categories are created as the read occurs.
The cheatsheets are just stored for later addition after the read completes.
This ensures that cheatsheet categorization is performed after all categories
have been read.
|
| readElement | | protected boolean readElement(IConfigurationElement element)(Code) | | Implement this method to read element attributes.
|
| registryChanged | | public void registryChanged(IRegistryChangeEvent event)(Code) | | |
| Fields inherited from org.eclipse.ui.internal.cheatsheets.registry.RegistryReader | final protected static String TAG_DESCRIPTION(Code)(Java Doc)
|
|
|