org.eclipse.cdt.internal.ui.preferences
Class PathEntryVariableDialog

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.jface.dialogs.TrayDialog
              extended by org.eclipse.jface.dialogs.TitleAreaDialog
                  extended by org.eclipse.cdt.internal.ui.preferences.PathEntryVariableDialog
All Implemented Interfaces:
org.eclipse.jface.window.IShellProvider

public class PathEntryVariableDialog
extends org.eclipse.jface.dialogs.TitleAreaDialog


Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
org.eclipse.jface.window.Window.IExceptionHandler
 
Field Summary
static int EXISTING_VARIABLE
          Constant for defining this dialog as intended to edit an existing variable (value = 2).
static int NEW_VARIABLE
          Constant for defining this dialog as intended to create a new variable (value = 1).
 
Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, 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
 
Constructor Summary
PathEntryVariableDialog(org.eclipse.swt.widgets.Shell parentShell, int type, int variableType, java.util.Set namesInUse)
          Constructs a dialog for editing a new/existing path variable.
 
Method Summary
 java.lang.String getVariableName()
          Returns the variable name.
 java.lang.String getVariableValue()
          Returns the variable value.
 void setVariableName(java.lang.String variableName)
          Sets the variable name.
 void setVariableValue(java.lang.String variableValue)
          Sets the variable value.
 
Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage
 
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
close, closeTray, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, create, getBlockedHandler, getImage, setBlockedHandler, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
getDefaultImage, getDefaultImages, getDefaultOrientation, getReturnCode, getShell, getWindowManager, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setWindowManager
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NEW_VARIABLE

public static final int NEW_VARIABLE
Constant for defining this dialog as intended to create a new variable (value = 1).

See Also:
Constant Field Values

EXISTING_VARIABLE

public static final int EXISTING_VARIABLE
Constant for defining this dialog as intended to edit an existing variable (value = 2).

See Also:
Constant Field Values
Constructor Detail

PathEntryVariableDialog

public PathEntryVariableDialog(org.eclipse.swt.widgets.Shell parentShell,
                               int type,
                               int variableType,
                               java.util.Set namesInUse)
Constructs a dialog for editing a new/existing path variable.

Parameters:
parentShell - the parent shell
type - the dialog type: NEW_VARIABLE or EXISTING_VARIABLE
variableType - the type of variable that can be edited in this dialog. IResource.FILE or IResource.FOLDER
namesInUse - a set of variable names currently in use
Method Detail

getVariableName

public java.lang.String getVariableName()
Returns the variable name.

Returns:
the variable name

getVariableValue

public java.lang.String getVariableValue()
Returns the variable value.

Returns:
the variable value

setVariableName

public void setVariableName(java.lang.String variableName)
Sets the variable name.

Parameters:
variableName - the new variable name

setVariableValue

public void setVariableValue(java.lang.String variableValue)
Sets the variable value.

Parameters:
variableValue - the new variable value