org.eclipse.rse.ui.dialogs
Class EnvironmentVariablesPromptDialog

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.rse.ui.dialogs.SystemPromptDialog
              org.eclipse.rse.ui.dialogs.EnvironmentVariablesPromptDialog

All Implemented Interfaces:

Runnable, EventListener, IDialogConstants, IDialogPage, IRunnableContext, IShellProvider, ISystemPromptDialog, ISystemMessageLine, ModifyListener, org.eclipse.swt.internal.SWTEventListener, Listener

public class EnvironmentVariablesPromptDialog
extends SystemPromptDialog
implements ModifyListener

Dialog for prompting the user to add / change an environment variable.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

Window.IExceptionHandler

Field Summary

Fields inherited from class org.eclipse.rse.ui.dialogs.SystemPromptDialog

activeRunningOperations, ADD_BUTTON_NO, ADD_BUTTON_YES, ADD_ID, addButton, arrowCursor, BROWSE_BUTTON_NO, BROWSE_BUTTON_YES, BROWSE_ID, browseButton, buttonsComposite, CANCEL_ALL_ID, cancelAllButton, cancelAllPressed, cancelButton, cancelListener, DETAILS_BUTTON_NO, DETAILS_BUTTON_YES, DETAILS_ID, detailsButton, detailsButtonHideMode, detailsHideLabel, detailsShowLabel, dialogAreaComposite, dialogMnemonics, fMessageLine, helpId, horizontalSpacing, initialAddButtonEnabledState, initialDetailsButtonEnabledState, initialOKButtonEnabledState, inputObject, labelAdd, labelBrowse, labelCancel, labelCancelAll, labelDetailsHide, labelDetailsShow, labelOk, labelTest, marginHeight, marginWidth, minHeight, minWidth, needsProgressMonitor, noShowAgainButton, noShowAgainOption, okButton, okPressed, operationCancelableState, outputObject, outputObjectValidator, overallShell, pack, parentComposite, pendingErrorMessage, pendingMessage, prefId, prefStore, prefValAsSelected, progressMonitorPart, showAddButton, showBrowseButton, showCancelAllButton, showDetailsButton, showOkButton, showTestButton, TEST_BUTTON_NO, TEST_BUTTON_YES, TEST_ID, testButton, tipAdd, tipBrowse, tipCancel, tipCancelAll, tipDetailsHide, tipDetailsShow, tipOk, tipTest, title, titleImage, verticalSpacing, waitCursor, windowClosingDialog

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Fields inherited from interface org.eclipse.jface.dialogs.IDialogConstants

ABORT_ID, ABORT_LABEL, BACK_ID, BACK_LABEL, BUTTON_BAR_HEIGHT, BUTTON_HEIGHT, BUTTON_MARGIN, BUTTON_WIDTH, CANCEL_ID, CANCEL_LABEL, CLIENT_ID, CLOSE_ID, CLOSE_LABEL, DESELECT_ALL_ID, ENTRY_FIELD_WIDTH, FINISH_ID, FINISH_LABEL, HELP_ID, HELP_LABEL, HIDE_DETAILS_LABEL, HORIZONTAL_MARGIN, HORIZONTAL_SPACING, IGNORE_ID, IGNORE_LABEL, INDENT, INTERNAL_ID, LEFT_MARGIN, MINIMUM_MESSAGE_AREA_WIDTH, NEXT_ID, NEXT_LABEL, NO_ID, NO_LABEL, NO_TO_ALL_ID, NO_TO_ALL_LABEL, OK_ID, OK_LABEL, OPEN_ID, OPEN_LABEL, PROCEED_ID, PROCEED_LABEL, RETRY_ID, RETRY_LABEL, SELECT_ALL_ID, SELECT_TYPES_ID, SHOW_DETAILS_LABEL, SKIP_ID, SKIP_LABEL, SMALL_INDENT, STOP_ID, STOP_LABEL, VERTICAL_MARGIN, VERTICAL_SPACING, YES_ID, YES_LABEL, YES_TO_ALL_ID, YES_TO_ALL_LABEL

Constructor Summary

EnvironmentVariablesPromptDialog(Shell shell, String title, IRSESystemType systemType, String invalidNameChars, String[] existingNames, boolean change)
Constructor for EnvironmentVariablesPromptDialog.

EnvironmentVariablesPromptDialog(Shell shell, String title, Object inputObject, String invalidNameChars, String[] existingNames, boolean change)
Constructor for EnvironmentVariablesPromptDialog.

Method Summary

