: Class CardLayout

java.lang.Object
  |
  +--java.awt.CardLayout

All Implemented Interfaces:: LayoutManager, LayoutManager2, Serializable

public class CardLayout
extends Object
implements LayoutManager2, Serializable

A CardLayout object is a layout manager for a container. It treats each component in the container as a card. Only one card is visible at a time, and the container acts as a stack of cards. The first component added to a CardLayout object is the visible component when the container is first displayed.

The ordering of cards is determined by the container's own internal ordering of its component objects. CardLayout defines a set of methods that allow an application to flip through these cards sequentially, or to show a specified card. The CardLayou#addLayoutComponent method can be used to associate a string identifier with a given card for fast random access.

Since:: JDK1.0
See Also:: Container, Serialized Form

Constructor Summary

CardLayout
copy-> new CardLayout()
copy-> <CardLayout var> = new CardLayout();

Creates a new card layout with gaps of size zero.

CardLayout
copy-> new CardLayout(, )
copy-> <CardLayout var> = new CardLayout(<int hgap>, <int vgap>);

Creates a new card layout with the specified horizontal and vertical gaps. The horizontal gaps are placed at the left and right edges. The vertical gaps are placed at the top and bottom edges.

Parameters:
hgap - the horizontal gap.
vgap - the vertical gap.

Method Summary

void addLayoutComponent(Component comp, Object constraints)
copy-> .addLayoutComponent(, )
copy-> <CardLayout>.addLayoutComponent(<Component comp>, <Object constraints>);

Adds the specified component to this card layout's internal table of names. The object specified by constraints must be a string. The card layout stores this string as a key-value pair that can be used for random access to a particular card. By calling the show method, an application can display the component with the specified name.

Specified by:
addLayoutComponent in interface LayoutManager2

Parameters:
comp - the component to be added.
constraints - a tag that identifies a particular card in the layout.
Throws:
IllegalArgumentException - if the constraint is not a string.
See Also:
show(java.awt.Container, java.lang.String)

void addLayoutComponent(String name, Component comp)
copy-> .addLayoutComponent(, )
copy-> <CardLayout>.addLayoutComponent(<String name>, <Component comp>);

Adds the specified component with the specified name to the layout.

Specified by:
addLayoutComponent in interface LayoutManager

Following copied from interface: java.awt.LayoutManager

Parameters:
name - the component name
comp - the component to be added

void first(Container parent)
copy-> .first( )
copy-> <CardLayout>.first(<Container parent>);

Flips to the first card of the container.

Parameters:
parent - the name of the parent container in which to do the layout.
See Also:
last(java.awt.Container)

int getHgap()
copy-> .getHgap()
copy-> <int var>=<CardLayout>.getHgap();

Gets the horizontal gap between components.

Returns:
the horizontal gap between components.
Since:
JDK1.1

See Also:
setHgap(int), getVgap()

float getLayoutAlignmentX(Container parent)
copy-> .getLayoutAlignmentX( )
copy-> <float var>=<CardLayout>.getLayoutAlignmentX(<Container parent>);

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 in interface LayoutManager2

float getLayoutAlignmentY(Container parent)
copy-> .getLayoutAlignmentY( )
copy-> <float var>=<CardLayout>.getLayoutAlignmentY(<Container parent>);

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 in interface LayoutManager2

int getVgap()
copy-> .getVgap()
copy-> <int var>=<CardLayout>.getVgap();

Gets the vertical gap between components.

Returns:
the vertical gap between components.
See Also:
setVgap(int), getHgap()

void invalidateLayout(Container target)
copy-> .invalidateLayout( )
copy-> <CardLayout>.invalidateLayout(<Container target>);

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

Specified by:
invalidateLayout in interface LayoutManager2

void last(Container parent)
copy-> .last( )
copy-> <CardLayout>.last(<Container parent>);

Flips to the last card of the container.

Parameters:
parent - the name of the parent container in which to do the layout.
See Also:
first(java.awt.Container)

void layoutContainer(Container parent)
copy-> .layoutContainer( )
copy-> <CardLayout>.layoutContainer(<Container parent>);

Lays out the specified container using this card layout.
Each component in the parent container is reshaped to be the size of the container, minus space for surrounding insets, horizontal gaps, and vertical gaps.

Specified by:
layoutContainer in interface LayoutManager

Parameters:
parent - the name of the parent container in which to do the layout.
See Also:
Container.doLayout()

Dimension maximumLayoutSize(Container target)
copy-> .maximumLayoutSize( )
copy-> <Dimension var>=<CardLayout>.maximumLayoutSize(<Container target>);

Returns the maximum dimensions for this layout given the components in the specified target container.

Specified by:
maximumLayoutSize in interface LayoutManager2

Parameters:
target - the component which needs to be laid out
See Also:
Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)

Dimension minimumLayoutSize(Container parent)
copy-> .minimumLayoutSize( )
copy-> <Dimension var>=<CardLayout>.minimumLayoutSize(<Container parent>);

Calculates the minimum size for the specified panel.

Specified by:
minimumLayoutSize in interface LayoutManager

Parameters:
parent - the name of the parent container in which to do the layout.
Returns:
the minimum dimensions required to lay out the subcomponents of the specified container.
See Also:
Container.doLayout(), preferredLayoutSize(java.awt.Container)

void next(Container parent)
copy-> .next( )
copy-> <CardLayout>.next(<Container parent>);

Flips to the next card of the specified container. If the currently visible card is the last one, this method flips to the first card in the layout.

Parameters:
parent - the name of the parent container in which to do the layout.
See Also:
previous(java.awt.Container)

Dimension preferredLayoutSize(Container parent)
copy-> .preferredLayoutSize( )
copy-> <Dimension var>=<CardLayout>.preferredLayoutSize(<Container parent>);

Determines the preferred size of the container argument using this card layout.

Specified by:
preferredLayoutSize in interface LayoutManager

Parameters:
parent - the name of the parent container.
Returns:
the preferred dimensions to lay out the subcomponents of the specified container.
See Also:
Container.getPreferredSize(), minimumLayoutSize(java.awt.Container)

void previous(Container parent)
copy-> .previous( )
copy-> <CardLayout>.previous(<Container parent>);

Flips to the previous card of the specified container. If the currently visible card is the first one, this method flips to the last card in the layout.

Parameters:
parent - the name of the parent container in which to do the layout.
See Also:
next(java.awt.Container)

void removeLayoutComponent(Component comp)
copy-> .removeLayoutComponent( )
copy-> <CardLayout>.removeLayoutComponent(<Component comp>);

Removes the specified component from the layout.

Specified by:
removeLayoutComponent in interface LayoutManager

Parameters:
comp - the component to be removed.
See Also:
Container.remove(java.awt.Component), Container.removeAll()

void setHgap(int hgap)
copy-> .setHgap( )
copy-> <CardLayout>.setHgap(<int hgap>);

Sets the horizontal gap between components.

Parameters:
hgap - the horizontal gap between components.
Since:
JDK1.1

See Also:
getHgap(), setVgap(int)

void setVgap(int vgap)
copy-> .setVgap( )
copy-> <CardLayout>.setVgap(<int vgap>);

Sets the vertical gap between components.

Parameters:
vgap - the vertical gap between components.
Since:
JDK1.1

See Also:
getVgap(), setHgap(int)

void show(Container parent, String name)
copy-> .show(, )
copy-> <CardLayout>.show(<Container parent>, <String name>);

Flips to the component that was added to this layout with the specified name, using addLayoutComponent. If no such component exists, then nothing happens.

Parameters:
parent - the name of the parent container in which to do the layout.
name - the component name.
See Also:
addLayoutComponent(java.awt.Component, java.lang.Object)

String toString()
copy-> .toString()
copy-> <String var>=<CardLayout>.toString();

Returns a string representation of the state of this card layout.

Overrides:
toString in class Object

Returns:
a string representation of this card layout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

Constructor Summary
CardLayout copy-> `new CardLayout()` copy-> `<CardLayout var> = new CardLayout();` Creates a new card layout with gaps of size zero.
CardLayout copy-> `new CardLayout(, )` copy-> `<CardLayout var> = new CardLayout(<int hgap>, <int vgap>);` Creates a new card layout with the specified horizontal and vertical gaps. The horizontal gaps are placed at the left and right edges. The vertical gaps are placed at the top and bottom edges. Parameters: `hgap` - the horizontal gap. `vgap` - the vertical gap.

Method Summary
`void`	addLayoutComponent(Component comp, Object constraints) copy-> `.addLayoutComponent(, )` copy-> `<CardLayout>.addLayoutComponent(<Component comp>, <Object constraints>);` Adds the specified component to this card layout's internal table of names. The object specified by `constraints` must be a string. The card layout stores this string as a key-value pair that can be used for random access to a particular card. By calling the `show` method, an application can display the component with the specified name. Specified by: `addLayoutComponent` in interface `LayoutManager2` Parameters: `comp` - the component to be added. `constraints` - a tag that identifies a particular card in the layout. Throws: `IllegalArgumentException` - if the constraint is not a string. See Also: `show(java.awt.Container, java.lang.String)`
`void`	addLayoutComponent(String name, Component comp) copy-> `.addLayoutComponent(, )` copy-> `<CardLayout>.addLayoutComponent(<String name>, <Component comp>);` Adds the specified component with the specified name to the layout. Specified by: `addLayoutComponent` in interface `LayoutManager` Following copied from interface: `java.awt.LayoutManager` Parameters: `name` - the component name `comp` - the component to be added
`void`	first(Container parent) copy-> `.first( )` copy-> `<CardLayout>.first(<Container parent>);` Flips to the first card of the container. Parameters: `parent` - the name of the parent container in which to do the layout. See Also: `last(java.awt.Container)`
`int`	getHgap() copy-> `.getHgap()` copy-> `<int var>=<CardLayout>.getHgap();` Gets the horizontal gap between components. Returns: the horizontal gap between components. Since: JDK1.1 See Also: `setHgap(int)`, `getVgap()`
`float`	getLayoutAlignmentX(Container parent) copy-> `.getLayoutAlignmentX( )` copy-> `<float var>=<CardLayout>.getLayoutAlignmentX(<Container parent>);` 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` in interface `LayoutManager2`
`float`	getLayoutAlignmentY(Container parent) copy-> `.getLayoutAlignmentY( )` copy-> `<float var>=<CardLayout>.getLayoutAlignmentY(<Container parent>);` 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` in interface `LayoutManager2`
`int`	getVgap() copy-> `.getVgap()` copy-> `<int var>=<CardLayout>.getVgap();` Gets the vertical gap between components. Returns: the vertical gap between components. See Also: `setVgap(int)`, `getHgap()`
`void`	invalidateLayout(Container target) copy-> `.invalidateLayout( )` copy-> `<CardLayout>.invalidateLayout(<Container target>);` Invalidates the layout, indicating that if the layout manager has cached information it should be discarded. Specified by: `invalidateLayout` in interface `LayoutManager2`
`void`	last(Container parent) copy-> `.last( )` copy-> `<CardLayout>.last(<Container parent>);` Flips to the last card of the container. Parameters: `parent` - the name of the parent container in which to do the layout. See Also: `first(java.awt.Container)`
`void`	layoutContainer(Container parent) copy-> `.layoutContainer( )` copy-> `<CardLayout>.layoutContainer(<Container parent>);` Lays out the specified container using this card layout. Each component in the `parent` container is reshaped to be the size of the container, minus space for surrounding insets, horizontal gaps, and vertical gaps. Specified by: `layoutContainer` in interface `LayoutManager` Parameters: `parent` - the name of the parent container in which to do the layout. See Also: `Container.doLayout()`
`Dimension`	maximumLayoutSize(Container target) copy-> `.maximumLayoutSize( )` copy-> `<Dimension var>=<CardLayout>.maximumLayoutSize(<Container target>);` Returns the maximum dimensions for this layout given the components in the specified target container. Specified by: `maximumLayoutSize` in interface `LayoutManager2` Parameters: `target` - the component which needs to be laid out See Also: `Container`, `minimumLayoutSize(java.awt.Container)`, `preferredLayoutSize(java.awt.Container)`
`Dimension`	minimumLayoutSize(Container parent) copy-> `.minimumLayoutSize( )` copy-> `<Dimension var>=<CardLayout>.minimumLayoutSize(<Container parent>);` Calculates the minimum size for the specified panel. Specified by: `minimumLayoutSize` in interface `LayoutManager` Parameters: `parent` - the name of the parent container in which to do the layout. Returns: the minimum dimensions required to lay out the subcomponents of the specified container. See Also: `Container.doLayout()`, `preferredLayoutSize(java.awt.Container)`
`void`	next(Container parent) copy-> `.next( )` copy-> `<CardLayout>.next(<Container parent>);` Flips to the next card of the specified container. If the currently visible card is the last one, this method flips to the first card in the layout. Parameters: `parent` - the name of the parent container in which to do the layout. See Also: `previous(java.awt.Container)`
`Dimension`	preferredLayoutSize(Container parent) copy-> `.preferredLayoutSize( )` copy-> `<Dimension var>=<CardLayout>.preferredLayoutSize(<Container parent>);` Determines the preferred size of the container argument using this card layout. Specified by: `preferredLayoutSize` in interface `LayoutManager` Parameters: `parent` - the name of the parent container. Returns: the preferred dimensions to lay out the subcomponents of the specified container. See Also: `Container.getPreferredSize()`, `minimumLayoutSize(java.awt.Container)`
`void`	previous(Container parent) copy-> `.previous( )` copy-> `<CardLayout>.previous(<Container parent>);` Flips to the previous card of the specified container. If the currently visible card is the first one, this method flips to the last card in the layout. Parameters: `parent` - the name of the parent container in which to do the layout. See Also: `next(java.awt.Container)`
`void`	removeLayoutComponent(Component comp) copy-> `.removeLayoutComponent( )` copy-> `<CardLayout>.removeLayoutComponent(<Component comp>);` Removes the specified component from the layout. Specified by: `removeLayoutComponent` in interface `LayoutManager` Parameters: `comp` - the component to be removed. See Also: `Container.remove(java.awt.Component)`, `Container.removeAll()`
`void`	setHgap(int hgap) copy-> `.setHgap( )` copy-> `<CardLayout>.setHgap(<int hgap>);` Sets the horizontal gap between components. Parameters: `hgap` - the horizontal gap between components. Since: JDK1.1 See Also: `getHgap()`, `setVgap(int)`
`void`	setVgap(int vgap) copy-> `.setVgap( )` copy-> `<CardLayout>.setVgap(<int vgap>);` Sets the vertical gap between components. Parameters: `vgap` - the vertical gap between components. Since: JDK1.1 See Also: `getVgap()`, `setHgap(int)`
`void`	show(Container parent, String name) copy-> `.show(, )` copy-> `<CardLayout>.show(<Container parent>, <String name>);` Flips to the component that was added to this layout with the specified `name`, using `addLayoutComponent`. If no such component exists, then nothing happens. Parameters: `parent` - the name of the parent container in which to do the layout. `name` - the component name. See Also: `addLayoutComponent(java.awt.Component, java.lang.Object)`
`String`	toString() copy-> `.toString()` copy-> `<String var>=<CardLayout>.toString();` Returns a string representation of the state of this card layout. Overrides: `toString` in class `Object` Returns: a string representation of this card layout.

java.awt Class CardLayout

java.awt
Class CardLayout