RSE
Release 1.0

org.eclipse.rse.ui.actions
Class SystemShowPreferencesPageAction

java.lang.Object
  extended byorg.eclipse.core.commands.common.EventManager
      extended byorg.eclipse.jface.action.AbstractAction
          extended byorg.eclipse.jface.action.Action
              extended byorg.eclipse.rse.ui.actions.SystemBaseAction
                  extended byorg.eclipse.rse.ui.actions.SystemShowPreferencesPageAction
All Implemented Interfaces:
IAction, IActionDelegate, ISelectionChangedListener, ISystemAction, IViewActionDelegate

public class SystemShowPreferencesPageAction
extends SystemBaseAction
implements IViewActionDelegate

This action will launch the Prefences dialog, but only rooted at a given preference page (it will include its children underneath), including the child pages registered under that page ("category").

This is used by the org.eclipse.rse.core.remoteSystemsViewPreferencesActions extension point.

See Also:
SystemCascadingPreferencesAction

Field Summary
 
Fields inherited from class org.eclipse.rse.ui.actions.SystemBaseAction
allowOnMultipleSelection, arrowCursor, helpId, selectionSensitive, shell, sSelection, traceSelections, traceTarget, viewer, waitCursor
 
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
SystemShowPreferencesPageAction()
          Constructor.
 
Method Summary
 PreferenceManager getPreferenceManager()
           
 void init(IViewPart view)
           
 void run()
          This is the method called when the user selects this action.
 void run(IAction action)
           
 void selectionChanged(IAction action, ISelection selection)
           
 void setPreferencePageCategory(String preferencePageCategory)
          Set the category of the pages to be shown.
 void setPreferencePageID(String preferencePageID)
          Set ID of the preference root page to show.
 void setPreferencePageID(String[] preferencePageIDs)
          Set IDs of the preference root pages to show.
 
Methods inherited from class org.eclipse.rse.ui.actions.SystemBaseAction
allowOnMultipleSelection, checkObjectType, getAdapter, getContextMenuGroup, getCurrentTreeView, getFirstSelection, getHelpContextId, getNextSelection, getRemoteAdapter, getSelection, getSelectionProvider, getShell, getShell, getSystemConnection, getViewer, isDummy, isEnabled, isSelectionSensitive, issueTraceMessage, selectionChanged, setAvailableOffline, setBusyCursor, setContextMenuGroup, setDisplayCursor, setDisplayCursor, setHelp, setHost, setInputs, setSelection, setSelectionProvider, setSelectionSensitive, setShell, setTracing, setTracing, setViewer, updateSelection
 
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, 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, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isHandled, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 

Constructor Detail

SystemShowPreferencesPageAction

public SystemShowPreferencesPageAction()
Constructor. We are instantiated inside RSEUIPlugin#getPreferencePageActionPlugins() for each extension of our extension point org.eclipse.rse.core.remoteSystemsViewPreferencesActions

Method Detail

setPreferencePageID

public void setPreferencePageID(String preferencePageID)
Set ID of the preference root page to show.

Parameters:
preferencePageID - The ID of the preference page root to show. All child nodes will also be shown.

setPreferencePageID

public void setPreferencePageID(String[] preferencePageIDs)
Set IDs of the preference root pages to show.

Parameters:
preferencePageIDs - The IDs of the preference page roots to show. All child nodes will also be shown.

setPreferencePageCategory

public void setPreferencePageCategory(String preferencePageCategory)
Set the category of the pages to be shown. This only needs to be called for non-root pages. Note that the ID to give here is not of the immediate parent, but that of the root parent. It tells us which root subtree to search for the given page(s).


init

public void init(IViewPart view)
Specified by:
init in interface IViewActionDelegate
See Also:
IViewActionDelegate.init(IViewPart)

run

public void run(IAction action)
Specified by:
run in interface IActionDelegate
See Also:
IActionDelegate#run(IAction)

selectionChanged

public void selectionChanged(IAction action,
                             ISelection selection)
Specified by:
selectionChanged in interface IActionDelegate
See Also:
IActionDelegate#selectionChanged(IAction, ISelection)

run

public void run()
This is the method called when the user selects this action.

Specified by:
run in interface IAction
Overrides:
run in class SystemBaseAction
See Also:
Action.run()

getPreferenceManager

public PreferenceManager getPreferenceManager()

RSE
Release 1.0

Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved.