Package org.jdesktop.swingx
Class JXRootPane
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JRootPane
-
- org.jdesktop.swingx.JXRootPane
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
@JavaBean public class JXRootPane extends javax.swing.JRootPane
Extends the JRootPane by supporting specific placements for a toolbar and a status bar. If a status bar exists, then toolbars, menus will be registered with the status bar.- See Also:
JXStatusBar
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
JXRootPane.XRootLayout
An extendedRootLayout
offering support for managing the status bar.-
Nested classes/interfaces inherited from class javax.swing.JRootPane
javax.swing.JRootPane.AccessibleJRootPane, javax.swing.JRootPane.RootLayout
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description private javax.swing.JButton
cancelButton
The button that gets activated when the pane has the focus and a UI-specific action like pressing the ESC key occurs.protected JXStatusBar
statusBar
The current status bar for this root pane.private javax.swing.JToolBar
toolBar
-
Fields inherited from class javax.swing.JRootPane
COLOR_CHOOSER_DIALOG, contentPane, defaultButton, ERROR_DIALOG, FILE_CHOOSER_DIALOG, FRAME, glassPane, INFORMATION_DIALOG, layeredPane, menuBar, NONE, PLAIN_DIALOG, QUESTION_DIALOG, WARNING_DIALOG
-
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
-
-
Constructor Summary
Constructors Constructor Description JXRootPane()
Creates an extended root pane.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.awt.Container
createContentPane()
protected java.awt.LayoutManager
createRootLayout()
javax.swing.JButton
getCancelButton()
Returns the value of thecancelButton
property.JXStatusBar
getStatusBar()
Gets the currently installed status bar.javax.swing.JToolBar
getToolBar()
The currently installed tool bar.private void
installKeyboardActions()
PENDING: move to UIprivate void
registerStatusBar(java.awt.Component comp)
void
setCancelButton(javax.swing.JButton cancelButton)
Sets thecancelButton
property, which determines the current default cancel button for thisJRootPane
.void
setLayout(java.awt.LayoutManager layout)
void
setStatusBar(JXStatusBar statusBar)
Set the status bar for this root pane.void
setToolBar(javax.swing.JToolBar toolBar)
Set the toolbar bar for this root pane.private void
unregisterStatusBar(java.awt.Component comp)
-
Methods inherited from class javax.swing.JRootPane
addImpl, addNotify, createGlassPane, createLayeredPane, getAccessibleContext, getContentPane, getDefaultButton, getGlassPane, getJMenuBar, getLayeredPane, getMenuBar, getUI, getUIClassID, getWindowDecorationStyle, isOptimizedDrawingEnabled, isValidateRoot, paramString, removeNotify, setContentPane, setDefaultButton, setDoubleBuffered, setGlassPane, setJMenuBar, setLayeredPane, setMenuBar, setUI, setWindowDecorationStyle, updateUI
-
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
-
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
statusBar
protected JXStatusBar statusBar
The current status bar for this root pane.
-
toolBar
private javax.swing.JToolBar toolBar
-
cancelButton
private javax.swing.JButton cancelButton
The button that gets activated when the pane has the focus and a UI-specific action like pressing the ESC key occurs.
-
-
Method Detail
-
createContentPane
protected java.awt.Container createContentPane()
- Overrides:
createContentPane
in classjavax.swing.JRootPane
-
setLayout
public void setLayout(java.awt.LayoutManager layout)
- Overrides:
setLayout
in classjava.awt.Container
-
createRootLayout
protected java.awt.LayoutManager createRootLayout()
- Overrides:
createRootLayout
in classjavax.swing.JRootPane
-
installKeyboardActions
private void installKeyboardActions()
PENDING: move to UI
-
registerStatusBar
private void registerStatusBar(java.awt.Component comp)
-
unregisterStatusBar
private void unregisterStatusBar(java.awt.Component comp)
-
setStatusBar
public void setStatusBar(JXStatusBar statusBar)
Set the status bar for this root pane. Any components held by this root pane will be registered. If this is replacing an existing status bar then the existing component will be unregistered from the old status bar.- Parameters:
statusBar
- the status bar to use
-
getStatusBar
public JXStatusBar getStatusBar()
Gets the currently installed status bar.- Returns:
- the current status bar
-
setToolBar
public void setToolBar(javax.swing.JToolBar toolBar)
Set the toolbar bar for this root pane. If a tool bar is currently registered with thisJXRootPane
, then it is removed prior to setting the new tool bar. If an implementation needs to handle more than one tool bar, a subclass will need to override the singleton logic used here or manually add toolbars withgetContentPane().add
.- Parameters:
toolBar
- the toolbar to register
-
getToolBar
public javax.swing.JToolBar getToolBar()
The currently installed tool bar.- Returns:
- the current tool bar
-
setCancelButton
public void setCancelButton(javax.swing.JButton cancelButton)
Sets thecancelButton
property, which determines the current default cancel button for thisJRootPane
. The cancel button is the button which will be activated when a UI-defined activation event (typically the ESC key) occurs in the root pane regardless of whether or not the button has keyboard focus (unless there is another component within the root pane which consumes the activation event, such as aJTextPane
). For default activation to work, the button must be an enabled descendant of the root pane when activation occurs. To remove a cancel button from this root pane, set this property tonull
.- Parameters:
cancelButton
- theJButton
which is to be the cancel button- See Also:
getCancelButton()
-
getCancelButton
public javax.swing.JButton getCancelButton()
Returns the value of thecancelButton
property.- Returns:
- the
JButton
which is currently the default cancel button - See Also:
setCancelButton(javax.swing.JButton)
-
-