com.extjs.gxt.ui.client.widget
Class SplitBar

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.SplitBar

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

public class SplitBar
extends BoxComponent

Creates a draggable splitter on the side of a widget.

Events:

Resize : SplitBarEvent(splitBar, size)

Fires after the split bar has been moved.

• splitBar : this
• size : the new size

DragStart : SplitBarEvent(splitBar, dragEvent)

Fires after a drag has started.

• splitBar : this
• dragEvent : the drag event

DragEnd : SplitBarEvent(splitBar, dragEvent)

Fires after a drag has ended.

• splitBar : this
• dragEvent : the dom event

Nested Class Summary

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

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

SplitBar(Style.LayoutRegion style, BoxComponent resizeWidget)
Creates a new split bar.

SplitBar(Style.LayoutRegion style, BoxComponent resizeWidget, BoxComponent container)
Creates a new split bar.

Method Summary

int	getBarWidth() Returns the bar width.
Draggable	getDraggable() Returns the split bar's draggable instance.
int	getHandleWidth() Returns the handle width.
int	getMaxSize() Returns the maximum size.
int	getMinSize()
Component	getResizeWidget() Returns the resize widget.
int	getXOffset() Returns the x offset.
int	getYOffset() Returns the y offset.
boolean	isAutoSize() Returns the auto size state.
void	release() Removes the split bar from the resize widget.
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	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 xOffset) The amount of pixels the bar should be offset to the left (defaults to 0).
void	setYOffset(int yOffset) Sets the amount of pixels the bar should be offset to the top (defaults to 0).
void	sync()

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

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

fireEvent, getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SplitBar

public SplitBar(Style.LayoutRegion style,
                BoxComponent resizeWidget)

Creates a new split bar.

Parameters:

style - the bar location

resizeWidget - the widget being resized

SplitBar

public SplitBar(Style.LayoutRegion style,
                BoxComponent resizeWidget,
                BoxComponent 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

Method Detail

getBarWidth

public int getBarWidth()

Returns the bar width.

Returns:

the bar width

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

getResizeWidget

public Component getResizeWidget()

Returns the resize widget.

Returns:

the resize widget

getXOffset

public int getXOffset()

Returns the x offset.

Returns:

the xOffset 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

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

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 xOffset)

The amount of pixels the bar should be offset to the left (defaults to 0).

Parameters:

xOffset - the xOffset to set

setYOffset

public void setYOffset(int yOffset)

Sets the amount of pixels the bar should be offset to the top (defaults to 0).

Parameters:

yOffset - the yOffset to set

sync

public void sync()