Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.dialogs
Class EnvironmentVariablesPromptDialog

java.lang.Object
  extended byorg.eclipse.jface.dialogs.Dialog
      extended bycom.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
          extended bycom.ibm.etools.systems.core.ui.dialogs.EnvironmentVariablesPromptDialog
All Implemented Interfaces:
ISystemMessageLine, ISystemPromptDialog, Runnable

public class EnvironmentVariablesPromptDialog
extends SystemPromptDialog

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

See Also:
Serialized Form

Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
activeRunningOperations, ADD_BUTTON_NO, ADD_BUTTON_YES, ADD_ID, addButton, arrowCursor, BROWSE_BUTTON_NO, BROWSE_BUTTON_YES, BROWSE_ID, browseButton, buttonsComposite, 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, labelDetailsHide, labelDetailsShow, labelOk, labelTest, marginHeight, marginWidth, minHeight, minWidth, needsProgressMonitor, okButton, okPressed, operationCancelableState, outputObject, outputObjectValidator, overallShell, pack, parentComposite, pendingErrorMessage, pendingMessage, progressMonitorPart, showAddButton, showBrowseButton, showDetailsButton, showOkButton, showTestButton, TEST_BUTTON_NO, TEST_BUTTON_YES, TEST_ID, testButton, tipAdd, tipBrowse, tipCancel, tipDetailsHide, tipDetailsShow, tipOk, tipTest, title, titleImage, verticalSpacing, waitCursor, windowClosingDialog
 
Constructor Summary
EnvironmentVariablesPromptDialog(Shell shell, String title, Object inputObject, String invalidNameChars, String[] existingNames, boolean change)
          Constructor for EnvironmentVariablesPromptDialog.
EnvironmentVariablesPromptDialog(Shell shell, String title, String systemType, 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 com.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
aboutToStart, addFillerLine, addGrowableFillerLine, addSeparatorLine, adjustButtonWidth, applyMnemonics, buttonPressed, clearErrorMessage, clearMessage, close, configureShell, createButtonBar, createButtonsForButtonBar, createContents, createControl, createDialogArea, createMessageLine, createWizardClosingDialog, dispose, enableAddButton, enableBrowseButton, enableCancelButton, enableDetailsButton, enableOkButton, enableTestButton, getAddButton, getBrowseButton, 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, processDetails, processTest, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, restoreEnableState, restoreUIState, run, run, saveEnableStateAndSet, saveUIState, setAddButtonLabel, setAddButtonToolTipText, setBrowseButtonLabel, setBrowseButtonToolTipText, setBusyCursor, setCancelButtonLabel, setCancelButtonToolTipText, setControl, setDescription, setDetailsButtonLabel, setDetailsButtonToolTipText, setDisplayCursor, setDisplayCursor, setErrorMessage, setErrorMessage, setErrorMessage, setHelp, setHelp, setImageDescriptor, setInitialOKButtonEnabledState, setInputObject, setMessage, setMessage, setMinimumSize, setNeedsProgressMonitor, setOkButtonLabel, setOkButtonToolTipText, setOutputObject, setOutputObjectValidator, setPageComplete, setShowAddButton, setShowBrowseButton, setShowDetailsButton, setShowOkButton, setShowTestButton, setTestButtonLabel, setTestButtonToolTipText, setTitle, setVisible, wasCancelled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

EnvironmentVariablesPromptDialog

public EnvironmentVariablesPromptDialog(Shell shell,
                                        String title,
                                        String 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)
See Also:
ModifyListener

Remote Systems
v6.4.1

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.