Java Doc for CardLayout.java in  » 6.0-JDK-Core » AWT » java » awt » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » AWT » java.awt 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.CardLayout

CardLayout
public class CardLayout implements LayoutManager2,Serializable(Code)
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 CardLayout.addLayoutComponent method can be used to associate a string identifier with a given card for fast random access.
version:
   1.49 05/05/07
author:
   Arthur van Hoff
See Also:   java.awt.Container
since:
   JDK1.0


Inner Class :class Card implements Serializable

Field Summary
 intcurrentCard
    
 inthgap
    
 Vectorvector
    
 intvgap
    

Constructor Summary
public  CardLayout()
     Creates a new card layout with gaps of size zero.
public  CardLayout(int hgap, int vgap)
     Creates a new card layout with the specified horizontal and vertical gaps.

Method Summary
public  voidaddLayoutComponent(Component comp, Object constraints)
     Adds the specified component to this card layout's internal table of names.
public  voidaddLayoutComponent(String name, Component comp)
    
 voidcheckLayout(Container parent)
     Make sure that the Container really has a CardLayout installed.
public  voidfirst(Container parent)
     Flips to the first card of the container.
public  intgetHgap()
     Gets the horizontal gap between components.
public  floatgetLayoutAlignmentX(Container parent)
     Returns the alignment along the x axis.
public  floatgetLayoutAlignmentY(Container parent)
     Returns the alignment along the y axis.
public  intgetVgap()
     Gets the vertical gap between components.
public  voidinvalidateLayout(Container target)
     Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
public  voidlast(Container parent)
     Flips to the last card of the container.
public  voidlayoutContainer(Container parent)
     Lays out the specified container using this card layout.
public  DimensionmaximumLayoutSize(Container target)
     Returns the maximum dimensions for this layout given the components in the specified target container.
public  DimensionminimumLayoutSize(Container parent)
     Calculates the minimum size for the specified panel.
public  voidnext(Container parent)
     Flips to the next card of the specified container.
public  DimensionpreferredLayoutSize(Container parent)
     Determines the preferred size of the container argument using this card layout.
public  voidprevious(Container parent)
     Flips to the previous card of the specified container.
public  voidremoveLayoutComponent(Component comp)
     Removes the specified component from the layout.
public  voidsetHgap(int hgap)
     Sets the horizontal gap between components.
public  voidsetVgap(int vgap)
     Sets the vertical gap between components.
public  voidshow(Container parent, String name)
     Flips to the component that was added to this layout with the specified name, using addLayoutComponent.
 voidshowDefaultComponent(Container parent)
    
public  StringtoString()
     Returns a string representation of the state of this card layout.

Field Detail
currentCard
int currentCard(Code)



hgap
int hgap(Code)



vector
Vector vector(Code)



vgap
int vgap(Code)




Constructor Detail
CardLayout
public CardLayout()(Code)
Creates a new card layout with gaps of size zero.



CardLayout
public CardLayout(int hgap, int vgap)(Code)
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.
Parameters:
  vgap - the vertical gap.




Method Detail
addLayoutComponent
public void addLayoutComponent(Component comp, Object constraints)(Code)
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.
Parameters:
  comp - the component to be added.
Parameters:
  constraints - a tag that identifies a particularcard in the layout.
See Also:   java.awt.CardLayout.show(java.awt.Containerjava.lang.String)
exception:
  IllegalArgumentException - if the constraint is not a string.



addLayoutComponent
public void addLayoutComponent(String name, Component comp)(Code)



checkLayout
void checkLayout(Container parent)(Code)
Make sure that the Container really has a CardLayout installed. Otherwise havoc can ensue!



first
public void first(Container parent)(Code)
Flips to the first card of the container.
Parameters:
  parent - the parent container in which to do the layout
See Also:   java.awt.CardLayout.last



getHgap
public int getHgap()(Code)
Gets the horizontal gap between components. the horizontal gap between components.
See Also:   java.awt.CardLayout.setHgap(int)
See Also:   java.awt.CardLayout.getVgap
since:
   JDK1.1



getLayoutAlignmentX
public float getLayoutAlignmentX(Container parent)(Code)
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.



getLayoutAlignmentY
public float getLayoutAlignmentY(Container parent)(Code)
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.



getVgap
public int getVgap()(Code)
Gets the vertical gap between components. the vertical gap between components.
See Also:   java.awt.CardLayout.setVgap(int)
See Also:   java.awt.CardLayout.getHgap



invalidateLayout
public void invalidateLayout(Container target)(Code)
Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.



last
public void last(Container parent)(Code)
Flips to the last card of the container.
Parameters:
  parent - the parent container in which to do the layout
See Also:   java.awt.CardLayout.first



layoutContainer
public void layoutContainer(Container parent)(Code)
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.
Parameters:
  parent - the parent container in which to do the layout
See Also:   java.awt.Container.doLayout




maximumLayoutSize
public Dimension maximumLayoutSize(Container target)(Code)
Returns the maximum dimensions for this layout given the components in the specified target container.
Parameters:
  target - the component which needs to be laid out
See Also:   Container
See Also:   CardLayout.minimumLayoutSize
See Also:   CardLayout.preferredLayoutSize



minimumLayoutSize
public Dimension minimumLayoutSize(Container parent)(Code)
Calculates the minimum size for the specified panel.
Parameters:
  parent - the parent container in which to do the layout the minimum dimensions required to lay out thesubcomponents of the specified container
See Also:   java.awt.Container.doLayout
See Also:   java.awt.CardLayout.preferredLayoutSize



next
public void next(Container parent)(Code)
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 parent container in which to do the layout
See Also:   java.awt.CardLayout.previous



preferredLayoutSize
public Dimension preferredLayoutSize(Container parent)(Code)
Determines the preferred size of the container argument using this card layout.
Parameters:
  parent - the parent container in which to do the layout the preferred dimensions to lay out the subcomponentsof the specified container
See Also:   java.awt.Container.getPreferredSize
See Also:   java.awt.CardLayout.minimumLayoutSize



previous
public void previous(Container parent)(Code)
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 parent container in which to do the layout
See Also:   java.awt.CardLayout.next



removeLayoutComponent
public void removeLayoutComponent(Component comp)(Code)
Removes the specified component from the layout. If the card was visible on top, the next card underneath it is shown.
Parameters:
  comp - the component to be removed.
See Also:   java.awt.Container.remove(java.awt.Component)
See Also:   java.awt.Container.removeAll



setHgap
public void setHgap(int hgap)(Code)
Sets the horizontal gap between components.
Parameters:
  hgap - the horizontal gap between components.
See Also:   java.awt.CardLayout.getHgap
See Also:   java.awt.CardLayout.setVgap(int)
since:
   JDK1.1



setVgap
public void setVgap(int vgap)(Code)
Sets the vertical gap between components.
Parameters:
  vgap - the vertical gap between components.
See Also:   java.awt.CardLayout.getVgap
See Also:   java.awt.CardLayout.setHgap(int)
since:
   JDK1.1



show
public void show(Container parent, String name)(Code)
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 parent container in which to do the layout
Parameters:
  name - the component name
See Also:   java.awt.CardLayout.addLayoutComponent(java.awt.Componentjava.lang.Object)



showDefaultComponent
void showDefaultComponent(Container parent)(Code)



toString
public String toString()(Code)
Returns a string representation of the state of this card layout. a string representation of this card layout.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.