javax.swing.plaf.basic

Class BasicSplitPaneUI.BasicHorizontalLayoutManager

java.lang.Object

javax.swing.plaf.basic.BasicSplitPaneUI.BasicHorizontalLayoutManager

All Implemented Interfaces:

java.awt.LayoutManager, java.awt.LayoutManager2

Direct Known Subclasses:

BasicSplitPaneUI.BasicVerticalLayoutManager

Enclosing class:

BasicSplitPaneUI

public class BasicSplitPaneUI.BasicHorizontalLayoutManager
extends java.lang.Object
implements java.awt.LayoutManager2

This Layout Manager controls the position and size of the components when the JSplitPane's orientation is HORIZONTAL_SPLIT.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Component[]	components This array contains the components in the JSplitPane.
protected int[]	sizes This array contains the current width (for HORIZONTAL_SPLIT) or height (for VERTICAL_SPLIT) of the components.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(java.awt.Component comp, java.lang.Object constraints) This method adds the component given to the JSplitPane.
void	addLayoutComponent(java.lang.String place, java.awt.Component component) This method is called to add a Component to the JSplitPane.
protected int	getAvailableSize(java.awt.Dimension containerSize, java.awt.Insets insets) This method returns the width of the JSplitPane minus the insets.
protected int	getInitialLocation(java.awt.Insets insets) This method returns the given insets left value.
float	getLayoutAlignmentX(java.awt.Container target) This specifies how a component is aligned with respect to other components in the x fdirection.
float	getLayoutAlignmentY(java.awt.Container target) This specifies how a component is aligned with respect to other components in the y direction.
protected int	getPreferredSizeOfComponent(java.awt.Component c) This method returns the preferred width of the component.
protected int	getSizeOfComponent(java.awt.Component c) This method returns the current width of the component.
protected int[]	getSizes() This method returns the sizes array.
void	invalidateLayout(java.awt.Container c) This method invalidates the layout.
void	layoutContainer(java.awt.Container container) This method lays out the components in the container.
java.awt.Dimension	maximumLayoutSize(java.awt.Container target) This method returns the maximum size for the container given the components.
java.awt.Dimension	minimumLayoutSize(java.awt.Container target) This method returns the container's minimum size.
java.awt.Dimension	preferredLayoutSize(java.awt.Container target) This method returns the container's preferred size.
void	removeLayoutComponent(java.awt.Component component) This method removes the component from the layout.
protected void	resetSizeAt(int index) This method resets the size of Component to the preferred size.
void	resetToPreferredSizes() This method resets the sizes of all the components.
protected void	setComponentToSize(java.awt.Component c, int size, int location, java.awt.Insets insets, java.awt.Dimension containerSize) This methods sets the bounds of the given component.
protected void	setSizes(int[] newSizes) This method stores the given int array as the new sizes array.
protected void	updateComponents() This method determines the size of each component.

Methods inherited from class java.lang.Object

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

Field Detail

components

protected java.awt.Component[] components

This array contains the components in the JSplitPane. The left/top component is at index 0, the right/bottom is at 1, and the divider is at 2.

sizes

protected int[] sizes

This array contains the current width (for HORIZONTAL_SPLIT) or height (for VERTICAL_SPLIT) of the components. The indices are the same as for components.

Method Detail

addLayoutComponent

public void addLayoutComponent(java.awt.Component comp,
                      java.lang.Object constraints)

This method adds the component given to the JSplitPane. The position of the component is given by the constraints object.

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

Parameters:

comp - The Component to add.

constraints - The constraints that bind the object.

addLayoutComponent

public void addLayoutComponent(java.lang.String place,
                      java.awt.Component component)

This method is called to add a Component to the JSplitPane. The placement string determines where the Component will be placed. The string should be one of LEFT, RIGHT, TOP, BOTTOM or null (signals that the component is the divider).

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

Parameters:

place - The placement of the Component.

component - The Component to add.

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

getAvailableSize

protected int getAvailableSize(java.awt.Dimension containerSize,
                   java.awt.Insets insets)

