org.apache.pivot.wtk
Class FillPane

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.FillPane
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class FillPane
extends Container

Container that fills the space it has been given inside its parent and then arranges its child components in a line, either vertically or horizontally.

This is useful, for instance, as a shortcut to making a one row and one column TablePane or GridPane. Adding just one child to a FillPane, such as a ScrollPane, will allow that child to fill the containing area (as opposed to using a BoxPane which will only size itself to the size of its children, which doesn't always work well with a ScrollPane).

The n children of a FillPane will be given 1/n of the total space available, depending on the orientation. For vertical, each child's height will be 1/n of the total height, and for horizontal each child's width will be 1/n of the total width. The children will always stretch to the full width / height of the orthogonal direction.

Here is an example: for a horizontal FillPane with three buttons as children:

+--------------------------------------------------+
|+---------------++--------------++---------------+|
||               ||              ||               ||
||               ||              ||               ||
||               ||              ||               ||
||   Button 1    ||   Button 2   ||   Button 3    ||
||               ||              ||               ||
||               ||              ||               ||
||               ||              ||               ||
|+---------------++--------------++---------------+|
+--------------------------------------------------+

And here is a vertical FillPane with three Button children:

+--------------------------------------------------+
|+------------------------------------------------+|
||                                                ||
||                    Button 1                    ||
||                                                ||
|+------------------------------------------------+|
|+------------------------------------------------+|
||                                                ||
||                    Button 2                    ||
||                                                ||
|+------------------------------------------------+|
|+------------------------------------------------+|
||                                                ||
||                    Button 3                    ||
||                                                ||
|+------------------------------------------------+|
+--------------------------------------------------+


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container
Container.EDT_Checker
 
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
FillPane()
           
FillPane(Orientation orientation)
           
 
Method Summary
 ListenerList<FillPaneListener> getFillPaneListeners()
           
 Orientation getOrientation()
           
 void setOrientation(Orientation orientation)
           
 
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, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, store, transferFocus, update
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, contains, 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, getSize, getSkin, getStyles, 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, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, 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
 

Constructor Detail

FillPane

public FillPane()

FillPane

public FillPane(Orientation orientation)
Method Detail

getOrientation

public Orientation getOrientation()

setOrientation

public void setOrientation(Orientation orientation)

getFillPaneListeners

public ListenerList<FillPaneListener> getFillPaneListeners()