public interface ICheatSheetViewer
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.
CheatSheetViewerFactory
Modifier and Type | Method and Description |
---|---|
void |
createPartControl(Composite parent)
Creates the SWT controls for this cheat sheet viewer.
|
String |
getCheatSheetID()
Returns the id of the cheat sheet showing in this view.
|
Control |
getControl()
Returns the primary control associated with this viewer.
|
void |
reset(Map cheatSheetData)
Sets the currently active cheat sheet to its initial state and
initalizes the cheat sheet manager data.
|
void |
setFocus()
Asks this cheat sheet viewer to take focus.
|
void |
setInput(String id)
Sets the cheat sheet viewer to show the cheat sheet with
the given id.
|
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.
|
void createPartControl(Composite parent)
When the parent Composite is disposed, this will automatically dispose the controls added by this viewer (and release any other viewer-specific state).
parent
- the parent controlControl getControl()
null
if this viewer's controls
have not yet been created.String getCheatSheetID()
null
if the
view is not showing a cheat sheetvoid setFocus()
void setInput(String id)
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.
id
- the cheat sheet id, or null
to show
no cheat sheet in this viewervoid setInput(String id, String name, URL url)
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)
.
id
- the id to give this cheat sheetname
- the name to give this cheat sheeturl
- URL of the cheat sheet content fileIllegalArgumentException
- if the parameters
are null
void reset(Map cheatSheetData)
cheatSheetData
- A map whose keys and values are all of type
java.lang.String
or null
to reset all data in
the cheat sheet manager.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.