This method returns the width of the JSplitPane minus the insets.

Parameters:

containerSize - The Dimensions of the JSplitPane.

insets - The Insets of the JSplitPane.

Returns:

The width of the JSplitPane minus the insets.

getInitialLocation

protected int getInitialLocation(java.awt.Insets insets)

This method returns the given insets left value. If the given inset is null, then 0 is returned.

Parameters:

insets - The Insets to use with the JSplitPane.

Returns:

The inset's left value.

getLayoutAlignmentX

public float getLayoutAlignmentX(java.awt.Container target)

This specifies how a component is aligned with respect to other components in the x fdirection.

Specified by:

getLayoutAlignmentX in interface java.awt.LayoutManager2

Parameters:

target - The container.

Returns:

The component's alignment.

getLayoutAlignmentY

public float getLayoutAlignmentY(java.awt.Container target)

This specifies how a component is aligned with respect to other components in the y direction.

Specified by:

getLayoutAlignmentY in interface java.awt.LayoutManager2

Parameters:

target - The container.

Returns:

The component's alignment.

getPreferredSizeOfComponent

protected int getPreferredSizeOfComponent(java.awt.Component c)

This method returns the preferred width of the component.

Parameters:

c - The component to measure.

Returns:

The preferred width of the component.

getSizeOfComponent

protected int getSizeOfComponent(java.awt.Component c)

This method returns the current width of the component.

Parameters:

c - The component to measure.

Returns:

The width of the component.

getSizes

protected int[] getSizes()

This method returns the sizes array.

Returns:

The sizes array.

invalidateLayout

public void invalidateLayout(java.awt.Container c)

This method invalidates the layout. It does nothing.

Specified by:

invalidateLayout in interface java.awt.LayoutManager2

Parameters:

c - The container to invalidate.

layoutContainer

public void layoutContainer(java.awt.Container container)

This method lays out the components in the container.

Specified by:

layoutContainer in interface java.awt.LayoutManager

Parameters:

container - The container to lay out.

maximumLayoutSize

public java.awt.Dimension maximumLayoutSize(java.awt.Container target)

This method returns the maximum size for the container given the components. It returns a new Dimension object that has width and height equal to Integer.MAX_VALUE.

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

Parameters:

target - The container to measure.

Returns:

The maximum size.

See Also:

Component.getMaximumSize()

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container target)

This method returns the container's minimum size. The minimum width is the sum of all the component's minimum widths. The minimum height is the maximum of all the components' minimum heights.

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

Parameters:

target - The container to measure.

Returns:

The minimum size.

See Also:

LayoutManager.preferredLayoutSize(Container)

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container target)

This method returns the container's preferred size. The preferred width is the sum of all the component's preferred widths. The preferred height is the maximum of all the components' preferred heights.

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

Parameters:

target - The container to measure.

Returns:

The preferred size.

See Also:

LayoutManager.minimumLayoutSize(Container)

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component component)

This method removes the component from the layout.

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

Parameters:

component - The component to remove from the layout.

resetSizeAt

protected void resetSizeAt(int index)

This method resets the size of Component to the preferred size.

Parameters:

index - The index of the component to reset.

resetToPreferredSizes

public void resetToPreferredSizes()

This method resets the sizes of all the components.

setComponentToSize

protected void setComponentToSize(java.awt.Component c,
                      int size,
                      int location,
                      java.awt.Insets insets,
                      java.awt.Dimension containerSize)

This methods sets the bounds of the given component. The width is the size. The height is the container size minus the top and bottom inset. The x coordinate is the location given. The y coordinate is the top inset.

Parameters:

c - The component to set.

size - The width of the component.

location - The x coordinate.

insets - The insets to use.

containerSize - The height of the container.

setSizes

protected void setSizes(int[] newSizes)

This method stores the given int array as the new sizes array.

Parameters:

newSizes - The array to use as sizes.

updateComponents

protected void updateComponents()

This method determines the size of each component. It should be called when a new Layout Manager is created for an existing JSplitPane.