This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.plaf.basic
class BasicSplitPaneUI.BasicHorizontalLayoutManager

java.lang.Object extended by javax.swing.plaf.basic.BasicSplitPaneUI.BasicHorizontalLayoutManager
All Implemented Interfaces:
LayoutManager2
Direct Known Subclasses:
BasicSplitPaneUI.BasicVerticalLayoutManager
Enclosing class:
BasicSplitPaneUI

public class BasicSplitPaneUI.BasicHorizontalLayoutManager
extends Object
implements LayoutManager2

LayoutManager for JSplitPanes that have an orientation of HORIZONTAL_SPLIT.


Field Summary
protected Component[] components
          
protected int[] sizes
          
 
Method Summary
 void
addLayoutComponent(Component comp, Object constraints)

          Adds the specified component to the layout, using the specified constraint object.
 void
addLayoutComponent(String place, Component component)

          Adds the component at place.
protected int
getAvailableSize(Dimension containerSize, Insets insets)

          Returns the available width based on the container size and Insets.
protected int

          Returns the left inset, unless the Insets are null in which case 0 is returned.
 float

          Returns the alignment along the x axis.
 float

          Returns the alignment along the y axis.
protected int

          Returns the width of the passed in Components preferred size.
protected int

          Returns the width of the passed in component.
protected int[]

          Returns the sizes of the components.
 void

          Does nothing.
 void

          Does the actual layout.
 Dimension

          Returns the maximum layout size, which is Integer.MAX_VALUE in both directions.
 Dimension

          Returns the minimum size needed to contain the children.
 Dimension

          Returns the preferred size needed to contain the children.
 void

          Removes the specified component from our knowledge.
protected void
resetSizeAt(int index)

          Resets the size of the Component at the passed in location.
 void

          Marks the receiver so that the next time this instance is laid out it'll ask for the preferred sizes.
protected void
setComponentToSize(Component c, int size, int location, Insets insets, Dimension containerSize)

          Sets the width of the component c to be size, placing its x location at location, y to the insets.top and height to the containersize.height less the top and bottom insets.
protected void
setSizes(int[] newSizes)

          Sets the sizes to newSizes.
protected void

          Determines the components.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

components

protected Component[] components

sizes

protected int[] sizes
Method Detail

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object constraints)
Adds the specified component to the layout, using the specified constraint object.

Parameters:
comp - the component to be added
constraints - where/how the component is added to the layout.

addLayoutComponent

public void addLayoutComponent(String place,
                               Component component)
Adds the component at place. Place must be one of JSplitPane.LEFT, RIGHT, TOP, BOTTOM, or null (for the divider).

Parameters:
place
component

getAvailableSize

protected int getAvailableSize(Dimension containerSize,
                               Insets insets)
Returns the available width based on the container size and Insets.

Parameters:
containerSize
insets

getInitialLocation

protected int getInitialLocation(Insets insets)
Returns the left inset, unless the Insets are null in which case 0 is returned.

Parameters:
insets

getLayoutAlignmentX

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

Parameters:
target

getLayoutAlignmentY

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

Parameters:
target

getPreferredSizeOfComponent

protected int getPreferredSizeOfComponent(Component c)
Returns the width of the passed in Components preferred size.

Parameters:
c

getSizeOfComponent

protected int getSizeOfComponent(Component c)
Returns the width of the passed in component.

Parameters:
c

getSizes

protected int[] getSizes()
Returns the sizes of the components.


invalidateLayout

public void invalidateLayout(Container c)
Does nothing. If the developer really wants to change the size of one of the views JSplitPane.resetToPreferredSizes should be messaged.

Parameters:
c

layoutContainer

public void layoutContainer(Container container)
Does the actual layout.

Parameters:
container

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)
Returns the maximum layout size, which is Integer.MAX_VALUE in both directions.

Parameters:
target

minimumLayoutSize

public Dimension minimumLayoutSize(Container container)
Returns the minimum size needed to contain the children. The width is the sum of all the childrens min widths and the height is the largest of the childrens minimum heights.

Parameters:
container

preferredLayoutSize

public Dimension preferredLayoutSize(Container container)
Returns the preferred size needed to contain the children. The width is the sum of all the childrens preferred widths and the height is the largest of the childrens preferred heights.

Parameters:
container

removeLayoutComponent

public void removeLayoutComponent(Component component)
Removes the specified component from our knowledge.

Parameters:
component

resetSizeAt

protected void resetSizeAt(int index)
Resets the size of the Component at the passed in location.

Parameters:
index

resetToPreferredSizes

public void resetToPreferredSizes()
Marks the receiver so that the next time this instance is laid out it'll ask for the preferred sizes.


setComponentToSize

protected void setComponentToSize(Component c,
                                  int size,
                                  int location,
                                  Insets insets,
                                  Dimension containerSize)
Sets the width of the component c to be size, placing its x location at location, y to the insets.top and height to the containersize.height less the top and bottom insets.

Parameters:
c
size
location
insets
containerSize

setSizes

protected void setSizes(int[] newSizes)
Sets the sizes to newSizes.

Parameters:
newSizes

updateComponents

protected void updateComponents()
Determines the components. This should be called whenever a new instance of this is installed into an existing SplitPane.



This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.