Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.cheatsheets
Class OpenCheatSheetAction

java.lang.Object
  extended by 

org.eclipse.core.commands.common.EventManager
      extended by 

org.eclipse.jface.action.AbstractAction
          extended by 

org.eclipse.jface.action.Action
              extended by 
org.eclipse.ui.cheatsheets.OpenCheatSheetAction
All Implemented Interfaces:
IAction

public final class OpenCheatSheetAction
extends Action

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.

Since:
3.0
Restriction:
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. Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
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

OpenCheatSheetAction

public OpenCheatSheetAction(
String id)
Creates an action that opens the cheat sheet with the given id. The cheat sheet content file is located via the org.eclipse.ui.cheatsheets.cheatSheetContent extension point.

Parameters:
id - the cheat sheet id
Throws:
IllegalArgumentException - if id is null

OpenCheatSheetAction

public OpenCheatSheetAction(
String id,
                            
String name,
                            
URL url)
Creates an action that opens the cheat sheet with the given cheat sheet content file.

Parameters:
id - the id to give this cheat sheet
name - the name to give this cheat sheet
url - URL of the cheat sheet content file
Throws:
IllegalArgumentException - if the parameters are null

OpenCheatSheetAction

public OpenCheatSheetAction(
String id,
                            
String name,
                            
String xml,
                            
URL baseURL)
Creates an action that opens a cheat sheet using XML passed in as a string.

Parameters:
id - the id to give this cheat sheet
name - the name to give this cheat sheet
xml - the cheatsheet content in xml format
baseURL - 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
Throws:
IllegalArgumentException - if the parameters are null
Since:
3.3
Method Detail

run

public void run()
Description copied from class: Action
The default implementation of this 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.

Specified by:
run in interface IAction
Overrides:
run in class Action

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire