| org.eclipse.ui.cheatsheets.ICheatSheetViewer
All known Subclasses: org.eclipse.ui.internal.cheatsheets.views.CheatSheetViewer,
| ICheatSheetViewer | | public interface ICheatSheetViewer (Code) | | A cheat sheet viewer.
Clients call
CheatSheetViewerFactory.createCheatSheetView to create
a cheat sheet viewer instance, and then call the viewer's
createPartControl method to have it create the viewer's control
under the specified SWT composite. The viewer's control can then be retrieved
using getControl to arrange layout. The setInput
methods are used to set (or clear) the cheat sheet shown in the viewer,
and can be called either before or after the viewer's controls have been
created and laid out.
The execution states of open cheat sheets are maintained and persisted
globally using the cheat sheet id as the key.
This interface is not intended to be implemented by clients.
See Also: CheatSheetViewerFactory
since:
3.0 |
| Method Summary | |
| public void | createPartControl(Composite parent)
Creates the SWT controls for this cheat sheet viewer. | | public String | getCheatSheetID()
Returns the id of the cheat sheet showing in this view. | | public Control | getControl()
Returns the primary control associated with this viewer. | | public void | reset(Map cheatSheetData)
Sets the currently active cheat sheet to its initial state and
initalizes the cheat sheet manager data.
Parameters:
cheatSheetData - A map whose keys and values are all of typejava.lang.String or null to reset all data in the cheat sheet manager. | | public void | setFocus()
Asks this cheat sheet viewer to take focus. | | public void | setInput(String id)
Sets the cheat sheet viewer to show the cheat sheet with
the given id. | | public void | setInput(String id, String name, URL url)
Sets the cheat sheet viewer to show the cheat sheet with the
given cheat sheet content file. |
| createPartControl | | public void createPartControl(Composite parent)(Code) | | Creates the SWT controls for this cheat sheet viewer.
When the parent Composite is disposed, this will automatically
dispose the controls added by this viewer (and release any other
viewer-specific state).
Parameters:
parent - the parent control |
| getCheatSheetID | | public String getCheatSheetID()(Code) | | Returns the id of the cheat sheet showing in this view.
id the cheat sheet id, or null if theview is not showing a cheat sheet |
| getControl | | public Control getControl()(Code) | | Returns the primary control associated with this viewer.
the SWT control which displays this viewer'scontent, or null if this viewer's controlshave not yet been created. |
| reset | | public void reset(Map cheatSheetData)(Code) | | Sets the currently active cheat sheet to its initial state and
initalizes the cheat sheet manager data.
Parameters:
cheatSheetData - A map whose keys and values are all of typejava.lang.String or null to reset all data in the cheat sheet manager.
since:
3.2 |
| setFocus | | public void setFocus()(Code) | | Asks this cheat sheet viewer to take focus.
|
| setInput | | public void setInput(String id)(Code) | | Sets the cheat sheet viewer to show the cheat sheet with
the given id. The cheat sheet content file is located via the
org.eclipse.ui.cheatsheets.cheatSheetContent
extension point. The viewer shows an error message if there
is no cheat sheet with the given id.
The execution states of open cheat sheets are maintained
and persisted globally using the cheat sheet id as the key.
Parameters:
id - the cheat sheet id, or null to showno cheat sheet in this viewer |
| setInput | | public void setInput(String id, String name, URL url)(Code) | | Sets the cheat sheet viewer to show the cheat sheet with the
given cheat sheet content file. The viewer shows an error
message if the cheat sheet content file cannot be opened or
parsed.
The execution states of open cheat sheets are maintained
and persisted globally using the cheat sheet id as the key.
This means that each cheat sheet must have a distinct id,
including ones opened from URLs.
Use the other setInput method to clear
the viewer; that is, call setInput(null).
Parameters:
id - the id to give this cheat sheet
Parameters:
name - the name to give this cheat sheet
Parameters:
url - URL of the cheat sheet content file
exception:
IllegalArgumentException - if the parametersare null |
|
|