|
| |
|
| java.lang.Object
 org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
All known Subclasses: org.eclipse.jface.dialogs.IconAndMessageDialog, org.eclipse.jface.dialogs.TrayDialog, org.eclipse.jface.dialogs.InputDialog,
| Dialog | | abstract public class Dialog extends Window (Code) | | A dialog is a specialized window used for narrow-focused communication with
the user.
Dialogs are usually modal. Consequently, it is generally bad practice to open
a dialog without a parent. A modal dialog without a parent is not prevented
from disappearing behind the application's other windows, making it very
confusing for the user.
If there is more than one modal dialog is open the second one should be
parented off of the shell of the first one otherwise it is possible that the
OS will give focus to the first dialog potentially blocking the UI.
|
| Field Summary | |
| final public static int | DIALOG_DEFAULT_BOUNDS
A value that can be used for stored dialog width or height that
indicates that the default bounds should be used. | | final public static int | DIALOG_PERSISTLOCATION
Persist the last location of the dialog. | | final public static int | DIALOG_PERSISTSIZE
Persist the last known size of the dialog. | | final public static String | DLG_IMG_ERROR
Image registry key for error image (value
"dialog_error_image"). | | final public static String | DLG_IMG_HELP
Image registry key for help image (value
"dialog_help_image"). | | final public static String | DLG_IMG_INFO
Image registry key for info image (value "dialog_info_image"). | | final public static String | DLG_IMG_MESSAGE_ERROR
Image registry key for info message image (value
"dialog_message_error_image"). | | final public static String | DLG_IMG_MESSAGE_INFO
Image registry key for info message image (value
"dialog_messasge_info_image"). | | final public static String | DLG_IMG_MESSAGE_WARNING
Image registry key for info message image (value
"dialog_messasge_warning_image"). | | final public static String | DLG_IMG_QUESTION
Image registry key for question image (value
"dialog_question_image"). | | final public static String | DLG_IMG_WARNING
Image registry key for warning image (value
"dialog_warning_image"). | | final public static String | ELLIPSIS
The ellipsis is the string that is used to represent shortened text. | | public static IDialogBlockedHandler | blockedHandler
Create a default instance of the blocked handler which does not do
anything. | | public Control | buttonBar
The button bar; null until dialog is layed out. | | protected Control | dialogArea
The dialog area; null until dialog is layed out. |
| Constructor Summary | |
| protected | Dialog(Shell parentShell)
Creates a dialog instance. | | protected | Dialog(IShellProvider parentShell)
Creates a dialog with the given parent. |
| Method Summary | |
| public static void | applyDialogFont(Control control)
Applies the dialog font to all controls that currently have the default
font.
Parameters:
control - the control to apply the font to. | | protected void | buttonPressed(int buttonId)
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. | | protected void | cancelPressed()
Notifies that the cancel button of this dialog has been pressed.
The Dialog implementation of this framework method sets
this dialog's return code to Window.CANCEL and closes the
dialog. | | public boolean | close()
| | public static int | convertHeightInCharsToPixels(FontMetrics fontMetrics, int chars)
Returns the number of pixels corresponding to the height of the given
number of characters. | | protected int | convertHeightInCharsToPixels(int chars)
Returns the number of pixels corresponding to the height of the given
number of characters. | | public static int | convertHorizontalDLUsToPixels(FontMetrics fontMetrics, int dlus)
Returns the number of pixels corresponding to the given number of
horizontal dialog units. | | protected int | convertHorizontalDLUsToPixels(int dlus)
Returns the number of pixels corresponding to the given number of
horizontal dialog units. | | public static int | convertVerticalDLUsToPixels(FontMetrics fontMetrics, int dlus)
Returns the number of pixels corresponding to the given number of
vertical dialog units. | | protected int | convertVerticalDLUsToPixels(int dlus)
Returns the number of pixels corresponding to the given number of
vertical dialog units. | | public static int | convertWidthInCharsToPixels(FontMetrics fontMetrics, int chars)
Returns the number of pixels corresponding to the width of the given
number of characters. | | protected int | convertWidthInCharsToPixels(int chars)
Returns the number of pixels corresponding to the width of the given
number of characters. | | public void | create()
| | protected Button | createButton(Composite parent, int id, String label, boolean defaultButton)
Creates a new button with the given id.
The Dialog implementation of this framework method creates
a standard push button, registers it for selection events including
button presses, and registers default buttons with its shell. | | protected Control | createButtonBar(Composite parent)
Creates and returns the contents of this dialog's button bar.
The Dialog implementation of this framework method lays
out a button bar and calls the createButtonsForButtonBar
framework method to populate it. | | protected void | createButtonsForButtonBar(Composite parent)
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. | | protected Control | createContents(Composite parent)
The Dialog implementation of this Window
method creates and lays out the top level composite for the dialog, and
determines the appropriate horizontal and vertical dialog units based on
the font size. | | protected Control | createDialogArea(Composite parent)
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. | | protected static boolean | dialogFontIsDefault()
Return whether or not the dialog font is currently the same as the
default font. | | public static IDialogBlockedHandler | getBlockedHandler()
Get the IDialogBlockedHandler to be used by WizardDialogs and
ModalContexts. | | protected Button | getButton(int id)
Returns the button created by the method createButton for
the specified ID as defined on IDialogConstants. | | protected Control | getButtonBar()
Returns the button bar control. | | protected Button | getCancelButton()
Returns the button created when createButton is called
with an ID of IDialogConstants.CANCEL_ID. | | protected Control | getDialogArea()
Returns the dialog area control. | | protected IDialogSettings | getDialogBoundsSettings()
Gets the dialog settings that should be used for remembering the bounds of
of the dialog, according to the dialog bounds strategy. | | protected int | getDialogBoundsStrategy()
Get the integer constant that describes the strategy for persisting the
dialog bounds. | | public static Image | getImage(String key)
Returns the standard dialog image with the given key. | | protected Point | getInitialLocation(Point initialSize)
Returns the initial location to use for the shell. | | protected Point | getInitialSize()
Returns the initial size to use for the shell. | | protected Button | getOKButton()
Returns the button created when createButton is called
with an ID of IDialogConstants.OK_ID. | | protected void | initializeBounds()
| | protected void | initializeDialogUnits(Control control)
Initializes the computation of horizontal and vertical dialog units based
on the size of current font. | | protected boolean | isResizable()
Returns a boolean indicating whether the dialog should be
considered resizable when the shell style is initially
set. | | protected void | okPressed()
Notifies that the ok button of this dialog has been pressed.
The Dialog implementation of this framework method sets
this dialog's return code to Window.OK and closes the
dialog. | | public static void | setBlockedHandler(IDialogBlockedHandler blockedHandler)
Set the IDialogBlockedHandler to be used by WizardDialogs and
ModalContexts. | | protected void | setButtonLayoutData(Button button)
Set the layout data of the button to a GridData with appropriate heights
and widths. | | protected void | setButtonLayoutFormData(Button button)
Set the layout data of the button to a FormData with appropriate heights
and widths. | | public static String | shortenText(String textValue, Control control)
Shortens the given text textValue so that its width in
pixels does not exceed the width of the given control. |
| DIALOG_DEFAULT_BOUNDS | | final public static int DIALOG_DEFAULT_BOUNDS(Code) | | A value that can be used for stored dialog width or height that
indicates that the default bounds should be used.
since:
3.2 |
| DIALOG_PERSISTLOCATION | | final public static int DIALOG_PERSISTLOCATION(Code) | | Persist the last location of the dialog.
since:
3.2 |
| DIALOG_PERSISTSIZE | | final public static int DIALOG_PERSISTSIZE(Code) | | Persist the last known size of the dialog.
since:
3.2 |
| DLG_IMG_ERROR | | final public static String DLG_IMG_ERROR(Code) | | Image registry key for error image (value
"dialog_error_image").
|
| DLG_IMG_HELP | | final public static String DLG_IMG_HELP(Code) | | Image registry key for help image (value
"dialog_help_image").
since:
3.2 |
| DLG_IMG_INFO | | final public static String DLG_IMG_INFO(Code) | | Image registry key for info image (value "dialog_info_image").
|
| DLG_IMG_MESSAGE_ERROR | | final public static String DLG_IMG_MESSAGE_ERROR(Code) | | Image registry key for info message image (value
"dialog_message_error_image").
since:
2.0 |
| DLG_IMG_MESSAGE_INFO | | final public static String DLG_IMG_MESSAGE_INFO(Code) | | Image registry key for info message image (value
"dialog_messasge_info_image").
since:
2.0 |
| DLG_IMG_MESSAGE_WARNING | | final public static String DLG_IMG_MESSAGE_WARNING(Code) | | Image registry key for info message image (value
"dialog_messasge_warning_image").
since:
2.0 |
| DLG_IMG_QUESTION | | final public static String DLG_IMG_QUESTION(Code) | | Image registry key for question image (value
"dialog_question_image").
|
| DLG_IMG_WARNING | | final public static String DLG_IMG_WARNING(Code) | | Image registry key for warning image (value
"dialog_warning_image").
|
| ELLIPSIS | | final public static String ELLIPSIS(Code) | | The ellipsis is the string that is used to represent shortened text.
since:
3.0 |
| blockedHandler | | public static IDialogBlockedHandler blockedHandler(Code) | | Create a default instance of the blocked handler which does not do
anything.
|
| buttonBar | | public Control buttonBar(Code) | | The button bar; null until dialog is layed out.
|
| dialogArea | | protected Control dialogArea(Code) | | The dialog area; null until dialog is layed out.
|
| Dialog | | protected Dialog(Shell parentShell)(Code) | | Creates a dialog instance. Note that the window will have no visual
representation (no widgets) until it is told to open. By default,
open blocks for dialogs.
Parameters:
parentShell - the parent shell, or null to create a top-levelshell |
| Dialog | | protected Dialog(IShellProvider parentShell)(Code) | | Creates a dialog with the given parent.
Parameters:
parentShell - object that returns the current parent shell
since:
3.1 |
| applyDialogFont | | public static void applyDialogFont(Control control)(Code) | | Applies the dialog font to all controls that currently have the default
font.
Parameters:
control - the control to apply the font to. Font will also be applied toits children. If the control is null nothinghappens. |
| buttonPressed | | protected void buttonPressed(int buttonId)(Code) | | 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.
Parameters:
buttonId - the id of the button that was pressed (seeIDialogConstants.*_ID constants) |
| cancelPressed | | protected void cancelPressed()(Code) | | Notifies that the cancel button of this dialog has been pressed.
The Dialog implementation of this framework method sets
this dialog's return code to Window.CANCEL and closes the
dialog. Subclasses may override if desired.
|
| convertHeightInCharsToPixels | | public static int convertHeightInCharsToPixels(FontMetrics fontMetrics, int chars)(Code) | | Returns the number of pixels corresponding to the height of the given
number of characters.
The required FontMetrics parameter may be created in the
following way:
GC gc = new GC(control);
gc.setFont(control.getFont());
fontMetrics = gc.getFontMetrics();
gc.dispose();
Parameters:
fontMetrics - used in performing the conversion
Parameters:
chars - the number of characters the number of pixels
since:
2.0 |
| convertHeightInCharsToPixels | | protected int convertHeightInCharsToPixels(int chars)(Code) | | Returns the number of pixels corresponding to the height of the given
number of characters.
This method may only be called after initializeDialogUnits
has been called.
Clients may call this framework method, but should not override it.
Parameters:
chars - the number of characters the number of pixels |
| convertHorizontalDLUsToPixels | | public static int convertHorizontalDLUsToPixels(FontMetrics fontMetrics, int dlus)(Code) | | Returns the number of pixels corresponding to the given number of
horizontal dialog units.
The required FontMetrics parameter may be created in the
following way:
GC gc = new GC(control);
gc.setFont(control.getFont());
fontMetrics = gc.getFontMetrics();
gc.dispose();
Parameters:
fontMetrics - used in performing the conversion
Parameters:
dlus - the number of horizontal dialog units the number of pixels
since:
2.0 |
| convertHorizontalDLUsToPixels | | protected int convertHorizontalDLUsToPixels(int dlus)(Code) | | Returns the number of pixels corresponding to the given number of
horizontal dialog units.
This method may only be called after initializeDialogUnits
has been called.
Clients may call this framework method, but should not override it.
Parameters:
dlus - the number of horizontal dialog units the number of pixels |
| convertVerticalDLUsToPixels | | public static int convertVerticalDLUsToPixels(FontMetrics fontMetrics, int dlus)(Code) | | Returns the number of pixels corresponding to the given number of
vertical dialog units.
The required FontMetrics parameter may be created in the
following way:
GC gc = new GC(control);
gc.setFont(control.getFont());
fontMetrics = gc.getFontMetrics();
gc.dispose();
Parameters:
fontMetrics - used in performing the conversion
Parameters:
dlus - the number of vertical dialog units the number of pixels
since:
2.0 |
| convertVerticalDLUsToPixels | | protected int convertVerticalDLUsToPixels(int dlus)(Code) | | Returns the number of pixels corresponding to the given number of
vertical dialog units.
This method may only be called after initializeDialogUnits
has been called.
Clients may call this framework method, but should not override it.
Parameters:
dlus - the number of vertical dialog units the number of pixels |
| convertWidthInCharsToPixels | | public static int convertWidthInCharsToPixels(FontMetrics fontMetrics, int chars)(Code) | | Returns the number of pixels corresponding to the width of the given
number of characters.
The required FontMetrics parameter may be created in the
following way:
GC gc = new GC(control);
gc.setFont(control.getFont());
fontMetrics = gc.getFontMetrics();
gc.dispose();
Parameters:
fontMetrics - used in performing the conversion
Parameters:
chars - the number of characters the number of pixels
since:
2.0 |
| convertWidthInCharsToPixels | | protected int convertWidthInCharsToPixels(int chars)(Code) | | Returns the number of pixels corresponding to the width of the given
number of characters.
This method may only be called after initializeDialogUnits
has been called.
Clients may call this framework method, but should not override it.
Parameters:
chars - the number of characters the number of pixels |
| create | | public void create()(Code) | | |
| createButton | | protected Button createButton(Composite parent, int id, String label, boolean defaultButton)(Code) | | Creates a new button with the given id.
The Dialog implementation of this framework method creates
a standard push button, registers it for selection events including
button presses, and registers default buttons with its shell. The button
id is stored as the button's client data. If the button id is
IDialogConstants.CANCEL_ID, the new button will be
accessible from getCancelButton(). If the button id is
IDialogConstants.OK_ID, the new button will be accesible
from getOKButton(). Note that the parent's layout is
assumed to be a GridLayout and the number of columns in
this layout is incremented. Subclasses may override.
Parameters:
parent - the parent composite
Parameters:
id - the id of the button (see IDialogConstants.*_IDconstants for standard dialog button ids)
Parameters:
label - the label from the button
Parameters:
defaultButton - true if the button is to be the default button,and false otherwise the new button
See Also: Dialog.getCancelButton
See Also: Dialog.getOKButton() |
| createButtonBar | | protected Control createButtonBar(Composite parent)(Code) | | Creates and returns the contents of this dialog's button bar.
The Dialog implementation of this framework method lays
out a button bar and calls the createButtonsForButtonBar
framework method to populate it. Subclasses may override.
The returned control's layout data must be an instance of
GridData.
Parameters:
parent - the parent composite to contain the button bar the button bar control |
| createButtonsForButtonBar | | protected void createButtonsForButtonBar(Composite parent)(Code) | | 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.
Parameters:
parent - the button bar composite |
| createContents | | protected Control createContents(Composite parent)(Code) | | The Dialog implementation of this Window
method creates and lays out the top level composite for the dialog, and
determines the appropriate horizontal and vertical dialog units based on
the font size. It then calls the createDialogArea and
createButtonBar methods to create the dialog area and
button bar, respectively. Overriding createDialogArea and
createButtonBar are recommended rather than overriding
this method.
|
| createDialogArea | | protected Control createDialogArea(Composite parent)(Code) | | 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;
Parameters:
parent - the parent composite to contain the dialog area the dialog area control |
| dialogFontIsDefault | | protected static boolean dialogFontIsDefault()(Code) | | Return whether or not the dialog font is currently the same as the
default font.
boolean if the two are the same |
| getBlockedHandler | | public static IDialogBlockedHandler getBlockedHandler()(Code) | | Get the IDialogBlockedHandler to be used by WizardDialogs and
ModalContexts.
Returns the blockedHandler. |
| getButton | | protected Button getButton(int id)(Code) | | Returns the button created by the method createButton for
the specified ID as defined on IDialogConstants. If
createButton was never called with this ID, or if
createButton is overridden, this method will return
null.
Parameters:
id - the id of the button to look for the button for the ID or null
See Also: Dialog.createButton(Composite,int,String,boolean)
since:
2.0 |
| getButtonBar | | protected Control getButtonBar()(Code) | | Returns the button bar control.
Clients may call this framework method, but should not override it.
the button bar, or null if the button bar has notbeen created yet |
| getCancelButton | | protected Button getCancelButton()(Code) | | Returns the button created when createButton is called
with an ID of IDialogConstants.CANCEL_ID. If
createButton was never called with this parameter, or if
createButton is overridden, getCancelButton
will return null.
the cancel button or null
See Also: Dialog.createButton(Composite,int,String,boolean)
since:
2.0 |
| getDialogArea | | protected Control getDialogArea()(Code) | | Returns the dialog area control.
Clients may call this framework method, but should not override it.
the dialog area, or null if the dialog area hasnot been created yet |
| getDialogBoundsSettings | | protected IDialogSettings getDialogBoundsSettings()(Code) | | Gets the dialog settings that should be used for remembering the bounds of
of the dialog, according to the dialog bounds strategy.
settings the dialog settings used to store the dialog's locationand/or size, or null if the dialog's bounds shouldnever be stored.
since:
3.2
See Also: Dialog.getDialogBoundsStrategy |
| getDialogBoundsStrategy | | protected int getDialogBoundsStrategy()(Code) | | Get the integer constant that describes the strategy for persisting the
dialog bounds. This strategy is ignored if the implementer does not also
specify the dialog settings for storing the bounds in
Dialog.getDialogBoundsSettings().
the constant describing the strategy for persisting the dialogbounds.
since:
3.2
See Also: Dialog.DIALOG_PERSISTLOCATION
See Also: Dialog.DIALOG_PERSISTSIZE
See Also: Dialog.getDialogBoundsSettings |
| getImage | | public static Image getImage(String key)(Code) | | Returns the standard dialog image with the given key. Note that these
images are managed by the dialog framework, and must not be disposed by
another party.
Parameters:
key - one of the Dialog.DLG_IMG_* constants the standard dialog imageNOTE: Dialog does not use the following images in the registryDLG_IMG_ERROR DLG_IMG_INFO DLG_IMG_QUESTION DLG_IMG_WARNINGThey are now coming directly from SWT, see ImageRegistry. For backwardscompatibility they are still supported, however new code should use SWTfor these.
See Also: Display.getSystemImage(int) |
| getInitialLocation | | protected Point getInitialLocation(Point initialSize)(Code) | | Returns the initial location to use for the shell. Overridden
to check whether the bounds of the dialog have been stored in
dialog settings. If a location has been stored, it is returned.
Parameters:
initialSize - the initial size of the shell, as returned bygetInitialSize. the initial location of the shell
since:
3.2
See Also: Dialog.getDialogBoundsSettings()
See Also: Dialog.getDialogBoundsStrategy() |
| getOKButton | | protected Button getOKButton()(Code) | | Returns the button created when createButton is called
with an ID of IDialogConstants.OK_ID. If
createButton was never called with this parameter, or if
createButton is overridden, getOKButton
will return null.
the OK button or null
See Also: Dialog.createButton(Composite,int,String,boolean)
since:
2.0 |
| initializeBounds | | protected void initializeBounds()(Code) | | |
| initializeDialogUnits | | protected void initializeDialogUnits(Control control)(Code) | | Initializes the computation of horizontal and vertical dialog units based
on the size of current font.
This method must be called before any of the dialog unit based conversion
methods are called.
Parameters:
control - a control from which to obtain the current font |
| isResizable | | protected boolean isResizable()(Code) | | Returns a boolean indicating whether the dialog should be
considered resizable when the shell style is initially
set.
This method is used to ensure that all style
bits appropriate for resizable dialogs are added to the
shell style. Individual dialogs may always set the shell
style to ensure that a dialog is resizable, but using this
method ensures that resizable dialogs will be created with
the same set of style bits.
Style bits will never be removed based on the return value
of this method. For example, if a dialog returns
false, but also sets a style bit for a
SWT.RESIZE border, the style bit will be honored.
a boolean indicating whether the dialog is resizable and should have the default style bits forresizable dialogs
since:
3.4 |
| okPressed | | protected void okPressed()(Code) | | Notifies that the ok button of this dialog has been pressed.
The Dialog implementation of this framework method sets
this dialog's return code to Window.OK and closes the
dialog. Subclasses may override.
|
| setBlockedHandler | | public static void setBlockedHandler(IDialogBlockedHandler blockedHandler)(Code) | | Set the IDialogBlockedHandler to be used by WizardDialogs and
ModalContexts.
Parameters:
blockedHandler - The blockedHandler for the dialogs. |
| setButtonLayoutData | | protected void setButtonLayoutData(Button button)(Code) | | Set the layout data of the button to a GridData with appropriate heights
and widths.
Parameters:
button - |
| setButtonLayoutFormData | | protected void setButtonLayoutFormData(Button button)(Code) | | Set the layout data of the button to a FormData with appropriate heights
and widths.
Parameters:
button - |
| shortenText | | public static String shortenText(String textValue, Control control)(Code) | | Shortens the given text textValue so that its width in
pixels does not exceed the width of the given control. Overrides
characters in the center of the original string with an ellipsis ("...")
if necessary. If a null value is given, null
is returned.
Parameters:
textValue - the original string or null
Parameters:
control - the control the string will be displayed on the string to display, or null if null was passedin
since:
3.0 |
|
|
|