|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectAction
com.ibm.etools.systems.core.ui.actions.SystemBaseAction
com.ibm.etools.systems.core.ui.actions.SystemBaseDialogAction
com.ibm.etools.systems.core.ui.actions.SystemBaseWizardAction
A specialization for the eclipse Action method, for actions that put up wizards.
This class is most effective when used with actions that extend AbstractSystemWizard
,
or implement ISystemWizard
. It supports
settings that are propogated to the wizard, and wizard pages if they extend AbstractSystemWizardPage
,
or implement ISystemWizardPage
.
com.ibm.etools.systems.core.ui.SystemBaseAction#allowOnMultipleSelection(boolean)
to false, since most wizard actions are not permitted on multiple selection.
progress-monitor
or not, which is propogated to the wizard.
title
, which is propogated to the wizard.
image
, which is propogated to the wizard.
page-title
, which is propogated to the wizard and the wizard pages.
contextual-help
, which is propogated to the wizard and the wizard pages.
minimum-size
, which is propogated and applied to the wizard.
input-object
, which is propogated to the wizard and wizard pages. By default, this
is set the current StructuredSelection.
output-object
which is set by the wizard class.
wasCancelled()
method so the caller can easily determine if the wizard was dismissed or cancelled by the user.
current-viewer
.
To use this class:
AbstractSystemWizard
, and is populated with
pages that extend AbstractSystemWizardPage
.
createWizard()
to instantiate, configure and return your wizard.
postProcessWizard(IWizard)
. You might also override this if you need to set output variables in the action,
after the sucessful completion of the wizard.
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseDialogAction |
---|
cancelled, dlgHelpId, needsProgressMonitor, needsProgressMonitorSet, processAll, value |
Fields inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseAction |
---|
allowOnMultipleSelection, arrowCursor, helpId, selectionSensitive, shell, sSelection, traceSelections, traceTarget, viewer, waitCursor |
Constructor Summary | |
---|---|
protected |
SystemBaseWizardAction(ResourceBundle rb,
String prefix,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction given a resource bundle from which the label, tooltip and description can be retrieved, and there is a image to display in a menu. |
protected |
SystemBaseWizardAction(ResourceBundle rb,
String prefix,
Shell parent)
Constructor for SystemBaseWizardAction given a resource bundle from which the label, tooltip and description can be retrieved, and there is no image for this action. |
protected |
SystemBaseWizardAction(String text,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction when translated label is known. |
protected |
SystemBaseWizardAction(String text,
String tooltip,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction when translated label and tooltip are known. |
protected |
SystemBaseWizardAction(String text,
String tooltip,
String description,
ImageDescriptor image,
Shell parent)
Constructor for SystemBaseWizardAction when translated label and tooltip and description are all known. |
Method Summary | |
---|---|
protected Dialog |
createDialog(Shell shell)
Override of parent's method. |
protected abstract IWizard |
createWizard()
The default processing for the run method calls createDialog, which we override in this class. |
protected Object |
getDialogValue(Dialog dlg)
By default, we try to get the wizard's value by calling getOutputObject() |
String |
getWizardPageTitle()
Return the page title as set via setWizardPageTitle |
protected void |
postProcessWizard(IWizard wizard)
Typically, the wizard's performFinish method does the work required by a successful finish of the wizard. |
void |
setMinimumPageSize(int width,
int height)
Call this method to set the wizard's dimensions without having to subclass the wizard. |
void |
setWizardImage(ImageDescriptor wizardImage)
Set the wizard image. |
void |
setWizardPageTitle(String pageTitle)
Set the wizard page title. |
void |
setWizardTitle(String title)
Set the wizard title. |
boolean |
wasCancelled()
Returns true if the user cancelled the wizard. |
Methods inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseDialogAction |
---|
getDialogHelpContextId, getNeedsProgressMonitor, getProcessAllSelections, getValue, run, setDialogHelp, setNeedsProgressMonitor, setProcessAllSelections, setValue, wasNeedsProgressMonitorSet |
Methods inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseAction |
---|
allowOnMultipleSelection, checkObjectType, getAdapter, getContextMenuGroup, getCurrentTreeView, getDescription, getFirstSelection, getHelpContextId, getLabel, getNextSelection, getRemoteAdapter, getSelection, getSelectionProvider, getShell, getShell, getString, getStringOrNull, getSystemConnection, getToolTip, getViewer, isDummy, isEnabled, isSelectionSensitive, issueTraceMessage, selectionChanged, setAvailableOffline, setBusyCursor, setContextMenuGroup, setDisplayCursor, setDisplayCursor, setHelp, setInputs, setSelection, setSelectionProvider, setSelectionSensitive, setShell, setSystemConnection, setTracing, setTracing, setViewer, updateSelection |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.etools.systems.core.ui.actions.ISystemDialogAction |
---|
getValue, setProcessAllSelections, setValue |
Methods inherited from interface com.ibm.etools.systems.core.ui.actions.ISystemAction |
---|
allowOnMultipleSelection, getContextMenuGroup, getHelpContextId, getSelection, getShell, getViewer, isDummy, isSelectionSensitive, setContextMenuGroup, setHelp, setInputs, setSelection, setSelectionSensitive, setShell, setViewer |
Field Detail |
public static final String copyright
Constructor Detail |
protected SystemBaseWizardAction(String text, ImageDescriptor image, Shell parent)
text
- string to display in menu or toolbarimage
- icon to display in menu or toolbar. Can be null.parent
- Shell of parent window. Can be null if you don't know it, but call setShell when you do.protected SystemBaseWizardAction(String text, String tooltip, ImageDescriptor image, Shell parent)
text
- string to display in menu or toolbartooltip
- string to display when user hovers mouse over action.image
- icon to display in menu or toolbar. Can be null.parent
- Shell of parent window. Can be null if you don't know it, but call setShell when you do.protected SystemBaseWizardAction(String text, String tooltip, String description, ImageDescriptor image, Shell parent)
text
- string to display in menu or toolbartooltip
- string to display when user hovers mouse over action.description
- string displayed in status bar of some displays. Longer than tooltip.image
- icon to display in menu or toolbar. Can be null.parent
- Shell of parent window. Can be null if you don't know it, but call setShell when you do.protected SystemBaseWizardAction(ResourceBundle rb, String prefix, ImageDescriptor image, Shell parent)
rb
- ResourceBundle that label (+".label"), tip (+".tooltip") and description (+".description")
are derived from.prefix
- resource properties prefix that suffixes are added to, to find label, tip and desc.image
- icon to display in menu or toolbar. can be null.protected SystemBaseWizardAction(ResourceBundle rb, String prefix, Shell parent)
rb
- ResourceBundle that label (+".label"), tip (+".tooltip") and description (+".description")
are derived from.prefix
- resource properties prefix that suffixes are added to, to find label, tip and desc.Method Detail |
public void setWizardTitle(String title)
public void setWizardImage(ImageDescriptor wizardImage)
public void setWizardPageTitle(String pageTitle)
This is not used by default, but can be queried via getPageTitle() when constructing pages.
public String getWizardPageTitle()
public void setMinimumPageSize(int width, int height)
protected Dialog createDialog(Shell shell)
createDialog
in class SystemBaseDialogAction
SystemBaseDialogAction.run()
protected abstract IWizard createWizard()
protected Object getDialogValue(Dialog dlg)
getDialogValue
in class SystemBaseDialogAction
dlg
- The dialog object, after it has returned from open.protected void postProcessWizard(IWizard wizard)
public boolean wasCancelled()
wasCancelled
in interface ISystemDialogAction
wasCancelled
in class SystemBaseDialogAction
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |