|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TrayDialog
org.eclipse.ui.forms.FormDialog
A general-purpose dialog that hosts a form. Clients should extend the class
and override createFormContent(IManagedForm)
protected method.
Since forms with wrapped text typically don't have a preferred size, it is important to set the initial dialog size upon creation:
MyFormDialog dialog = new MyFormDialog(shell); dialog.create(); dialog.getShell().setSize(500, 500); dialog.open();
Otherwise, the dialog may open very wide.
Nested Class Summary |
---|
Nested classes inherited from class org.eclipse.jface.window.Window |
---|
Window.IExceptionHandler |
Field Summary |
---|
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 |
Constructor Summary | |
---|---|
FormDialog(IShellProvider parentShellProvider)
Creates a new form dialog for a provided parent shell provider. |
|
FormDialog(Shell shell)
Creates a new form dialog for a provided parent shell. |
Method Summary | |
---|---|
boolean |
close()
Closes this window, disposes its shell, and removes this window from its window manager (if it has one). |
protected Control |
createButtonBar(Composite parent)
Creates and returns the contents of this dialog's button bar. |
protected Control |
createDialogArea(Composite parent)
Creates and returns the contents of the upper part of this dialog (above the button bar). |
protected void |
createFormContent(IManagedForm mform)
Configures the dialog form and creates form content. |
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog |
---|
closeTray, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FormDialog(Shell shell)
shell
- the parent shellpublic FormDialog(IShellProvider parentShellProvider)
parentShellProvider
- the parent shell providerMethod Detail |
public boolean close()
Window
This framework method may be extended (super.close
must
be called).
close
in class TrayDialog
protected Control createDialogArea(Composite parent)
Dialog
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;
createDialogArea
in class Dialog
parent
- the parent composite to contain the dialog area
protected Control createButtonBar(Composite parent)
Dialog
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
.
createButtonBar
in class TrayDialog
protected void createFormContent(IManagedForm mform)
mform
- the dialog form
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.