| java.lang.Object
 org.eclipse.ui.internal.cheatsheets.views.CheatSheetViewer
| Field Summary | |
| protected Composite | control
|
| Method Summary | |
| public void | addListener(CheatSheetListener listener)
| | public void | advanceIntroItem()
| | void | advanceItem(ImageHyperlink link, boolean markAsCompleted)
| | void | advanceSubItem(ImageHyperlink link, boolean markAsCompleted, int subItemIndex)
| | public int | contributeToViewMenu(Menu menu, int index)
| | public void | copy()
| | public void | createPartControl(Composite parent)
Creates the SWT controls for this workbench part.
Clients should not call this method (the workbench calls this method at
appropriate times).
For implementors this is a multi-step process:
- Create one or more controls within the parent.
- Set the parent layout as needed.
- Register any global actions with the
IActionService.
- Register any popup menus with the
IActionService.
- Register a selection provider with the
ISelectionService
(optional). | | public ICheatSheet | getCheatSheet()
| | public String | getCheatSheetID()
| | CheatSheetElement | getContent()
Returns the current content. | | public Control | getControl()
| | public Action | getCopyAction()
| | CheatSheetManager | getManager()
| | public boolean | hasFocusControl(Control control)
Returns whether or not this viewer contains the given Control, which
is currently in focus. | | public boolean | isInDialogMode()
Returns whether or not this cheat sheet viewer is inside a modal
dialog. | | public void | reset(Map cheatSheetData)
| | public void | restart()
| | void | runPerformExecutable(ImageHyperlink link)
| | void | runSubItemPerformExecutable(ImageHyperlink link, int subItemIndex)
| | void | saveCurrentSheet()
| | public void | saveState(IMemento memento)
| | void | setContent(CheatSheetElement element, ICheatSheetStateManager inputStateManager)
| | public void | setCopyAction(Action copyAction)
| | void | setExpandRestoreAction(CheatSheetExpandRestoreAction action)
| | public void | setFocus()
Passing the focus request to the viewer's control. | | public void | setInput(String id)
| | public void | setInput(String id, ICheatSheetStateManager inputStateManager)
| | public void | setInput(String id, String name, URL url)
| | public void | setInput(String id, String name, URL url, ICheatSheetStateManager inputStateManager, boolean isRestricted)
| | public void | setInputFromXml(String id, String name, String xml, String basePath)
| | public void | showError(String message)
| | void | toggleExpandRestore()
|
| control | | protected Composite control(Code) | | |
| CheatSheetViewer | | public CheatSheetViewer(boolean inDialog)(Code) | | The constructor.
Parameters:
inDialog - whether or not this viewer will be placed in a modal dialog |
| advanceIntroItem | | public void advanceIntroItem()(Code) | | |
| advanceSubItem | | void advanceSubItem(ImageHyperlink link, boolean markAsCompleted, int subItemIndex)(Code) | | |
| contributeToViewMenu | | public int contributeToViewMenu(Menu menu, int index)(Code) | | |
| createPartControl | | public void createPartControl(Composite parent)(Code) | | Creates the SWT controls for this workbench part.
Clients should not call this method (the workbench calls this method at
appropriate times).
For implementors this is a multi-step process:
- Create one or more controls within the parent.
- Set the parent layout as needed.
- Register any global actions with the
IActionService.
- Register any popup menus with the
IActionService.
- Register a selection provider with the
ISelectionService
(optional).
Parameters:
parent - the parent control |
| getControl | | public Control getControl()(Code) | | |
| getCopyAction | | public Action getCopyAction()(Code) | | |
| hasFocusControl | | public boolean hasFocusControl(Control control)(Code) | | Returns whether or not this viewer contains the given Control, which
is currently in focus.
Parameters:
control - the Control currently in focus whether this viewer contains the given Control or not |
| isInDialogMode | | public boolean isInDialogMode()(Code) | | Returns whether or not this cheat sheet viewer is inside a modal
dialog.
whether this viewer is inside a modal dialog |
| reset | | public void reset(Map cheatSheetData)(Code) | | |
| restart | | public void restart()(Code) | | |
| runSubItemPerformExecutable | | void runSubItemPerformExecutable(ImageHyperlink link, int subItemIndex)(Code) | | |
| saveCurrentSheet | | void saveCurrentSheet()(Code) | | |
| saveState | | public void saveState(IMemento memento)(Code) | | |
| setCopyAction | | public void setCopyAction(Action copyAction)(Code) | | |
| setFocus | | public void setFocus()(Code) | | Passing the focus request to the viewer's control.
|
| toggleExpandRestore | | void toggleExpandRestore()(Code) | | |
|
|