|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.window.Window | +--org.eclipse.jface.window.ApplicationWindow
An application window is a high-level "main window", with built-in support for an optional menu bar with standard menus, an optional toolbar, and an optional status line.
Creating an application window involves the following steps:
ApplicationWindow
open
An application window is also a suitable context in which to perform
long-running operations (that is, it implements IRunnableContext
).
Nested Class Summary |
Nested classes inherited from class org.eclipse.jface.window.Window |
Window.IExceptionHandler |
Field Summary |
Fields inherited from class org.eclipse.jface.window.Window |
CANCEL, OK |
Constructor Summary | |
ApplicationWindow(Shell parentShell)
Create an application window instance, whose shell will be created under the given parent shell. |
Method Summary | |
protected void |
addMenuBar()
Configures this window to have a menu bar. |
protected void |
addStatusLine()
Configures this window to have a status line. |
protected void |
addToolBar(int style)
Configures this window to have a tool bar. |
boolean |
close()
Closes this window, disposes its shell, and removes this window from its window manager (if it has one). |
protected void |
configureShell(Shell shell)
Configures the given shell in preparation for opening this window in it. |
protected MenuManager |
createMenuManager()
Returns a new menu manager for the window. |
protected StatusLineManager |
createStatusLineManager()
Returns a new status line manager for the window. |
protected Control |
createToolBarControl(Shell shell)
Creates the control for the tool bar manager. |
protected ToolBarManager |
createToolBarManager(int style)
Returns a new tool bar manager for the window. |
protected Font |
getFont()
Returns the default font used for this window. |
MenuManager |
getMenuBarManager()
Returns the menu bar manager for this window (if it has one). |
protected StatusLineManager |
getStatusLineManager()
Returns the status line manager for this window (if it has one). |
String |
getSymbolicFontName()
Returns the symbolic font name of the font to be used to display text in this window. |
protected Control |
getToolBarControl()
Returns the control for the window's toolbar. |
ToolBarManager |
getToolBarManager()
Returns the tool bar manager for this window (if it has one). |
void |
run(boolean fork,
boolean cancelable,
IRunnableWithProgress runnable)
Runs the given IRunnableWithProgress in this context. |
void |
setStatus(String message)
Sets or clears the message displayed in this window's status line (if it has one). |
protected boolean |
toolBarChildrenExist()
Returns whether or not children exist for the Application Window's toolbar control. |
Methods inherited from class org.eclipse.jface.window.Window |
constrainShellSize, create, createContents, createShell, getContents, getDefaultImage, getInitialLocation, getInitialSize, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, initializeBounds, open, setBlockOnOpen, setDefaultImage, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ApplicationWindow(Shell parentShell)
open
does not block.
parentShell
- the parent shell, or null
to create a top-level shellMethod Detail |
protected void addMenuBar()
protected void addStatusLine()
protected void addToolBar(int style)
public boolean close()
Window
This framework method may be extended (super.close
must be
called).
close
in class Window
true
if the window is (or was already) closed,
and false
if it is still openprotected void configureShell(Shell shell)
Window
The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
configureShell
in class Window
shell
- the shellprotected MenuManager createMenuManager()
Subclasses may override this method to customize the menu manager.
protected StatusLineManager createStatusLineManager()
Subclasses may override this method to customize the status line manager.
protected ToolBarManager createToolBarManager(int style)
Subclasses may override this method to customize the tool bar manager.
protected Control createToolBarControl(Shell shell)
Subclasses may override this method to customize the tool bar manager.
protected Font getFont()
The default implementation of this framework method
obtains the symbolic name of the font from the
getSymbolicFontName
framework method
and retrieves this font from JFace's font
registry using JFaceResources.getFont
.
Subclasses may override to use a different registry,
etc.
null
if nonepublic MenuManager getMenuBarManager()
null
if
this window does not have a menu baraddMenuBar()
protected StatusLineManager getStatusLineManager()
null
if
this window does not have a status lineaddStatusLine()
public String getSymbolicFontName()
public ToolBarManager getToolBarManager()
null
if
this window does not have a tool baraddToolBar(int)
protected Control getToolBarControl()
Subclasses may override this method to customize the tool bar manager.
public void run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) throws InvocationTargetException, InterruptedException
IRunnableContext
IRunnableWithProgress
in this context.
For example, if this is a ProgressMonitorDialog
then the runnable
is run using this dialog's progress monitor.
run
in interface IRunnableContext
fork
- true
if the runnable should be run in a separate thread,
and false
to run in the same threadcancelable
- true
to enable the cancelation, and
false
to make the operation uncancellablerunnable
- the runnable to run
InvocationTargetException
- wraps any exception or error which occurs
while running the runnable
InterruptedException
- propagated by the context if the runnable
acknowledges cancelation by throwing this exceptionpublic void setStatus(String message)
message
- the status message, or null
to clear itprotected boolean toolBarChildrenExist()
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |