|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jdesktop.swingx.MultiSplitLayout
public class MultiSplitLayout
The MultiSplitLayout layout manager recursively arranges its components in row and column groups called "Splits". Elements of the layout are separated by gaps called "Dividers". The overall layout is defined with a simple tree model whose nodes are instances of MultiSplitLayout.Split, MultiSplitLayout.Divider, and MultiSplitLayout.Leaf. Named Leaf nodes represent the space allocated to a component that was added with a constraint that matches the Leaf's name. Extra space is distributed among row/column siblings according to their 0.0 to 1.0 weight. If no weights are specified then the last sibling always gets all of the extra space, or space reduction.
Although MultiSplitLayout can be used with any Container, it's the default layout manager for MultiSplitPane. MultiSplitPane supports interactively dragging the Dividers, accessibility, and other features associated with split panes.
All properties in this class are bound: when a properties value is changed, all PropertyChangeListeners are fired.
MultiSplitPane
Nested Class Summary | |
---|---|
static class |
MultiSplitLayout.Divider
Models a single vertical/horiztonal divider. |
static class |
MultiSplitLayout.InvalidLayoutException
The specified Node is either the wrong type or was configured incorrectly. |
static class |
MultiSplitLayout.Leaf
Models a java.awt Component child. |
static class |
MultiSplitLayout.Node
Base class for the nodes that model a MultiSplitLayout. |
static class |
MultiSplitLayout.Split
Defines a vertical or horizontal subdivision into two or more tiles. |
Constructor Summary | |
---|---|
MultiSplitLayout()
Create a MultiSplitLayout with a default model with a single Leaf node named "default". |
|
MultiSplitLayout(MultiSplitLayout.Node model)
Create a MultiSplitLayout with the specified model. |
Method Summary | |
---|---|
void |
addLayoutComponent(java.lang.String name,
java.awt.Component child)
Add a component to this MultiSplitLayout. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
|
MultiSplitLayout.Divider |
dividerAt(int x,
int y)
Return the Divider whose bounds contain the specified point, or null if there isn't one. |
java.util.List<MultiSplitLayout.Divider> |
dividersThatOverlap(java.awt.Rectangle r)
Return the Dividers whose bounds overlap the specified Rectangle. |
int |
getDividerSize()
Returns the width of Dividers in Split rows, and the height of Dividers in Split columns. |
boolean |
getFloatingDividers()
|
MultiSplitLayout.Node |
getModel()
Return the root of the tree of Split, Leaf, and Divider nodes that define this layout. |
java.beans.PropertyChangeListener[] |
getPropertyChangeListeners()
|
void |
layoutContainer(java.awt.Container parent)
Compute the bounds of all of the Split/Divider/Leaf Nodes in the layout model, and then set the bounds of each child component with a matching Leaf Node. |
java.awt.Dimension |
minimumLayoutSize(java.awt.Container parent)
|
static MultiSplitLayout.Node |
parseModel(java.lang.String s)
A convenience method that converts a string to a MultiSplitLayout model (a tree of Nodes) using a a simple syntax. |
java.awt.Dimension |
preferredLayoutSize(java.awt.Container parent)
|
static void |
printModel(MultiSplitLayout.Node root)
Print the tree with enough detail for simple debugging. |
void |
removeLayoutComponent(java.awt.Component child)
Removes the specified component from the layout. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
|
void |
setDividerSize(int dividerSize)
Sets the width of Dividers in Split rows, and the height of Dividers in Split columns. |
void |
setFloatingDividers(boolean floatingDividers)
If true, Leaf node bounds match the corresponding component's preferred size and Splits/Dividers are resized accordingly. |
void |
setModel(MultiSplitLayout.Node model)
Set the root of the tree of Split, Leaf, and Divider nodes that define this layout. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MultiSplitLayout()
public MultiSplitLayout(MultiSplitLayout.Node model)
Method Detail |
---|
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
public java.beans.PropertyChangeListener[] getPropertyChangeListeners()
public MultiSplitLayout.Node getModel()
setModel(org.jdesktop.swingx.MultiSplitLayout.Node)
public void setModel(MultiSplitLayout.Node model)
model
- the root of the tree of Split, Leaf, and Divider node
java.lang.IllegalArgumentException
- if model is a Divider or nullgetModel()
public int getDividerSize()
setDividerSize(int)
public void setDividerSize(int dividerSize)
dividerSize
- the size of dividers (pixels)
java.lang.IllegalArgumentException
- if dividerSize < 0getDividerSize()
public boolean getFloatingDividers()
setFloatingDividers(boolean)
public void setFloatingDividers(boolean floatingDividers)
getFloatingDividers()
public void addLayoutComponent(java.lang.String name, java.awt.Component child)
name
should
match the name property of the Leaf node that represents the bounds of
child
. After layoutContainer() recomputes the bounds of
all of the nodes in the model, it will set this child's bounds to the
bounds of the Leaf node with name
. Note: if a component
was already added with the same name, this method does not remove it from
its parent.
addLayoutComponent
in interface java.awt.LayoutManager
name
- identifies the Leaf node that defines the child's boundschild
- the component to be addedremoveLayoutComponent(java.awt.Component)
public void removeLayoutComponent(java.awt.Component child)
removeLayoutComponent
in interface java.awt.LayoutManager
child
- the component to be removedaddLayoutComponent(java.lang.String, java.awt.Component)
public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)
preferredLayoutSize
in interface java.awt.LayoutManager
public java.awt.Dimension minimumLayoutSize(java.awt.Container parent)
minimumLayoutSize
in interface java.awt.LayoutManager
public void layoutContainer(java.awt.Container parent)
layoutContainer
in interface java.awt.LayoutManager
public MultiSplitLayout.Divider dividerAt(int x, int y)
x
- x coordinatey
- y coordinate
public java.util.List<MultiSplitLayout.Divider> dividersThatOverlap(java.awt.Rectangle r)
r
- target Rectangle
java.lang.IllegalArgumentException
- if the Rectangle is nullpublic static MultiSplitLayout.Node parseModel(java.lang.String s)
For example, the following expression generates a horizontal Split node with three children: the Leafs named left and right, and a Divider in between:
(ROW (LEAF name=left) (LEAF name=right weight=1.0))
Dividers should not be included in the string, they're added automatcially as needed. Because Leaf nodes often only need to specify a name, one can specify a Leaf by just providing the name. The previous example can be written like this:
(ROW left (LEAF name=right weight=1.0))
Here's a more complex example. One row with three elements, the first and last of which are columns with two leaves each:
(ROW (COLUMN weight=0.5 left.top left.bottom) (LEAF name=middle) (COLUMN weight=0.5 right.top right.bottom))
This syntax is not intended for archiving or configuration files . It's just a convenience for examples and tests.
public static void printModel(MultiSplitLayout.Node root)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |