org.catacomb.druid.swing.split

Class SplitterLayout

java.lang.Object

org.catacomb.druid.swing.split.SplitterLayout

All Implemented Interfaces:

java.awt.LayoutManager, java.awt.LayoutManager2, java.io.Serializable

public class SplitterLayout
extends java.lang.Object
implements java.awt.LayoutManager2, java.io.Serializable

SplitterLayout is a layout manager that will layout a container holding other components and SplitterBars.

Each component added to a container to be laid out using SplitterLayout must provide a String containing a "weight" for the component. This weight will be used to determine the initial spacing of all components being laid out. The weight numbers are arbitrary integers. The amount of space initially allocated for a component is

 (wc / wt) * (size - insets - splitterSize)
 

where

wc

the weight number for the component

wt

the total weight of all visible components in the container

size

the space free to display the components

insets

space used by insets in the container

splitterSize

amount of space needed to display SplitterBars

If the container being laid out holds no SplitterBars, SplitterLayout acts like a relational-weight layout manager. All components are always laid out based on their proportionate weights.

If the container being laid out holds some SplitterBars, SplitterLayout will initially size all non JSplitterBar components based on their weights. Any succesive layouts are computed strictly on the locations of the SplitterBars.

SplitterLayout can be oriented Horizontally or Vertically. Any SpliterBars placed in the container will automatically be oriented.

If a JSplitterBar has been modified (adding components to it) you will need to add JSplitterSpace components to it. See JSplitterBar for more details.

Known Problems:

• If there are any SplitterBars contained in the container, it is best to have them between every non-JSplitterBar. Otherwise, once SplitterBars are moved, some components will use their proportional size while others will use the JSplitterBar positions. (Non-Splitterbars will check the next component to see if it's a JSplitterBar. If it's not, it uses its proportional size.) This may eventually be changed...
• Results of adding new SplitterBars to an existing (and user- interacted) SplitterLayout-laid container might be a bit unpredictable. The safest way to ensure the container is laid out correctly would be to explicitly set all pre-existing JSplitterBar positions to (0,0). This will cause the relational layout algorithm to take effect.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static DSplitterBar	dragee
private int	fieldOrientation
static int	HORIZONTAL
private int	lastH
private int	lastW
private boolean	newComponentAdded
private java.util.Hashtable<java.awt.Component,java.lang.Object>	relations
private static long	serialVersionUID
static int	VERTICAL

Constructor Summary

Constructors

Constructor and Description
SplitterLayout()
SplitterLayout(int orientation)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(java.awt.Component comp, java.lang.Object cin) Adds a component w/ constraints to the layout.
void	addLayoutComponent(java.lang.String name, java.awt.Component comp) Adds a component w/ a String constraint to the layout.
java.awt.Dimension	checkLayoutSize(java.awt.Container target, boolean getPrefSize)
float	getLayoutAlignmentX(java.awt.Container parent) Tells the caller that we prefer to be centered
float	getLayoutAlignmentY(java.awt.Container parent) Tells the caller that we prefer to be centered
int	getOrientation()
void	invalidateLayout(java.awt.Container target) Does not have any effect (overridden to null the effect)
void	layoutContainer(java.awt.Container target)
java.awt.Dimension	maximumLayoutSize(java.awt.Container target)
java.awt.Dimension	minimumLayoutSize(java.awt.Container target)
java.awt.Dimension	preferredLayoutSize(java.awt.Container target)
void	removeLayoutComponent(java.awt.Component comp)
void	setOrientation(int orientation)
void	swapOrientation(java.awt.Container container)
java.lang.String	toString() Returns a String representation of the Layout

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

See Also:

Constant Field Values

dragee

protected static DSplitterBar dragee

lastW

private int lastW

lastH

private int lastH

newComponentAdded

private boolean newComponentAdded

relations

private java.util.Hashtable<java.awt.Component,java.lang.Object> relations

fieldOrientation

private int fieldOrientation

Constructor Detail

SplitterLayout

public SplitterLayout()

SplitterLayout

public SplitterLayout(int orientation)

Method Detail

addLayoutComponent

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

Adds a component w/ constraints to the layout. This should only be called by java.awt.Container's add method.

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

addLayoutComponent

public final void addLayoutComponent(java.lang.String name,
                      java.awt.Component comp)

Adds a component w/ a String constraint to the layout. This should only be called by java.awt.Container's add method.

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

checkLayoutSize

public final java.awt.Dimension checkLayoutSize(java.awt.Container target,
                                 boolean getPrefSize)

getLayoutAlignmentX

public final float getLayoutAlignmentX(java.awt.Container parent)

Tells the caller that we prefer to be centered

Specified by:

getLayoutAlignmentX in interface java.awt.LayoutManager2

getLayoutAlignmentY

public final float getLayoutAlignmentY(java.awt.Container parent)

Tells the caller that we prefer to be centered

Specified by:

getLayoutAlignmentY in interface java.awt.LayoutManager2

getOrientation

public int getOrientation()

invalidateLayout

public final void invalidateLayout(java.awt.Container target)

Does not have any effect (overridden to null the effect)

Specified by:

invalidateLayout in interface java.awt.LayoutManager2

layoutContainer

public final void layoutContainer(java.awt.Container target)

Specified by:

layoutContainer in interface java.awt.LayoutManager

maximumLayoutSize

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

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

minimumLayoutSize

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

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

preferredLayoutSize

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

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

removeLayoutComponent

public final void removeLayoutComponent(java.awt.Component comp)

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

setOrientation

public void setOrientation(int orientation)

swapOrientation

public void swapOrientation(java.awt.Container container)

toString

public final java.lang.String toString()

Returns a String representation of the Layout

Overrides:

toString in class java.lang.Object