protected Control	createInner(Composite parent) Called by createContents method.
protected Control	getInitialFocusControl() Return the Control to be given initial focus.
String	getName() Get the environment varaible name entered in the dialog.
String	getValue() Get the environment varaible value entered in the dialog.
void	modifyText(ModifyEvent e)
protected boolean	processOK() To be overridden by children.
void	setName(String name) Preset the name for the environment variable
void	setValue(String value) Preset the value for the environment variable

Methods inherited from class org.eclipse.rse.ui.dialogs.SystemPromptDialog

aboutToStart, addFillerLine, addGrowableFillerLine, addSeparatorLine, adjustButtonWidth, applyMnemonics, buttonPressed, clearErrorMessage, clearMessage, close, configureShell, createButtonBar, createButtonsForButtonBar, createContents, createControl, createDialogArea, createMessageLine, createNoShowAgainButton, createWizardClosingDialog, dispose, enableAddButton, enableBrowseButton, enableCancelAllButton, enableCancelButton, enableDetailsButton, enableOkButton, enableTestButton, getAddButton, getBrowseButton, getCancelAllButton, getCancelOrCloseButton, getControl, getDescription, getDetailsButton, getDialogMnemonics, getErrorMessage, getHelpContextId, getImage, getInputObject, getMessage, getMessageLine, getOkButton, getOutputObject, getOutputObjectValidator, getProgressMonitor, getSystemErrorMessage, getTestButton, getTitle, handleEvent, hardClose, okToClose, pack, performHelp, processAdd, processBrowse, processCancel, processCancelAll, processDetails, processTest, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, restoreEnableState, restoreUIState, run, run, saveEnableStateAndSet, saveUIState, setAddButtonLabel, setAddButtonToolTipText, setBrowseButtonLabel, setBrowseButtonToolTipText, setBusyCursor, setCancelAllButtonLabel, setCancelAllButtonToolTipText, setCancelButtonLabel, setCancelButtonToolTipText, setControl, setDescription, setDetailsButtonLabel, setDetailsButtonToolTipText, setDisplayCursor, setDisplayCursor, setErrorMessage, setErrorMessage, setErrorMessage, setHelp, setHelp, setImageDescriptor, setInitialOKButtonEnabledState, setInputObject, setMessage, setMessage, setMinimumSize, setNeedsProgressMonitor, setNoShowAgainOption, setOkButtonLabel, setOkButtonToolTipText, setOutputObject, setOutputObjectValidator, setPageComplete, setShowAddButton, setShowBrowseButton, setShowCancelAllButton, setShowDetailsButton, setShowOkButton, setShowTestButton, setTestButtonLabel, setTestButtonToolTipText, setTitle, setVisible, wasCancelled, wasCancelledAll

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironmentVariablesPromptDialog

public EnvironmentVariablesPromptDialog(Shell shell,
                                        String title,
                                        IRSESystemType systemType,
                                        String invalidNameChars,
                                        String[] existingNames,
                                        boolean change)

Constructor for EnvironmentVariablesPromptDialog.

Parameters:

shell -

title -

EnvironmentVariablesPromptDialog

public EnvironmentVariablesPromptDialog(Shell shell,
                                        String title,
                                        Object inputObject,
                                        String invalidNameChars,
                                        String[] existingNames,
                                        boolean change)

Constructor for EnvironmentVariablesPromptDialog.

Parameters:

shell -

title -

inputObject -

Method Detail

createInner

protected Control createInner(Composite parent)

Description copied from class: SystemPromptDialog

Called by createContents method. Create this dialog's widgets inside a composite. Child classes must override this.

Specified by:

createInner in class SystemPromptDialog

See Also:

SystemPromptDialog.createInner(Composite)

getInitialFocusControl

protected Control getInitialFocusControl()

Description copied from class: SystemPromptDialog

Return the Control to be given initial focus. Child classes must override this, but can return null.

Specified by:

getInitialFocusControl in class SystemPromptDialog

See Also:

SystemPromptDialog.getInitialFocusControl()

getName

public String getName()

Get the environment varaible name entered in the dialog.

getValue

public String getValue()

Get the environment varaible value entered in the dialog.

setName

public void setName(String name)

Preset the name for the environment variable

setValue

public void setValue(String value)

Preset the value for the environment variable

processOK

protected boolean processOK()

Description copied from class: SystemPromptDialog

To be overridden by children. Called when user presses OK button. Child dialog class should set output object. Return true to close dialog. Return false to not close dialog.

Overrides:

processOK in class SystemPromptDialog

See Also:

SystemPromptDialog.processOK()

modifyText

public void modifyText(ModifyEvent e)

Specified by:

modifyText in interface ModifyListener

See Also:

ModifyListener.modifyText(ModifyEvent)