Package org.apache.pivot.wtk

Class SplitPane

java.lang.Object

org.apache.pivot.wtk.Component

org.apache.pivot.wtk.Container

org.apache.pivot.wtk.SplitPane

All Implemented Interfaces:

java.lang.Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class SplitPane
extends Container

A SplitPane is a container component that splits its size up into two regions, each of which is capable of holding one component. A split pane may be setup to support either horizontal or veritcal splits. The area in between the two regions is known as the splitter and typically allows the user to adjust the partitioning between the two regions.

Since SplitPanes only support a single splitter, multiple SplitPanes may be nested to support more complex layouts. In that case, one split pane will "own" the other. The implication of this is noticed when a split pane directly contains a child split pane of the same orientation. The parent pane's separator will be able to travel past that of it's child, but the child's separator will be unable to pass the parent's.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SplitPane.Region	Enumeration defining split pane regions.
static class	SplitPane.ResizeMode	Enumeration defining split pane resizing modes.

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container

Container.EDTChecker

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component

Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

Constructors

Constructor	Description
SplitPane()
SplitPane(Orientation orientation)
SplitPane(Orientation orientation, Component topLeft, Component bottomRight)

Method Summary

Modifier and Type	Method	Description
Component	getBottom()
Component	getBottomRight()
Component	getLeft()
Orientation	getOrientation()
SplitPane.Region	getPrimaryRegion()
SplitPane.ResizeMode	getResizeMode()
Component	getRight()
ListenerList<SplitPaneListener>	getSplitPaneListeners()
float	getSplitRatio()
Component	getTop()
Component	getTopLeft()
boolean	isLocked()
Sequence<Component>	remove(int index, int count)	Removes one or more items from the sequence.
void	setBottom(Component component)
void	setBottomRight(Component bottomRight)
void	setLeft(Component component)
void	setLocked(boolean locked)
void	setOrientation(Orientation orientation)
void	setPrimaryRegion(SplitPane.Region primaryRegion)
void	setResizeMode(SplitPane.ResizeMode resizeMode)
void	setRight(Component component)
void	setSplitRatio(float splitRatio)
void	setTop(Component component)
void	setTopLeft(Component topLeft)

Methods inherited from class org.apache.pivot.wtk.Container

add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, store, transferFocus, update

Methods inherited from class org.apache.pivot.wtk.Component

checkSkin, clearFocus, contains, copyStyle, copyStyle, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getScreenBounds, getSize, getSkin, getStyle, getStyle, getStyleBoolean, getStyleBoolean, getStyleColor, getStyleColor, getStyleFont, getStyleFont, getStyleInt, getStyleInt, getStyles, getTextInputMethodListener, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, offsetToScreen, putStyle, putStyle, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setAutomationID, setCursor, setDragSource, setDropTarget, setEnabled, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setSkin, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.pivot.collections.Sequence

addAll, addAll

Constructor Detail

SplitPane

public SplitPane()

SplitPane

public SplitPane(Orientation orientation)

SplitPane

public SplitPane(Orientation orientation,
                 Component topLeft,
                 Component bottomRight)

Method Detail

getTopLeft

public Component getTopLeft()

setTopLeft

public void setTopLeft(Component topLeft)

getBottomRight

public Component getBottomRight()

setBottomRight

public void setBottomRight(Component bottomRight)

getTop

public Component getTop()

Returns:

The "top" component of the split pane, which only applies in vertical mode; otherwise it is null.

setTop

public void setTop(Component component)

getBottom

public Component getBottom()

Returns:

The "bottom" component of the split pane, which only applies in vertical mode; otherwise it is null.

setBottom

public void setBottom(Component component)

getLeft

public Component getLeft()

Returns:

The "left" component of the split pane, which only applies in horizontal mode; otherwise it is null.

setLeft

public void setLeft(Component component)

getRight

public Component getRight()

Returns:

The "right" component of the split pane, which only applies in horizontal mode; otherwise it is null.

setRight

public void setRight(Component component)

getOrientation

public Orientation getOrientation()

setOrientation

public void setOrientation(Orientation orientation)

getPrimaryRegion

public SplitPane.Region getPrimaryRegion()

setPrimaryRegion

public void setPrimaryRegion(SplitPane.Region primaryRegion)

getSplitRatio

public float getSplitRatio()

setSplitRatio

public void setSplitRatio(float splitRatio)

isLocked

public boolean isLocked()

setLocked

public void setLocked(boolean locked)

getResizeMode

public SplitPane.ResizeMode getResizeMode()

setResizeMode

public void setResizeMode(SplitPane.ResizeMode resizeMode)

remove

public Sequence<Component> remove(int index,
                                  int count)

Description copied from interface: Sequence

Removes one or more items from the sequence.

Specified by:

remove in interface Sequence<Component>

Overrides:

remove in class Container

Parameters:

index - The starting index to remove.

count - The number of items to remove, beginning with index.

Returns:

A sequence containing the items that were removed.

getSplitPaneListeners

public ListenerList<SplitPaneListener> getSplitPaneListeners()