|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jdesktop.application.AbstractBean
org.jdesktop.application.View
public class View
A View encapsulates a top-level Application GUI component, like a JFrame
or an Applet, and its main GUI elements: a menu bar, tool bar, component,
and a status bar. All of the elements are optional (although a View without
a main component would be unusual). Views have a JRootPane
, which
is the root component for all of the Swing Window types as well as JApplet.
Setting a View property, like menuBar
or toolBar
, just
adds a component to the rootPane in a way that's defined by the View subclass.
By default the View elements are arranged in a conventional way:
menuBar
- becomes the rootPane's JMenuBar
toolBar
- added to BorderLayout.NORTH
of the rootPane's contentPane
component
- added to BorderLayout.CENTER
of the rootPane's contentPane
statusBar
- added to BorderLayout.SOUTH
of the rootPane's contentPane
To show or hide a View you call the corresponding Application methods. Here's a simple example:
class MyApplication extends SingleFrameApplication { @ppOverride protected void startup() { View view = getMainView(); view.setComponent(createMainComponent()); view.setMenuBar(createMenuBar()); show(view); } }
The advantage of Views over just configuring a JFrame or JApplet directly, is that a View is more easily moved to an alternative top level container, like a docking framework.
JRootPane
,
Application.show(View)
,
Application.hide(View)
Constructor Summary | |
---|---|
View(Application application)
Construct an empty View object for the specified Application. |
Method Summary | |
---|---|
Application |
getApplication()
Returns the Application that's responsible for showing/hiding this View. |
javax.swing.JComponent |
getComponent()
Returns the main JComponent for this View. |
ApplicationContext |
getContext()
Gets the ApplicationContext for the Application that's responsible for showing/hiding this View. |
javax.swing.JMenuBar |
getMenuBar()
Returns the main JMenuBar for this View. |
ResourceMap |
getResourceMap()
Gets ResourceMap for this View. |
javax.swing.JRootPane |
getRootPane()
Gets the JRootPane for this View. |
javax.swing.JComponent |
getStatusBar()
Returns the Status bar for this View. |
javax.swing.JToolBar |
getToolBar()
Gets the first tool bar for this View |
java.util.List<javax.swing.JToolBar> |
getToolBars()
Returns the list of tool bars for this View |
void |
setComponent(javax.swing.JComponent component)
Sets the single main Component for this View. |
void |
setMenuBar(javax.swing.JMenuBar menuBar)
Sets the menu bar for this View. |
void |
setStatusBar(javax.swing.JComponent statusBar)
Sets the status bar for this View. |
void |
setToolBar(javax.swing.JToolBar toolBar)
Sets the only tool bar for this View. |
void |
setToolBars(java.util.List<javax.swing.JToolBar> toolBars)
Sets the tool bars for this View |
Methods inherited from class org.jdesktop.application.AbstractBean |
---|
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public View(Application application)
application
- the Application responsible for showing/hiding this ViewApplication.show(View)
,
Application.hide(View)
Method Detail |
---|
public final Application getApplication()
Application
that's responsible for showing/hiding this View.
getContext()
,
Application.show(View)
,
Application.hide(View)
public final ApplicationContext getContext()
ApplicationContext
for the Application
that's responsible for showing/hiding this View.
This method is just shorthand for getApplication().getContext()
.
getApplication()
,
Application.show(View)
,
Application.hide(View)
public ResourceMap getResourceMap()
ResourceMap
for this View.
This method invokes getContext().getResourceMap(getClass(), View.class)
.
The result is cached.
ResourceMap
for this ViewgetContext()
public javax.swing.JRootPane getRootPane()
JRootPane
for this View. All of the components for this
View must be added to its rootPane. Most applications will do so
by setting the View's component
, menuBar
, toolBar
,
and statusBar
properties.
rootPane
for this ViewsetComponent(javax.swing.JComponent)
,
setMenuBar(javax.swing.JMenuBar)
,
setToolBar(javax.swing.JToolBar)
,
setStatusBar(javax.swing.JComponent)
public javax.swing.JComponent getComponent()
JComponent
for this View.
component
for this ViewsetComponent(javax.swing.JComponent)
public void setComponent(javax.swing.JComponent component)
BorderLayout.CENTER
of the rootPane's contentPane. If
the component property was already set, the old component is removed
first.
This is a bound property. The default value is null.
component
- The component
for this ViewgetComponent()
public javax.swing.JMenuBar getMenuBar()
JMenuBar
for this View.
menuBar
for this ViewsetMenuBar(javax.swing.JMenuBar)
public void setMenuBar(javax.swing.JMenuBar menuBar)
This is a bound property. The default value is null.
menuBar
- The menuBar
for this ViewgetMenuBar()
public java.util.List<javax.swing.JToolBar> getToolBars()
public void setToolBars(java.util.List<javax.swing.JToolBar> toolBars)
This is a bound property. The default value is an empty list.
toolBars
- setToolBar(JToolBar)
,
getToolBars()
public final javax.swing.JToolBar getToolBar()
JToolBar
for this ViewsetToolBars(java.util.List)
,
getToolBars()
,
setToolBar(javax.swing.JToolBar)
public final void setToolBar(javax.swing.JToolBar toolBar)
This is a bound property.
toolBar
- The JToolBar
for this view. If null
resets the tool bar.getToolBar()
,
setToolBars(List)
,
getToolBars()
public javax.swing.JComponent getStatusBar()
JComponent
for this Viewpublic void setStatusBar(javax.swing.JComponent statusBar)
JComponent
.
statusBar
- The status bar JComponent
for this View
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |