javax.swing

Class JRootPane

public class JRootPane extends JComponent implements Accessible

This class is where JComponents are added to. Unlike awt where you could just say frame.add(), with swing you need to say frame.getRootPane() (which delivers an instance of this class) and add your components to that. It is implemented by several 'layers' (pane() should be read as plane()) each on top of the others where you can add components to. (getContentPane(), getGlassPane(), getLayeredPane())

Nested Class Summary
protected class	JRootPane.AccessibleJRootPane
protected class	JRootPane.RootLayout

Field Summary
protected Container	contentPane DOCUMENT ME!
static int	COLOR_CHOOSER_DIALOG
protected JButton	defaultButton
protected Action	defaultPressAction This field is unused since JDK1.3.
protected Action	defaultReleaseAction This field is unused since JDK1.3.
static int	ERROR_DIALOG
static int	FILE_CHOOSER_DIALOG
static int	FRAME
protected Component	glassPane DOCUMENT ME!
static int	INFORMATION_DIALOG
protected JLayeredPane	layeredPane DOCUMENT ME!
protected JMenuBar	menuBar DOCUMENT ME!
static int	NONE
static int	PLAIN_DIALOG
static int	QUESTION_DIALOG
static int	WARNING_DIALOG

Constructor Summary
	JRootPane() Creates a new `JRootPane` object.

Method Summary
protected void	addImpl(Component comp, Object constraints, int index) DOCUMENT ME!
protected Container	createContentPane() DOCUMENT ME!
protected Component	createGlassPane() DOCUMENT ME!
protected JLayeredPane	createLayeredPane() DOCUMENT ME!
protected LayoutManager	createRootLayout() DOCUMENT ME!
AccessibleContext	getAccessibleContext() Returns the accessible context for this JRootPane.
Container	getContentPane() DOCUMENT ME!
JButton	getDefaultButton()
Component	getGlassPane() DOCUMENT ME!
JMenuBar	getJMenuBar() DOCUMENT ME!
JLayeredPane	getLayeredPane() DOCUMENT ME!
JMenuBar	getMenuBar()
RootPaneUI	getUI() DOCUMENT ME!
String	getUIClassID() DOCUMENT ME!
int	getWindowDecorationStyle()
boolean	isOptimizedDrawingEnable() This returns `true` if the `glassPane` is not visible because then the root pane can guarantee to tile its children (the only other direct child is a JLayeredPane which must figure its `optimizeDrawingEnabled` state on its own).
boolean	isValidateRoot() DOCUMENT ME!
void	setContentPane(Container p) Sets the JRootPane's content pane.
void	setDefaultButton(JButton newButton)
void	setGlassPane(Component f) DOCUMENT ME!
void	setJMenuBar(JMenuBar m) DOCUMENT ME!
void	setLayeredPane(JLayeredPane f) Set the layered pane for the root pane.
void	setMenuBar(JMenuBar m)
void	setUI(RootPaneUI ui) DOCUMENT ME!
void	setWindowDecorationStyle(int style)
void	updateUI() DOCUMENT ME!

Field Detail

contentPane

protected Container contentPane

DOCUMENT ME!

COLOR_CHOOSER_DIALOG

public static final int COLOR_CHOOSER_DIALOG

defaultButton

protected JButton defaultButton

defaultPressAction

protected Action defaultPressAction

Deprecated: since JDK1.3

This field is unused since JDK1.3. To override the default action you should modify the JRootPane's ActionMap.

UNKNOWN: the specs indicate that the type of this field is a package private inner class javax.swing.JRootPane.DefaultAction. I assume that the closest public superclass is javax.swing.Action.

defaultReleaseAction

protected Action defaultReleaseAction

Deprecated: since JDK1.3

This field is unused since JDK1.3. To override the default action you should modify the JRootPane's ActionMap.

UNKNOWN: the specs indicate that the type of this field is a package private inner class javax.swing.JRootPane.DefaultAction. I assume that the closest public superclass is javax.swing.Action.

ERROR_DIALOG

public static final int ERROR_DIALOG

FILE_CHOOSER_DIALOG

public static final int FILE_CHOOSER_DIALOG

FRAME

public static final int FRAME

glassPane

protected Component glassPane

DOCUMENT ME!

INFORMATION_DIALOG

public static final int INFORMATION_DIALOG

layeredPane

protected JLayeredPane layeredPane

DOCUMENT ME!

menuBar

protected JMenuBar menuBar

DOCUMENT ME!

NONE

public static final int NONE

PLAIN_DIALOG

public static final int PLAIN_DIALOG

QUESTION_DIALOG

public static final int QUESTION_DIALOG

WARNING_DIALOG

public static final int WARNING_DIALOG

Constructor Detail

JRootPane

public JRootPane()

Creates a new JRootPane object.

Method Detail

addImpl

protected void addImpl(Component comp, Object constraints, int index)

DOCUMENT ME!

Parameters: comp DOCUMENT ME! constraints DOCUMENT ME! index DOCUMENT ME!

createContentPane

protected Container createContentPane()

DOCUMENT ME!

Returns: DOCUMENT ME!

createGlassPane

protected Component createGlassPane()

DOCUMENT ME!

Returns: DOCUMENT ME!

createLayeredPane

protected JLayeredPane createLayeredPane()

DOCUMENT ME!

Returns: DOCUMENT ME!

createRootLayout

protected LayoutManager createRootLayout()

DOCUMENT ME!

Returns: DOCUMENT ME!

getAccessibleContext

public AccessibleContext getAccessibleContext()

Returns the accessible context for this JRootPane. This will be an instance of {@link AccessibleJRootPane}.

Returns: the accessible context for this JRootPane

getContentPane

public Container getContentPane()

DOCUMENT ME!

Returns: DOCUMENT ME!

getDefaultButton

public JButton getDefaultButton()

getGlassPane

public Component getGlassPane()

DOCUMENT ME!

Returns: DOCUMENT ME!

getJMenuBar

public JMenuBar getJMenuBar()

DOCUMENT ME!

Returns: DOCUMENT ME!

getLayeredPane

public JLayeredPane getLayeredPane()

DOCUMENT ME!

Returns: DOCUMENT ME!

getMenuBar

public JMenuBar getMenuBar()

Deprecated: Replaced by getJMenuBar()

getUI

public RootPaneUI getUI()

DOCUMENT ME!

Returns: DOCUMENT ME!

getUIClassID

public String getUIClassID()

DOCUMENT ME!

Returns: DOCUMENT ME!

getWindowDecorationStyle

public int getWindowDecorationStyle()

Since: 1.4

isOptimizedDrawingEnable

public boolean isOptimizedDrawingEnable()

This returns true if the glassPane is not visible because then the root pane can guarantee to tile its children (the only other direct child is a JLayeredPane which must figure its optimizeDrawingEnabled state on its own).

Returns: true if the glassPane is not visible

isValidateRoot

public boolean isValidateRoot()

DOCUMENT ME!

Returns: DOCUMENT ME!

setContentPane

public void setContentPane(Container p)

Sets the JRootPane's content pane. The content pane should typically be opaque for painting to work properly. This method also removes the old content pane from the layered pane.

Parameters: p the Container that will be the content pane

Throws: IllegalComponentStateException if p is null