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

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Slider
All Implemented Interfaces:
Observable, 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.IsWidget
Direct Known Subclasses:
InputSlider

public class Slider
extends BoxComponent

Slider component.

Events:
BeforeChange : SliderEvent(slider, oldValue, newValue)
Fires before the slider value is changed. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Change : SliderEvent(slider, oldValue, newValue)
Fires when the slider value is changed.


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
protected  El innerEl
           
protected  El targetEl
           
protected  boolean vertical
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Slider()
          Creates a new slider.
 
Method Summary
protected  void afterRender()
          Called after the component has been rendered and is attached for the first time.
protected  int constrain(int value)
           
protected  ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
           
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
protected  int doSnap(int v)
           
 El getFocusEl()
           
 int getIncrement()
          Returns the increment.
 int getMaxValue()
          Returns the max value (defaults to 100).
 java.lang.String getMessage()
          Returns the tool tip message.
 int getMinValue()
          Returns the minimum value (defaults to 0).
protected  double getRatio()
           
protected  ToolTipConfig getToolTipConfig(int value)
           
 int getValue()
          Returns the current value.
 boolean isClickToChange()
          Returns whether whether or not clicking on the Slider axis will change the slider.
 boolean isDraggable()
          Returns true if the slider is draggable.
 boolean isUseTip()
          Returns true if tips are enabled.
 boolean isVertical()
           
protected  void moveThumb(int v)
           
protected  int normalizeValue(int value)
           
protected  void onAttach()
           
protected  void onBlur(ComponentEvent ce)
           
protected  void onClick(ComponentEvent ce)
           
 void onComponentEvent(ComponentEvent ce)
          Any events a component receives will be forwarded to this method.
protected  void onDragCancel(DragEvent de)
           
protected  void onDragEnd(DragEvent de)
           
protected  void onDragMove(DragEvent de)
           
protected  void onDragStart(DragEvent de)
           
protected  void onFocus(ComponentEvent ce)
           
protected  java.lang.String onFormatValue(int value)
           
protected  void onKeyDown(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void onResize(int width, int height)
          Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
protected  void onValueChange(int value)
           
protected  int reverseValue(int pos)
           
 void setClickToChange(boolean clickToChange)
          Determines whether or not clicking on the slider axis will change the slider (defaults to true).
 void setDraggable(boolean draggable)
          True to allow the slider to be dragged (default to true).
 void setIncrement(int increment)
          How many units to change the slider when adjusting by drag and drop.
 void setMaxValue(int maxValue)
          Sets the max value (defaults to 100).
 void setMessage(java.lang.String message)
          Sets the tool tip message (defaults to '{0}').
 void setMinValue(int minValue)
          Sets the minimum value (defaults to 0).
 void setUseTip(boolean useTip)
          True to enable tool tips (default to true).
 void setValue(int value)
          Sets the current value.
 void setValue(int value, boolean supressEvent)
          Sets the current value.
 void setVertical(boolean vertical)
          True to orient the slider vertically (defaults to false).
protected  void syncThumb()
           
protected  int translateValue(int v)
           
protected  void updateTip()
           
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onShow, onUnload, 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
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onBrowserEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
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, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

innerEl

protected El innerEl

vertical

protected boolean vertical

targetEl

protected El targetEl
Constructor Detail

Slider

public Slider()
Creates a new slider.

Method Detail

getFocusEl

public El getFocusEl()
Overrides:
getFocusEl in class Component

getIncrement

public int getIncrement()
Returns the increment.

Returns:
the increment

getMaxValue

public int getMaxValue()
Returns the max value (defaults to 100).

Returns:
the max value

getMessage

public java.lang.String getMessage()
Returns the tool tip message.

Returns:
the tool tip message

getMinValue

public int getMinValue()
Returns the minimum value (defaults to 0).

Returns:
the minimum value

getValue

public int getValue()
Returns the current value.

Returns:
the current value

isClickToChange

public boolean isClickToChange()
Returns whether whether or not clicking on the Slider axis will change the slider.

Returns:
true to allow axis clicks

isDraggable

public boolean isDraggable()
Returns true if the slider is draggable.

Returns:
true if draggable

isUseTip

public boolean isUseTip()
Returns true if tips are enabled.

Returns:
true if tips are enabled

isVertical

public boolean isVertical()

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class Component
Parameters:
ce - the base event

setClickToChange

public void setClickToChange(boolean clickToChange)
Determines whether or not clicking on the slider axis will change the slider (defaults to true).

Parameters:
clickToChange - true to allow the slider axis to be clicked

setDraggable

public void setDraggable(boolean draggable)
True to allow the slider to be dragged (default to true).

Parameters:
draggable - true to enable dragging

setIncrement

public void setIncrement(int increment)
How many units to change the slider when adjusting by drag and drop. Use this option to enable 'snapping' (default to 10).

Parameters:
increment - the increment

setMaxValue

public void setMaxValue(int maxValue)
Sets the max value (defaults to 100).

Parameters:
maxValue - the max value

setMessage

public void setMessage(java.lang.String message)
Sets the tool tip message (defaults to '{0}'). "{0} will be substituted with the current slider value.

Parameters:
message - the tool tip message

setMinValue

public void setMinValue(int minValue)
Sets the minimum value (defaults to 0).

Parameters:
minValue - the minimum value

setUseTip

public void setUseTip(boolean useTip)
True to enable tool tips (default to true).

Parameters:
useTip - true to enable tool tips

setValue

public void setValue(int value)
Sets the current value.

Parameters:
value - the value

setValue

public void setValue(int value,
                     boolean supressEvent)
Sets the current value.

Parameters:
value - the value
supressEvent - true to suppress the change event

setVertical

public void setVertical(boolean vertical)
True to orient the slider vertically (defaults to false).

Parameters:
vertical - true for vertical

afterRender

protected void afterRender()
Description copied from class: Component
Called after the component has been rendered and is attached for the first time. At this time, the component will be part of the DOM which is required when retrieving location and offsets.

Overrides:
afterRender in class BoxComponent

constrain

protected int constrain(int value)

createComponentEvent

protected ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
Overrides:
createComponentEvent in class BoxComponent

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class Component

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class Component

doSnap

protected int doSnap(int v)

getRatio

protected double getRatio()

getToolTipConfig

protected ToolTipConfig getToolTipConfig(int value)

moveThumb

protected void moveThumb(int v)

normalizeValue

protected int normalizeValue(int value)

onAttach

protected void onAttach()
Overrides:
onAttach in class Component

onBlur

protected void onBlur(ComponentEvent ce)

onClick

protected void onClick(ComponentEvent ce)

onDragCancel

protected void onDragCancel(DragEvent de)

onDragEnd

protected void onDragEnd(DragEvent de)

onDragMove

protected void onDragMove(DragEvent de)

onDragStart

protected void onDragStart(DragEvent de)

onFocus

protected void onFocus(ComponentEvent ce)

onFormatValue

protected java.lang.String onFormatValue(int value)

onKeyDown

protected void onKeyDown(ComponentEvent ce)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location

onResize

protected void onResize(int width,
                        int height)
Description copied from class: BoxComponent
Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:
onResize in class BoxComponent
Parameters:
width - the width
height - the height

onValueChange

protected void onValueChange(int value)

reverseValue

protected int reverseValue(int pos)

syncThumb

protected void syncThumb()

translateValue

protected int translateValue(int v)

updateTip

protected void updateTip()