SplitBar (GXT 4.0.4)

java.lang.Object
- Widget
- - com.sencha.gxt.widget.core.client.Component
  - - com.sencha.gxt.widget.core.client.SplitBar

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, SelectEvent.HasSelectHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, SplitBarDragEvent.HasSplitBarDragHandlers, HasFocusSupport, HasItemId
```
public class SplitBar
extends Component
implements SplitBarDragEvent.HasSplitBarDragHandlers, SelectEvent.HasSelectHandlers
```
Creates a draggable splitter on the side of a widget.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class SplitBar.Handler

static interface SplitBar.SplitBarAppearance

Nested Classes
Modifier and Type	Class and Description
`protected class`	`SplitBar.Handler`
`static interface`	`SplitBar.SplitBarAppearance`

Field Summary

Fields
Modifier and Type	Field and Description
`protected SplitBar.SplitBarAppearance`	`appearance`
`protected boolean`	`autoSize`
`protected int`	`barWidth`
`protected boolean`	`collapsible`
`protected Component`	`containerWidget`
`protected DelayedTask`	`delay`
`protected boolean`	`disableDragging`
`protected Draggable`	`draggable`
`protected GroupingHandlerRegistration`	`handlerRegistration`
`protected int`	`handleWidth`
`protected int`	`maxSize`
`protected XElement`	`miniEl`
`protected int`	`minSize`
`protected Style.LayoutRegion`	`region`
`protected XElement`	`resizeEl`
`protected Component`	`resizeWidget`
`protected Rectangle`	`startBounds`
`protected int`	`xOffset`
`protected int`	`yOffset`

Fields inherited from class com.sencha.gxt.widget.core.client.Component
adjustSize, allowTextSelection, cacheSizes, contextMenu, contextMenuGestureRecognizer, dataMap, deferHeight, disableContextMenu, disabled, disabledStyle, disableEvents, ensureVisibilityOnSizing, focusManagerSupport, gestureRecognizers, height, hidden, hideMode, itemId, lastSize, layer, left, mask, maskMessage, monitorWindowResize, overElements, pageX, pageY, resizeHandler, shadow, shadowPosition, shim, stateful, stateId, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors
Constructor and Description
`SplitBar(SplitBar.SplitBarAppearance appearance, Style.LayoutRegion region, Component resizeWidget)` Creates a new split bar with the specified appearance
`SplitBar(Style.LayoutRegion region, Component target)` Creates a split for bar for the specified layout region and target.
`SplitBar(Style.LayoutRegion style, Component resizeWidget, Component container)` Creates a new split bar.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addClickHandler(ClickHandler handler)`
`HandlerRegistration`	`addDoubleClickHandler(DoubleClickHandler handler)`
`HandlerRegistration`	`addSelectHandler(SelectEvent.SelectHandler handler)` Adds a `SelectEvent.SelectHandler` handler for `SelectEvent` events.
`HandlerRegistration`	`addSplitBarDragHandler(SplitBarDragEvent.SplitBarDragHandler handler)` Adds a `SplitBarDragEvent.SplitBarDragHandler` handler for `SplitBarDragEvent` events.
`void`	`disableDragging()` Prevents the split bar from being dragged.
`SplitBar.SplitBarAppearance`	`getAppearance()` Returns the split bar appearance.
`int`	`getBarWidth()` Returns the bar width.
`Component`	`getContainer()` Returns the container widget.
`Draggable`	`getDraggable()` Returns the split bar's draggable instance.
`int`	`getHandleWidth()` Returns the handle width.
`int`	`getMaxSize()` Returns the maximum size.
`int`	`getMinSize()`
`Component`	`getTargetWidget()` Returns the resize widget.
`int`	`getXOffset()` Returns the x offset.
`int`	`getYOffset()` Returns the y offset.
`boolean`	`isAutoSize()` Returns the auto size state.
`boolean`	`isCollapsible()` Return true if the mini-collapse tool is enabled.
`void`	`onBrowserEvent(Event event)`
`protected void`	`onCancelDrag(DragCancelEvent be)`
`protected void`	`onClick(Event event)`
`protected void`	`onEndDrag(DragEndEvent bee)`
`protected void`	`onHandleAttach()`
`protected void`	`onHandleDetach()`
`protected void`	`onHandleHide(HideEvent event)`
`protected void`	`onHandleShow(ShowEvent event)`
`protected void`	`onMiniClick()`
`protected void`	`onMouseOut(Event event)`
`protected void`	`onMouseOver(Event event)`
`protected void`	`onStartDrag(DragStartEvent de)`
`void`	`release()` Removes the split bar from the resize widget.
`protected void`	`removeSplitBar()`
`void`	`setAutoSize(boolean autoSize)` True to update the size of the the resize widget after a drag operation using a proxy (defaults to true).
`void`	`setBarWidth(int barWidth)` Sets the width of drag proxy during resizing (defaults to 2).
`void`	`setCollapsible(boolean collapsible)` True to show a mini-collapse tool in the split bar (defaults to false).
`void`	`setHandleWidth(int handleWidth)` Sets the width of the drag handles (defaults to 5).
`void`	`setMaxSize(int maxSize)` Sets the maximum size of the resize widget (defaults to 2000).
`void`	`setMinSize(int minSize)` Sets he minimum size of the resize widget (defaults to 10).
`void`	`setXOffset(int x)` The amount of pixels the bar should be offset to the left (defaults to 0).
`void`	`setYOffset(int y)` Sets the amount of pixels the bar should be offset to the top (defaults to 0).
`void`	`sync()` Updates the spitbar's bounds to match the target widget.
`void`	`updateMini(Style.Direction direction)` Sets the visual style indicating the direction of the mini collapse tool.

Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAdjustSize, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, makeVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeGestureRecognizer, removeStyleDependentName, removeStyleOnOver, removeToolTip, restoreVisible, setAdjustSize, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - autoSize
```
protected boolean autoSize
```
  - yOffset
```
protected int yOffset
```
  - xOffset
```
protected int xOffset
```
  - minSize
```
protected int minSize
```
  - maxSize
```
protected int maxSize
```
  - handleWidth
```
protected int handleWidth
```
  - barWidth
```
protected int barWidth
```
  - resizeEl
```
protected XElement resizeEl
```
  - miniEl
```
protected XElement miniEl
```
  - resizeWidget
```
protected Component resizeWidget
```
  - containerWidget
```
protected Component containerWidget
```
  - draggable
```
protected Draggable draggable
```
  - startBounds
```
protected Rectangle startBounds
```
  - delay
```
protected DelayedTask delay
```
  - region
```
protected Style.LayoutRegion region
```
  - handlerRegistration
```
protected GroupingHandlerRegistration handlerRegistration
```
  - collapsible
```
protected boolean collapsible
```
  - appearance
```
protected final SplitBar.SplitBarAppearance appearance
```
  - disableDragging
```
protected boolean disableDragging
```
- Constructor Detail
  - SplitBar
```
public SplitBar(Style.LayoutRegion region,
                Component target)
