| |
org.eclipse.jface.dialogs
Class InputDialog
java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.InputDialog
-
All Implemented Interfaces:
-
IShellProvider
-
public class InputDialog
- extends
Dialog
A simple input dialog for soliciting an input string from the user.
This concrete dialog class can be instantiated as is, or further subclassed as
required.
|
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
|
|
Methods inherited from class org.eclipse.jface.dialogs.
Dialog
|
applyDialogFont,
cancelPressed,
close,
convertHeightInCharsToPixels,
convertHeightInCharsToPixels,
convertHorizontalDLUsToPixels,
convertHorizontalDLUsToPixels,
convertVerticalDLUsToPixels,
convertVerticalDLUsToPixels,
convertWidthInCharsToPixels,
convertWidthInCharsToPixels,
create,
createButton,
createButtonBar,
createContents,
dialogFontIsDefault,
getBlockedHandler,
getButton,
getButtonBar,
getCancelButton,
getDialogArea,
getDialogBoundsSettings,
getDialogBoundsStrategy,
getImage,
getInitialLocation,
getInitialSize,
getOKButton,
initializeBounds,
initializeDialogUnits,
isResizable,
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
|
InputDialog
public InputDialog(
Shell parentShell,
String dialogTitle,
String dialogMessage,
String initialValue,
IInputValidator validator)
- Creates an input dialog with OK and Cancel buttons. Note that the dialog
will have no visual representation (no widgets) until it is told to open.
Note that the open method blocks for input dialogs.
-
Parameters:
-
parentShell - the parent shell, or null to create a top-level
shell -
dialogTitle - the dialog title, or null if none -
dialogMessage - the dialog message, or null if none -
initialValue - the initial input value, or null if none
(equivalent to the empty string) -
validator - an input validator, or null if none
buttonPressed
protected void buttonPressed(int buttonId)
-
Description copied from class:
Dialog
- Notifies that this dialog's button with the given id has been pressed.
The Dialog implementation of this framework method calls
okPressed if the ok button is the pressed, and
cancelPressed if the cancel button is the pressed. All
other button presses are ignored. Subclasses may override to handle other
buttons, but should call super.buttonPressed if the
default handling of the ok and cancel buttons is desired.
-
-
Overrides:
-
buttonPressed
in class
Dialog
-
-
Parameters:
-
buttonId - the id of the button that was pressed (see
IDialogConstants.*_ID constants)
configureShell
protected void configureShell(
Shell shell)
-
Description copied from class:
Window
- Configures the given shell in preparation for opening this window in it.
The default implementation of this framework method sets the shell's
image and gives it a grid layout. Subclasses may extend or reimplement.
-
-
Overrides:
-
configureShell
in class
Window
-
-
Parameters:
-
shell - the shell
createButtonsForButtonBar
protected void createButtonsForButtonBar(
Composite parent)
-
Description copied from class:
Dialog
- Adds buttons to this dialog's button bar.
The Dialog implementation of this framework method adds
standard ok and cancel buttons using the createButton
framework method. These standard buttons will be accessible from
getCancelButton, and getOKButton.
Subclasses may override.
-
-
Overrides:
-
createButtonsForButtonBar
in class
Dialog
-
-
Parameters:
-
parent - the button bar composite
createDialogArea
protected
Control createDialogArea(
Composite parent)
-
Description copied from class:
Dialog
- Creates and returns the contents of the upper part of this dialog (above
the button bar).
The Dialog implementation of this framework method creates
and returns a new Composite with standard margins and
spacing.
The returned control's layout data must be an instance of
GridData. This method must not modify the parent's
layout.
Subclasses must override this method but may call super as
in the following example:
Composite composite = (Composite) super.createDialogArea(parent);
//add controls to composite as necessary
return composite;
-
-
Overrides:
-
createDialogArea
in class
Dialog
-
-
Parameters:
-
parent - the parent composite to contain the dialog area
-
Returns:
- the dialog area control
getErrorMessageLabel
protected
Label getErrorMessageLabel()
-
Deprecated. use setErrorMessage(String) instead
- Returns the error message label.
-
-
Returns:
- the error message label
getOkButton
protected
Button getOkButton()
- Returns the ok button.
-
-
Returns:
- the ok button
getText
protected
Text getText()
- Returns the text area.
-
-
Returns:
- the text area
getValidator
protected
IInputValidator getValidator()
- Returns the validator.
-
-
Returns:
- the validator
getValue
public
String getValue()
- Returns the string typed into this input dialog.
-
-
Returns:
- the input string
validateInput
protected void validateInput()
- Validates the input.
The default implementation of this framework method delegates the request
to the supplied input validator object; if it finds the input invalid,
the error message is displayed in the dialog's message line. This hook
method is called whenever the text changes in the input field.
-
setErrorMessage
public void setErrorMessage(
String errorMessage)
- Sets or clears the error message.
If not
null, the OK button is disabled.
-
-
Parameters:
-
errorMessage - the error message, or null to clear -
Since:
- 3.0
getInputTextStyle
protected int getInputTextStyle()
- Returns the style bits that should be used for the input text field.
Defaults to a single line entry. Subclasses may override.
-
-
Returns:
- the integer style bits that should be used when creating the
input text
-
Since:
- 3.4
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
