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

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.Slider

All Implemented Interfaces:

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

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

• slider : this
• oldValue : the old value which the slider was previously
• newValue : the new value which the slider is being changed to

Change : SliderEvent(slider, oldValue, newValue)

Fires when the slider value is changed.

• slider : this
• newValue : the new value which the slider has been changed to

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

Slider()
Creates a new slider.

Method Summary

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).
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()
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
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 (default 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).

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, 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

Slider

public Slider()

Creates a new slider.

Method Detail

getFocusEl

public El getFocusEl()

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 (default 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