Java Doc for BorderLayout.java in  » 6.0-JDK-Modules » j2me » java » awt » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.awt 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.BorderLayout

BorderLayout
public class BorderLayout implements LayoutManager2,java.io.Serializable(Code)
A border layout lays out a container, arranging and resizing its components to fit in five regions: North, South, East, West, and Center. When adding a component to a container with a border layout, use one of these five names, for example:
 Panel p = new Panel();
 p.setLayout(new BorderLayout());
 p.add(new Button("Okay"), "South");
 
As a convenience, BorderLayout interprets the absence of a string specification the same as "Center":
 Panel p2 = new Panel();
 p2.setLayout(new BorderLayout());
 p2.add(new TextArea());  // Same as p.add(new TextArea(), "Center");
 

The components are laid out according to their preferred sizes and the constraints of the container's size. The North and South components may be stretched horizontally; the East and West components may be stretched vertically; the Center component may stretch both horizontally and vertically to fill any space left over.

Here is an example of five buttons in an applet laid out using the BorderLayout layout manager:

The code for this applet is as follows:


 import java.awt.*;
 import java.applet.Applet;
 public class buttonDir extends Applet {
 public void init() {
 setLayout(new BorderLayout());
 add("North",  new Button("North"));
 add("South",  new Button("South"));
 add("East",   new Button("East"));
 add("West",   new Button("West"));
 add("Center", new Button("Center"));
 }
 }
 


version:
   1.27 02/11/97
author:
   Arthur van Hoff
See Also:   java.awt.Container.add(StringComponent)
since:
   JDK1.0



Field Summary
final public static  StringCENTER
     The center layout constraint (middle of container).
final public static  StringEAST
     The east layout constraint (left side of container).
final public static  StringNORTH
     The north layout constraint (top of container).
final public static  StringSOUTH
     The south layout constraint (bottom of container).
final public static  StringWEST
     The west layout constraint (right side of container).
 Componentcenter
    
 Componenteast
    
 inthgap
    
 Componentnorth
    
 Componentsouth
    
 intvgap
    
 Componentwest
    

Constructor Summary
public  BorderLayout()
     Constructs a new border layout with no gaps between components.
public  BorderLayout(int hgap, int vgap)
     Constructs a border layout with the specified gaps between components.

Method Summary
public  voidaddLayoutComponent(Component comp, Object constraints)
     Adds the specified component to the layout, using the specified constraint object.
public  voidaddLayoutComponent(String name, Component comp)
    
public  intgetHgap()
     Returns 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()
     Returns 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  voidlayoutContainer(Container target)
     Lays out the container argument using this border layout.
public  DimensionmaximumLayoutSize(Container target)
     Returns the maximum dimensions for this layout given the components in the specified target container.
public  DimensionminimumLayoutSize(Container target)
     Determines the minimum size of the target container using this layout manager.
public  DimensionpreferredLayoutSize(Container target)
     Determines the preferred size of the target container using this layout manager, based on the components in the container.
public  voidremoveLayoutComponent(Component comp)
     Removes the specified component from this border layout.
public  voidsetHgap(int hgap)
     Sets the horizontal gap between components.
public  voidsetVgap(int vgap)
     Sets the vertical gap between components.
public  StringtoString()
     Returns a string representation of the state of this border layout.

Field Detail
CENTER
final public static String CENTER(Code)
The center layout constraint (middle of container).



EAST
final public static String EAST(Code)
The east layout constraint (left side of container).



NORTH
final public static String NORTH(Code)
The north layout constraint (top of container).



SOUTH
final public static String SOUTH(Code)
The south layout constraint (bottom of container).



WEST
final public static String WEST(Code)
The west layout constraint (right side of container).



center
Component center(Code)



east
Component east(Code)



hgap
int hgap(Code)



north
Component north(Code)



south
Component south(Code)



vgap
int vgap(Code)



west
Component west(Code)




Constructor Detail
BorderLayout
public BorderLayout()(Code)
Constructs a new border layout with no gaps between components.
since:
   JDK1.0



