LayoutManager
, LayoutManager2
, Serializable
public class CardLayout extends Object implements LayoutManager2, Serializable
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 addLayoutComponent(java.awt.Component, java.lang.Object)
method can be used to associate a string identifier with a given card for fast random access.
Constructor | Description |
---|---|
CardLayout() |
Creates a new card layout with gaps of size zero. |
CardLayout |
Creates a new card layout with the specified horizontal and vertical gaps. |
Modifier and Type | Method | Description |
---|---|---|
void |
addLayoutComponent |
Adds the specified component to this card layout's internal table of names. |
void |
addLayoutComponent |
Deprecated. |
void |
first |
Flips to the first card of the container. |
int |
getHgap() |
Gets the horizontal gap between components. |
float |
getLayoutAlignmentX |
Returns the alignment along the x axis. |
float |
getLayoutAlignmentY |
Returns the alignment along the y axis. |
int |
getVgap() |
Gets the vertical gap between components. |
void |
invalidateLayout |
Invalidates the layout, indicating that if the layout manager has cached information it should be discarded. |
void |
last |
Flips to the last card of the container. |
void |
layoutContainer |
Lays out the specified container using this card layout. |
Dimension |
maximumLayoutSize |
Returns the maximum dimensions for this layout given the components in the specified target container. |
Dimension |
minimumLayoutSize |
Calculates the minimum size for the specified panel. |
void |
next |
Flips to the next card of the specified container. |
Dimension |
preferredLayoutSize |
Determines the preferred size of the container argument using this card layout. |
void |
previous |
Flips to the previous card of the specified container. |
void |
removeLayoutComponent |
Removes the specified component from the layout. |
void |
setHgap |
Sets the horizontal gap between components. |
void |
setVgap |
Sets the vertical gap between components. |
void |
show |
Flips to the component that was added to this layout with the specified name , using addLayoutComponent . |
String |
toString() |
Returns a string representation of the state of this card layout. |
public CardLayout()
public CardLayout(int hgap, int vgap)
hgap
- the horizontal gap.vgap
- the vertical gap.public int getHgap()
public void setHgap(int hgap)
hgap
- the horizontal gap between components.public int getVgap()
public void setVgap(int vgap)
vgap
- the vertical gap between components.public void addLayoutComponent(Component comp, Object constraints)
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.addLayoutComponent
in interface LayoutManager2
comp
- the component to be added.constraints
- a tag that identifies a particular card in the layout.IllegalArgumentException
- if the constraint is not a string.@Deprecated public void addLayoutComponent(String name, Component comp)
addLayoutComponent(Component, Object)
.LayoutManager
comp
to the layout, associating it with the string specified by name
.addLayoutComponent
in interface LayoutManager
name
- the string to be associated with the componentcomp
- the component to be addedpublic void removeLayoutComponent(Component comp)
removeLayoutComponent
in interface LayoutManager
comp
- the component to be removed.public Dimension preferredLayoutSize(Container parent)
preferredLayoutSize
in interface LayoutManager
parent
- the parent container in which to do the layoutpublic Dimension minimumLayoutSize(Container parent)
minimumLayoutSize
in interface LayoutManager
parent
- the parent container in which to do the layoutpublic Dimension maximumLayoutSize(Container target)
maximumLayoutSize
in interface LayoutManager2
target
- the component which needs to be laid outpublic float getLayoutAlignmentX(Container parent)
getLayoutAlignmentX
in interface LayoutManager2
parent
- the target containerpublic float getLayoutAlignmentY(Container parent)
getLayoutAlignmentY
in interface LayoutManager2
parent
- the target containerpublic void invalidateLayout(Container target)
invalidateLayout
in interface LayoutManager2
target
- the target containerpublic void layoutContainer(Container parent)
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.
layoutContainer
in interface LayoutManager
parent
- the parent container in which to do the layoutpublic void first(Container parent)
parent
- the parent container in which to do the layoutpublic void next(Container parent)
parent
- the parent container in which to do the layoutpublic void previous(Container parent)
parent
- the parent container in which to do the layoutpublic void last(Container parent)
parent
- the parent container in which to do the layoutpublic void show(Container parent, String name)
name
, using addLayoutComponent
. If no such component exists, then nothing happens.parent
- the parent container in which to do the layoutname
- the component namepublic String toString()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/CardLayout.html
addLayoutComponent(Component, Object)
.