org.jboss.as.console.client.widgets

Class CollapsibleSplitLayoutPanel

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.DockLayoutPanel

org.jboss.as.console.client.widgets.CollapsibleSplitLayoutPanel

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.AnimatedLayout, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.ProvidesResize, com.google.gwt.user.client.ui.RequiresResize, Iterable<com.google.gwt.user.client.ui.Widget>

public class CollapsibleSplitLayoutPanel
extends com.google.gwt.user.client.ui.DockLayoutPanel

A panel that adds user-positioned splitters between each of its child widgets.

This panel is used in the same way as DockLayoutPanel, except that its children's sizes are always specified in Style.Unit.PX units, and each pair of child widgets has a splitter between them that the user can drag.

This widget will only work in standards mode, which requires that the HTML page in which it is run have an explicit <!DOCTYPE> declaration.

CSS Style Rules

• .gwt-SplitLayoutPanel { the panel itself }
• .gwt-SplitLayoutPanel .gwt-SplitLayoutPanel-HDragger { horizontal dragger }
• .gwt-SplitLayoutPanel .gwt-SplitLayoutPanel-VDragger { vertical dragger }

Example

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.DockLayoutPanel

com.google.gwt.user.client.ui.DockLayoutPanel.Direction, com.google.gwt.user.client.ui.DockLayoutPanel.LayoutData

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CollapsibleSplitLayoutPanel() Construct a new CollapsibleSplitLayoutPanel with the default splitter size of 8px.
CollapsibleSplitLayoutPanel(int splitterSize) Construct a new CollapsibleSplitLayoutPanel with the specified splitter size in pixels.

Method Summary

Methods

Modifier and Type	Method and Description
void	addWest(com.google.gwt.user.client.ui.Widget widget, double size)
int	getSplitterSize() Return the size of the splitter in pixels.
void	insert(com.google.gwt.user.client.ui.Widget child, com.google.gwt.user.client.ui.DockLayoutPanel.Direction direction, double size, com.google.gwt.user.client.ui.Widget before)
boolean	isCollapsed(com.google.gwt.user.client.ui.Widget widget)
boolean	remove(com.google.gwt.user.client.ui.Widget child)
void	setWidgetHidden(com.google.gwt.user.client.ui.Widget widget, boolean hidden)
void	setWidgetMinSize(com.google.gwt.user.client.ui.Widget child, int minSize) Sets the minimum allowable size for the given widget.
void	setWidgetSnapClosedSize(com.google.gwt.user.client.ui.Widget child, int snapClosedSize) Sets a size below which the slider will close completely.
void	setWidgetToggleDisplayAllowed(com.google.gwt.user.client.ui.Widget child, boolean allowed) Sets whether or not double-clicking on the splitter should toggle the display of the widget.
boolean	toggleCollapsedState(com.google.gwt.user.client.ui.Widget widget)

Methods inherited from class com.google.gwt.user.client.ui.DockLayoutPanel

add, addEast, addEast, addLineEnd, addLineStart, addNorth, addNorth, addSouth, addSouth, addWest, animate, animate, forceLayout, getCenter, getCenterHeight, getCenterWidth, getResolvedDirection, getUnit, getWidgetContainerElement, getWidgetDirection, getWidgetSize, insertEast, insertLineEnd, insertLineStart, insertNorth, insertSouth, insertWest, onAttach, onDetach, onResize, setWidgetSize

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CollapsibleSplitLayoutPanel

public CollapsibleSplitLayoutPanel()

Construct a new CollapsibleSplitLayoutPanel with the default splitter size of 8px.

CollapsibleSplitLayoutPanel

public CollapsibleSplitLayoutPanel(int splitterSize)

Construct a new CollapsibleSplitLayoutPanel with the specified splitter size in pixels.

Parameters:

splitterSize - the size of the splitter in pixels

Method Detail

getSplitterSize

public int getSplitterSize()

Return the size of the splitter in pixels.

Returns:

the splitter size

insert

public void insert(com.google.gwt.user.client.ui.Widget child,
          com.google.gwt.user.client.ui.DockLayoutPanel.Direction direction,
          double size,
          com.google.gwt.user.client.ui.Widget before)

Overrides:

insert in class com.google.gwt.user.client.ui.DockLayoutPanel

remove

public boolean remove(com.google.gwt.user.client.ui.Widget child)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

remove in class com.google.gwt.user.client.ui.DockLayoutPanel

setWidgetHidden

public void setWidgetHidden(com.google.gwt.user.client.ui.Widget widget,
                   boolean hidden)

Overrides:

setWidgetHidden in class com.google.gwt.user.client.ui.DockLayoutPanel

setWidgetMinSize

public void setWidgetMinSize(com.google.gwt.user.client.ui.Widget child,
                    int minSize)

Sets the minimum allowable size for the given widget.

Its associated splitter cannot be dragged to a position that would make it smaller than this size. This method has no effect for the DockLayoutPanel.Direction#CENTER widget.

Parameters:

child - the child whose minimum size will be set

minSize - the minimum size for this widget

setWidgetSnapClosedSize

public void setWidgetSnapClosedSize(com.google.gwt.user.client.ui.Widget child,
                           int snapClosedSize)

Sets a size below which the slider will close completely. This can be used in conjunction with setWidgetMinSize(com.google.gwt.user.client.ui.Widget, int) to provide a speed-bump effect where the slider will stick to a preferred minimum size before closing completely.

This method has no effect for the DockLayoutPanel.Direction#CENTER widget.

Parameters:

child - the child whose slider should snap closed

snapClosedSize - the width below which the widget will close or -1 to disable.

setWidgetToggleDisplayAllowed

public void setWidgetToggleDisplayAllowed(com.google.gwt.user.client.ui.Widget child,
                                 boolean allowed)

Sets whether or not double-clicking on the splitter should toggle the display of the widget.

Parameters:

child - the child whose display toggling will be allowed or not.

allowed - whether or not display toggling is allowed for this widget

toggleCollapsedState

public boolean toggleCollapsedState(com.google.gwt.user.client.ui.Widget widget)

isCollapsed

public boolean isCollapsed(com.google.gwt.user.client.ui.Widget widget)

addWest

public void addWest(com.google.gwt.user.client.ui.Widget widget,
           double size)

Overrides:

addWest in class com.google.gwt.user.client.ui.DockLayoutPanel