```
    Creates a split for bar for the specified layout region and target.
    
    Parameters:
    
    region - the layout region
    
    target - the split bar container
  - SplitBar
```
public SplitBar(Style.LayoutRegion style,
                Component resizeWidget,
                Component container)
```
    Creates a new split bar.
    
    Parameters:
    
    style - the bar location
    
    resizeWidget - the widget being resized
    
    container - the widget the split bar proxy will be sized to
  - SplitBar
```
public SplitBar(SplitBar.SplitBarAppearance appearance,
                Style.LayoutRegion region,
                Component resizeWidget)
```
    Creates a new split bar with the specified appearance
    
    Parameters:
    
    appearance - the split bar appearance
    
    region - the bar location
    
    resizeWidget - the widget being resized
- Method Detail
  - addClickHandler
```
public HandlerRegistration addClickHandler(ClickHandler handler)
```
  - addDoubleClickHandler
```
public HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler)
```
  - addSelectHandler
```
public HandlerRegistration addSelectHandler(SelectEvent.SelectHandler handler)
```
    Description copied from interface: SelectEvent.HasSelectHandlers
    
    Adds a SelectEvent.SelectHandler handler for SelectEvent events.
    
    Specified by:
    
    addSelectHandler in interface SelectEvent.HasSelectHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addSplitBarDragHandler
```
public HandlerRegistration addSplitBarDragHandler(SplitBarDragEvent.SplitBarDragHandler handler)
```
    Description copied from interface: SplitBarDragEvent.HasSplitBarDragHandlers
    
    Adds a SplitBarDragEvent.SplitBarDragHandler handler for SplitBarDragEvent events.
    
    Specified by:
    
    addSplitBarDragHandler in interface SplitBarDragEvent.HasSplitBarDragHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - disableDragging
```
public void disableDragging()
```
    Prevents the split bar from being dragged.
  - getAppearance
```
public SplitBar.SplitBarAppearance getAppearance()
```
    Returns the split bar appearance.
    
    Returns:
    
    the split bar appearance
  - getBarWidth
```
public int getBarWidth()
```
    Returns the bar width.
    
    Returns:
    
    the bar width
  - getContainer
```
public Component getContainer()
```
    Returns the container widget.
    
    Returns:
    
    the container widget
  - getDraggable
```
public Draggable getDraggable()
```
    Returns the split bar's draggable instance.
    
    Returns:
    
    the draggable instance
  - getHandleWidth
```
public int getHandleWidth()
```
    Returns the handle width.
    
    Returns:
    
    the handle width
  - getMaxSize
```
public int getMaxSize()
```
    Returns the maximum size.
    
    Returns:
    
    the max size
  - getMinSize
```
public int getMinSize()
```
    Returns:
    
    the minSize
  - getTargetWidget
```
public Component getTargetWidget()
```
    Returns the resize widget.
    
    Returns:
    
    the resize widget
  - getXOffset
```
public int getXOffset()
```
    Returns the x offset.
    
    Returns:
    
    the x offset value
  - getYOffset
```
public int getYOffset()
```
    Returns the y offset.
    
    Returns:
    
    the y offset
  - isAutoSize
```
public boolean isAutoSize()
```
    Returns the auto size state.
    
    Returns:
    
    true if auto size is enabled
  - isCollapsible
```
public boolean isCollapsible()
```
    Return true if the mini-collapse tool is enabled.
    
    Returns:
    
    true if mini-collapse enabled
  - onBrowserEvent
```
public void onBrowserEvent(Event event)
```
    Overrides:
    
    onBrowserEvent in class Component
  - release
```
public void release()
```
    Removes the split bar from the resize widget.
  - setAutoSize
```
public void setAutoSize(boolean autoSize)
```
    True to update the size of the the resize widget after a drag operation using a proxy (defaults to true).
    
    Parameters:
    
    autoSize - the auto size state
  - setBarWidth
```
public void setBarWidth(int barWidth)
```
    Sets the width of drag proxy during resizing (defaults to 2).
    
    Parameters:
    
    barWidth - the bar width
  - setCollapsible
```
public void setCollapsible(boolean collapsible)
```
    True to show a mini-collapse tool in the split bar (defaults to false). When clicked, the collapse event is fired.
    
    Parameters:
    
    collapsible - true to add the mini-collapse tool
  - setHandleWidth
```
public void setHandleWidth(int handleWidth)
```
    Sets the width of the drag handles (defaults to 5).
    
    Parameters:
    
    handleWidth - the handle width
  - setMaxSize
```
public void setMaxSize(int maxSize)
```
    Sets the maximum size of the resize widget (defaults to 2000).
    
    Parameters:
    
    maxSize - the maximum size
  - setMinSize
```
public void setMinSize(int minSize)
```
    Sets he minimum size of the resize widget (defaults to 10).
    
    Parameters:
    
    minSize - the minimum size
  - setXOffset
```
public void setXOffset(int x)
```
    The amount of pixels the bar should be offset to the left (defaults to 0).
    
    Parameters:
    
    x - the xOffset to set
  - setYOffset
```
public void setYOffset(int y)
```
    Sets the amount of pixels the bar should be offset to the top (defaults to 0).
    
    Parameters:
    
    y - the yOffset to set
  - sync
```
public void sync()
```
    Updates the spitbar's bounds to match the target widget.
  - updateMini
```
public void updateMini(Style.Direction direction)
```
    Sets the visual style indicating the direction of the mini collapse tool.
    
    Parameters:
    
    direction - the collapse direction
  - onClick
```
protected void onClick(Event event)
```
  - onHandleAttach
```
protected void onHandleAttach()
```
  - onHandleDetach
```
protected void onHandleDetach()
```
  - onHandleHide
```
protected void onHandleHide(HideEvent event)
```
  - onHandleShow
```
protected void onHandleShow(ShowEvent event)
```
  - onMiniClick
```
protected void onMiniClick()
```
  - onMouseOut
```
protected void onMouseOut(Event event)
```
  - onMouseOver
```
protected void onMouseOver(Event event)
```
  - removeSplitBar
```
protected void removeSplitBar()
```
  - onCancelDrag
```
protected void onCancelDrag(DragCancelEvent be)
```
  - onEndDrag
```
protected void onEndDrag(DragEndEvent bee)
```
  - onStartDrag
```
protected void onStartDrag(DragStartEvent de)
```

Class SplitBar

Nested Class Summary

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.Component

Constructor Summary

Method Summary

Methods inherited from class com.sencha.gxt.widget.core.client.Component

Methods inherited from class java.lang.Object

Field Detail

autoSize

yOffset

xOffset

minSize

maxSize

handleWidth

barWidth

resizeEl

miniEl

resizeWidget

containerWidget

draggable

startBounds

delay

region

handlerRegistration

collapsible

appearance

disableDragging

Constructor Detail

SplitBar

SplitBar

SplitBar

Method Detail

addClickHandler

addDoubleClickHandler

addSelectHandler

addSplitBarDragHandler

disableDragging

getAppearance

getBarWidth

getContainer

getDraggable

getHandleWidth

getMaxSize

getMinSize

getTargetWidget

getXOffset

getYOffset

isAutoSize

isCollapsible

onBrowserEvent

release

setAutoSize

setBarWidth

setCollapsible

setHandleWidth

setMaxSize

setMinSize

setXOffset

setYOffset

sync

updateMini

onClick

onHandleAttach

onHandleDetach

onHandleHide

onHandleShow

onMiniClick

onMouseOut

onMouseOver

removeSplitBar

onCancelDrag

onEndDrag

onStartDrag