|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.cheatsheets.OpenCheatSheetAction
Action for opening a cheat sheet. The cheat sheet can be specified either by a cheat sheet id or by a URL of a cheat sheet content file.
This class is not intended to be subclassed by clients.
Field Summary |
---|
Fields inherited from interface org.eclipse.jface.action.IAction |
---|
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT |
Constructor Summary | |
---|---|
OpenCheatSheetAction(String id)
Creates an action that opens the cheat sheet with the given id. |
|
OpenCheatSheetAction(String id,
String name,
String xml,
URL baseURL)
Creates an action that opens a cheat sheet using XML passed in as a string. |
|
OpenCheatSheetAction(String id,
String name,
URL url)
Creates an action that opens the cheat sheet with the given cheat sheet content file. |
Method Summary | |
---|---|
void |
run()
The default implementation of this IAction method does
nothing. |
Methods inherited from class org.eclipse.jface.action.AbstractAction |
---|
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener |
Methods inherited from class org.eclipse.core.commands.common.EventManager |
---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.action.IAction |
---|
addPropertyChangeListener, removePropertyChangeListener |
Constructor Detail |
public OpenCheatSheetAction(String id)
org.eclipse.ui.cheatsheets.cheatSheetContent
extension point.
id
- the cheat sheet id
IllegalArgumentException
- if id
is null
public OpenCheatSheetAction(String id, String name, URL url)
id
- the id to give this cheat sheetname
- the name to give this cheat sheeturl
- URL of the cheat sheet content file
IllegalArgumentException
- if the parameters
are null
public OpenCheatSheetAction(String id, String name, String xml, URL baseURL)
id
- the id to give this cheat sheetname
- the name to give this cheat sheetxml
- the cheatsheet content in xml formatbaseURL
- is a URL which is only required if the cheat sheet is
a composite cheat sheet which has tasks which use path parameters in which
case the paths will be relative to baseURL. May be null
if this is not a composite cheat sheet
IllegalArgumentException
- if the parameters
are null
Method Detail |
public void run()
Action
IAction
method does
nothing. Subclasses should override this method if they do not need
information from the triggering event, or override
runWithEvent(Event)
if they do.
run
in interface IAction
run
in class Action
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.