com.ibm.etools.systems.core.ui.actions
Class SystemStringPromptAction
java.lang.Object
Action
com.ibm.etools.systems.core.ui.actions.SystemBaseAction
com.ibm.etools.systems.core.ui.actions.SystemBaseDialogAction
com.ibm.etools.systems.core.ui.actions.SystemStringPromptAction
- All Implemented Interfaces:
- ISystemAction, ISystemDialogAction
- public class SystemStringPromptAction
- extends SystemBaseDialogAction
This is a default action for prompting for a string.
It puts up a simple dialog with an entry field. You specify the button/menuitem
strings, and the title and prompt on the resulting dialog.
You can also optionally specify an input validator that is called to verify the
contents of the entry field.
- See Also:
- Serialized Form
Method Summary |
Dialog |
createDialog(Shell parent)
We use the default inherited actionPerformed method,
which calls this method to create our dialog. |
protected Object |
getDialogValue(Dialog dlg)
We use the default inherited actionPerformed method,
which calls this method after the dialog is closed in
order to retrieve the dialog's data. |
void |
setValidator(ISystemValidator inputValidator)
Set validator to use to check validity of input |
Methods inherited from class com.ibm.etools.systems.core.ui.actions.SystemBaseDialogAction |
getDialogHelpContextId, getNeedsProgressMonitor, getProcessAllSelections, getValue, run, setDialogHelp, setNeedsProgressMonitor, setProcessAllSelections, setValue, wasCancelled, 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.ISystemAction |
allowOnMultipleSelection, getContextMenuGroup, getHelpContextId, getSelection, getShell, getViewer, isDummy, isSelectionSensitive, setContextMenuGroup, setHelp, setInputs, setSelection, setSelectionSensitive, setShell, setViewer |
copyright
public static final String copyright
- See Also:
- Constant Field Values
SystemStringPromptAction
public SystemStringPromptAction(ResourceBundle rb,
String key,
Shell parent)
- Parameters:
rb
- Resource bundle where to find following keyskey
- Key used as prefix in resource bundle to get:
- button/menuitem label -> appends ".label" to key
- button/menuitem tooltip -> appends ".tooltip" to key
- button/menuitem description on status line -> appends ".description" to key
- title of generic prompt dialog box displayed -> appends ".title"
- prompt text in generic prompt dialog box displayed -> appends ".prompt"
parent
- Shell of parent window
setValidator
public void setValidator(ISystemValidator inputValidator)
- Set validator to use to check validity of input
createDialog
public Dialog createDialog(Shell parent)
- We use the default inherited actionPerformed method,
which calls this method to create our dialog.
- Specified by:
createDialog
in class SystemBaseDialogAction
- See Also:
SystemBaseDialogAction.run()
getDialogValue
protected Object getDialogValue(Dialog dlg)
- We use the default inherited actionPerformed method,
which calls this method after the dialog is closed in
order to retrieve the dialog's data. This is then
placed in this object's value property and can be
retrieved publicly via getValue().
- Specified by:
getDialogValue
in class SystemBaseDialogAction
- Parameters:
dlg
- The dialog object, after it has returned from open.
Copyright © 2005 IBM Corp. All Rights Reserved.
Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.