|
Eclipse Platform Release 3.0 |
||||||||||
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.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 | |
protected Label |
seperator1
The seperator between the menu bar and the rest of the window. |
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 |
addCoolBar(int style)
Configures this window to have a cool bar. |
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. |
protected boolean |
canHandleShellCloseEvent()
Determines if the window should handle the close event or do nothing. |
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)
Extends the super implementation by creating the trim widgets using createTrimWidgets . |
protected boolean |
coolBarChildrenExist()
Returns whether or not children exist for this application window's cool bar control. |
protected Control |
createCoolBarControl(Composite composite)
Creates the control for the cool bar manager. |
protected CoolBarManager |
createCoolBarManager(int style)
Returns a new cool bar manager for the window. |
protected MenuManager |
createMenuManager()
Returns a new menu manager for the window. |
protected void |
createStatusLine(Shell shell)
Create the status line if required. |
protected StatusLineManager |
createStatusLineManager()
Returns a new status line manager for the window. |
protected Control |
createToolBarControl(Composite parent)
Creates the control for the tool bar manager. |
protected ToolBarManager |
createToolBarManager(int style)
Returns a new tool bar manager for the window. |
protected void |
createTrimWidgets(Shell shell)
Creates the trim widgets around the content area. |
protected Control |
getCoolBarControl()
Returns the control for the window's cool bar. |
CoolBarManager |
getCoolBarManager()
Returns the cool bar manager for this window. |
protected Font |
getFont()
Returns the default font used for this window. |
protected Layout |
getLayout()
Creates the layout for the shell. |
MenuManager |
getMenuBarManager()
Returns the menu bar manager for this window (if it has one). |
protected Label |
getSeperator1()
Return the top seperator. |
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 |
showTopSeperator()
Returns whether to show a top separator line between the menu bar and the rest of the window contents. |
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, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getInitialSize, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, initializeBounds, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Label seperator1
Constructor Detail |
public ApplicationWindow(Shell parentShell)
open
does not block.
parentShell
- the parent shell, or null
to create a top-level shellMethod Detail |
protected Label getSeperator1()
protected void addMenuBar()
protected void addStatusLine()
protected void addToolBar(int style)
protected void addCoolBar(int style)
style
- the cool bar styleprotected boolean canHandleShellCloseEvent()
Window
The default implementation of this framework method
returns true
, which will allow the
handleShellCloseEvent
method to be called.
Subclasses may extend or reimplement.
canHandleShellCloseEvent
in class Window
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)
createTrimWidgets
.
configureShell
in class Window
shell
- the shellprotected void createTrimWidgets(Shell shell)
shell
- the shellprotected Layout getLayout()
Window
A return value of null indicates that no layout should be attached to the composite. In this case, the layout may be attached within createContents.
getLayout
in class Window
protected boolean showTopSeperator()
true
to show the top separator, false
to not show itprotected void createStatusLine(Shell shell)
shell
- protected 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 CoolBarManager createCoolBarManager(int style)
Subclasses may override this method to customize the cool bar manager.
protected Control createToolBarControl(Composite parent)
Subclasses may override this method to customize the tool bar manager.
protected Control createCoolBarControl(Composite composite)
Subclasses may override this method to customize the cool bar manager.
CoolBar
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)
public CoolBarManager getCoolBarManager()
null
if
this window does not have a cool baraddCoolBar(int)
protected Control getToolBarControl()
Subclasses may override this method to customize the tool bar manager.
protected Control getCoolBarControl()
Subclasses may override this method to customize the cool bar manager.
CoolBar
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 exception. This should not be thrown
if cancelable is false
.public void setStatus(String message)
message
- the status message, or null
to clear itprotected boolean toolBarChildrenExist()
protected boolean coolBarChildrenExist()
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.