JRootPane.RootLayout (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

Class JRootPane.RootLayout

java.lang.Object extended by javax.swing.JRootPane.RootLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2, Serializable

Enclosing class:

JRootPane

protected class JRootPane.RootLayout

extends Object

implements LayoutManager2, Serializable

A custom layout manager that is responsible for the layout of layeredPane, glassPane, and menuBar.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Constructor Summary
protected	JRootPane.RootLayout()

Method Summary
void	[addLayoutComponent](../../javax/swing/JRootPane.RootLayout.html#addLayoutComponent%28java.awt.Component, java.lang.Object%29)(Component comp,Object constraints) Adds the specified component to the layout, using the specified constraint object.
void	[addLayoutComponent](../../javax/swing/JRootPane.RootLayout.html#addLayoutComponent%28java.lang.String, java.awt.Component%29)(String name,Component comp) If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.
float	getLayoutAlignmentX(Container target) Returns the alignment along the x axis.
float	getLayoutAlignmentY(Container target) Returns the alignment along the y axis.
void	invalidateLayout(Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
void	layoutContainer(Container parent) Instructs the layout manager to perform the layout for the specified container.
Dimension	maximumLayoutSize(Container target) Returns the maximum amount of space the layout can use.
Dimension	minimumLayoutSize(Container parent) Returns the minimum amount of space the layout needs.
Dimension	preferredLayoutSize(Container parent) Returns the amount of space the layout would like to have.
void	removeLayoutComponent(Component comp) Removes the specified component from the layout.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

JRootPane.RootLayout

protected JRootPane.RootLayout()

Method Detail

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Returns the amount of space the layout would like to have.

Specified by:

[preferredLayoutSize](../../java/awt/LayoutManager.html#preferredLayoutSize%28java.awt.Container%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

parent - the Container for which this layout manager is being used

Returns:

a Dimension object containing the layout's preferred size

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Returns the minimum amount of space the layout needs.

Specified by:

[minimumLayoutSize](../../java/awt/LayoutManager.html#minimumLayoutSize%28java.awt.Container%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

parent - the Container for which this layout manager is being used

Returns:

a Dimension object containing the layout's minimum size

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

Returns the maximum amount of space the layout can use.

Specified by:

[maximumLayoutSize](../../java/awt/LayoutManager2.html#maximumLayoutSize%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

target - the Container for which this layout manager is being used

Returns:

a Dimension object containing the layout's maximum size

layoutContainer

public void layoutContainer(Container parent)

Instructs the layout manager to perform the layout for the specified container.

Specified by:

[layoutContainer](../../java/awt/LayoutManager.html#layoutContainer%28java.awt.Container%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

parent - the Container for which this layout manager is being used

addLayoutComponent

public void addLayoutComponent(String name, Component comp)

Description copied from interface: [LayoutManager](../../java/awt/LayoutManager.html#addLayoutComponent%28java.lang.String, java.awt.Component%29)

If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.

Specified by:

[addLayoutComponent](../../java/awt/LayoutManager.html#addLayoutComponent%28java.lang.String, java.awt.Component%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

name - the string to be associated with the component

comp - the component to be added

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Description copied from interface: [LayoutManager](../../java/awt/LayoutManager.html#removeLayoutComponent%28java.awt.Component%29)

Removes the specified component from the layout.

Specified by:

[removeLayoutComponent](../../java/awt/LayoutManager.html#removeLayoutComponent%28java.awt.Component%29) in interface [LayoutManager](../../java/awt/LayoutManager.html "interface in java.awt")

Parameters:

comp - the component to be removed

addLayoutComponent

public void addLayoutComponent(Component comp, Object constraints)

Description copied from interface: [LayoutManager2](../../java/awt/LayoutManager2.html#addLayoutComponent%28java.awt.Component, java.lang.Object%29)

Adds the specified component to the layout, using the specified constraint object.

Specified by:

[addLayoutComponent](../../java/awt/LayoutManager2.html#addLayoutComponent%28java.awt.Component, java.lang.Object%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Parameters:

comp - the component to be added

constraints - where/how the component is added to the layout.

getLayoutAlignmentX

public float getLayoutAlignmentX(Container target)

Description copied from interface: [LayoutManager2](../../java/awt/LayoutManager2.html#getLayoutAlignmentX%28java.awt.Container%29)

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

[getLayoutAlignmentX](../../java/awt/LayoutManager2.html#getLayoutAlignmentX%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

getLayoutAlignmentY

public float getLayoutAlignmentY(Container target)

Description copied from interface: [LayoutManager2](../../java/awt/LayoutManager2.html#getLayoutAlignmentY%28java.awt.Container%29)

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

[getLayoutAlignmentY](../../java/awt/LayoutManager2.html#getLayoutAlignmentY%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

invalidateLayout

public void invalidateLayout(Container target)

Description copied from interface: [LayoutManager2](../../java/awt/LayoutManager2.html#invalidateLayout%28java.awt.Container%29)

Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Specified by:

[invalidateLayout](../../java/awt/LayoutManager2.html#invalidateLayout%28java.awt.Container%29) in interface [LayoutManager2](../../java/awt/LayoutManager2.html "interface in java.awt")

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.