BorderLayout
public BorderLayout(int hgap, int vgap)(Code)
Constructs a border layout with the specified gaps between components. The horizontal gap is specified by hgap and the vertical gap is specified by vgap.
Parameters:
  hgap - the horizontal gap.
Parameters:
  vgap - the vertical gap.
since:
   JDK1.0




Method Detail
addLayoutComponent
public void addLayoutComponent(Component comp, Object constraints)(Code)
Adds the specified component to the layout, using the specified constraint object. For border layouts, the constraint must be one of the following strings: "North", "South", "East", "West", or "Center".

Most applications do not call this method directly. This method is called when a component is added to a container using the Container.add method with the same argument types.
Parameters:
  comp - the component to be added.
Parameters:
  constraints - an object that specifies how and where the component is added to the layout.
See Also:   java.awt.Container.add(java.awt.Componentjava.lang.Object)
exception:
  IllegalArgumentException - if the constraint object is nota string, or if it not one of the five specified strings.
since:
   JDK1.1




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



getHgap
public int getHgap()(Code)
Returns the horizontal gap between components.
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)
Returns the vertical gap between components.
since:
   JDK1.1



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



layoutContainer
public void layoutContainer(Container target)(Code)
Lays out the container argument using this border layout.

This method actually reshapes the components in the specified container in order to satisfy the constraints of this BorderLayout object. The North and Southcomponents, if any, are placed at the top and bottom of the container, respectively. The West and East components are then placed on the left and right, respectively. Finally, the Center object is placed in any remaining space in the middle.

Most applications do not call this method directly. This method is called when a container calls its doLayout method.
Parameters:
  target - the container in which to do the layout.
See Also:   java.awt.Container
See Also:   
See Also:   java.awt.Container.doLayout
since:
   JDK1.0




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:   BorderLayout.minimumLayoutSize
See Also:   BorderLayout.preferredLayoutSize



minimumLayoutSize
public Dimension minimumLayoutSize(Container target)(Code)
Determines the minimum size of the target container using this layout manager.

This method is called when a container calls its getMinimumSize method. Most applications do not call this method directly.
Parameters:
  target - the container in which to do the layout. the minimum dimensions needed to lay out the subcomponents of the specified container.
See Also:   java.awt.Container
See Also:   
See Also:   java.awt.BorderLayout.preferredLayoutSize
See Also:   java.awt.Container.getMinimumSize
since:
   JDK1.0




preferredLayoutSize
public Dimension preferredLayoutSize(Container target)(Code)
Determines the preferred size of the target container using this layout manager, based on the components in the container.

Most applications do not call this method directly. This method is called when a container calls its getPreferredSize method.
Parameters:
  target - the container in which to do the layout. the preferred dimensions to lay out the subcomponents of the specified container.
See Also:   java.awt.Container
See Also:   
See Also:   java.awt.BorderLayout.minimumLayoutSize
See Also:   
See Also:   java.awt.Container.getPreferredSize
since:
   JDK1.0




removeLayoutComponent
public void removeLayoutComponent(Component comp)(Code)
Removes the specified component from this border layout. This method is called when a container calls its remove or removeAll methods. Most applications do not call this method directly.
Parameters:
  comp - the component to be removed.
See Also:   java.awt.Container.remove(java.awt.Component)
See Also:   java.awt.Container.removeAll
since:
   JDK1.0



setHgap
public void setHgap(int hgap)(Code)
Sets the horizontal gap between components.
Parameters:
  hgap - the horizontal gap between components
since:
   JDK1.1



setVgap
public void setVgap(int vgap)(Code)
Sets the vertical gap between components.
Parameters:
  vgap - the vertical gap between components
since:
   JDK1.1



toString
public String toString()(Code)
Returns a string representation of the state of this border layout. a string representation of this border layout.
since:
   JDK1.0



Methods inherited from java.lang.Object
public boolean equals(Object obj)(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.