org.eclipse.rse.ui.actions
Class SystemStringPromptAction

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.jface.action.AbstractAction
          org.eclipse.jface.action.Action
              org.eclipse.rse.ui.actions.SystemBaseAction
                  org.eclipse.rse.ui.actions.SystemBaseDialogAction
                      org.eclipse.rse.ui.actions.SystemStringPromptAction

All Implemented Interfaces:

IAction, ISelectionChangedListener, 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.

Field Summary

Fields inherited from class org.eclipse.rse.ui.actions.SystemBaseDialogAction

cancelled, dlgHelpId, needsProgressMonitor, needsProgressMonitorSet, processAll, value

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

SystemStringPromptAction(String label, String tooltip, String title, String prompt, Shell parent)
Deprecated. use fields from resource class directly now

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 org.eclipse.rse.ui.actions.SystemBaseDialogAction

getDialogHelpContextId, getNeedsProgressMonitor, getProcessAllSelections, getValue, run, setDialogHelp, setNeedsProgressMonitor, setProcessAllSelections, setValue, wasCancelled, wasNeedsProgressMonitorSet

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.rse.ui.actions.ISystemAction

allowOnMultipleSelection, getContextMenuGroup, getHelpContextId, getSelection, getShell, getViewer, isDummy, isSelectionSensitive, setContextMenuGroup, setHelp, setInputs, setSelection, setSelectionSensitive, setShell, setViewer

Methods inherited from interface org.eclipse.jface.action.IAction

addPropertyChangeListener, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from interface org.eclipse.jface.viewers.ISelectionChangedListener

selectionChanged

Constructor Detail

SystemStringPromptAction

public SystemStringPromptAction(String label,
                                String tooltip,
                                String title,
                                String prompt,
                                Shell parent)

Deprecated. use fields from resource class directly now

Parameters:

parent - Shell of parent window

Method Detail

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.