com.google.gwt.widgetideas.client

Class HSliderBar

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

com.google.gwt.user.client.ui.FocusPanel

com.google.gwt.widgetideas.client.SliderBar

com.google.gwt.widgetideas.client.HSliderBar

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, 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.AcceptsOneWidget, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasOneWidget, 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.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, com.google.gwt.user.client.ui.SourcesMouseWheelEvents, ResizableWidget, SourcesSliderEvents, Iterable<com.google.gwt.user.client.ui.Widget>

public class HSliderBar
extends SliderBar

A widget that allows the user to select a value within a range of possible values using a sliding bar that responds to mouse events.

Keyboard Events

HSliderBar listens for the following key events. Holding down a key will repeat the action until the key is released.

• left arrow - shift left one step
• right arrow - shift right one step
• ctrl+left arrow - jump left 10% of the distance
• ctrl+right arrow - jump right 10% of the distance
• home - jump to min value
• end - jump to max value
• space - jump to middle value

CSS Style Rules

• .gwt-HSliderBar-shell { primary style }
• .gwt-HSliderBar-shell-focused { primary style when focused }
• .gwt-HSliderBar-shell gwt-HSliderBar-line { the line that the knob moves along }
• .gwt-HSliderBar-shell gwt-HSliderBar-line-sliding { the line that the knob moves along when sliding }
• .gwt-HSliderBar-shell .gwt-HSliderBar-knob { the sliding knob }
• .gwt-HSliderBar-shell .gwt-HSliderBar-knob-sliding { the sliding knob when sliding }
• .gwt-HSliderBar-shell .gwt-HSliderBar-tick { the ticks along the line }
• .gwt-HSliderBar-shell .gwt-HSliderBar-label { the text labels along the line }

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.widgetideas.client.SliderBar

SliderBar.KeyTimer, SliderBar.LabelFormatter

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

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

Field Summary

Fields inherited from class com.google.gwt.widgetideas.client.SliderBar

curValue, images, keyTimer, knobImage, labelElements, labelFormatter, lineElement, lineOffset, maxValue, minValue, numLabels, numTicks, sliderListeners, slidingKeyboard, slidingMouse, stepSize, styleBaseName, tickElements

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
HSliderBar(double minValue, double maxValue) Create a slider bar.
HSliderBar(double minValue, double maxValue, SliderBar.LabelFormatter labelFormatter) Create a slider bar.
HSliderBar(double minValue, double maxValue, SliderBar.LabelFormatter labelFormatter, com.google.gwt.user.client.ui.AbstractImagePrototype[] images) Create a slider bar.
HSliderBar(double minValue, double maxValue, SliderBar.LabelFormatter labelFormatter, com.google.gwt.user.client.ui.AbstractImagePrototype[] images, String styleBaseName) Create a slider bar.

Method Summary

Modifier and Type	Method and Description
protected void	drawKnob() Draw the knob where it is supposed to be relative to the line.
protected void	drawLabels() Draw the labels along the line.
protected void	drawTicks() Draw the tick along the line.
void	onBrowserEvent(com.google.gwt.user.client.Event event) Listen for events that will move the knob.
void	onResize(int width, int height) This method is called when the dimensions of the parent element change.
void	shiftLeft(int numSteps) Shift to the left (smaller value).
void	shiftRight(int numSteps) Shift to the right (greater value).
protected void	startSliding(boolean highlight, boolean fireEvent) Start sliding the knob.
protected void	stopSliding(boolean unhighlight, boolean fireEvent) Stop sliding the knob.

Methods inherited from class com.google.gwt.widgetideas.client.SliderBar

addSliderListener, formatLabel, getCurrentValue, getKnobPercent, getLabelFormatter, getMaxValue, getMinValue, getNumLabels, getNumTicks, getStepSize, getTotalRange, highlight, onLoad, redraw, removeSliderListener, resetCurrentValue, setCurrentValue, setCurrentValue, setLabelFormatter, setMaxValue, setMinValue, setNumLabels, setNumTicks, setStepSize, unhighlight

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

addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getTabIndex, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setFocus, setTabIndex

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

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

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

Methods inherited from interface com.google.gwt.widgetideas.client.ResizableWidget

getElement, isAttached

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HSliderBar

public HSliderBar(double minValue,
                  double maxValue)

Create a slider bar.

Parameters:

minValue - the minimum value in the range

maxValue - the maximum value in the range

HSliderBar

public HSliderBar(double minValue,
                  double maxValue,
                  SliderBar.LabelFormatter labelFormatter)

Create a slider bar.

Parameters:

minValue - the minimum value in the range

maxValue - the maximum value in the range

labelFormatter - the label formatter

HSliderBar

public HSliderBar(double minValue,
                  double maxValue,
                  SliderBar.LabelFormatter labelFormatter,
                  com.google.gwt.user.client.ui.AbstractImagePrototype[] images)

Create a slider bar.

Parameters:

minValue - the minimum value in the range

maxValue - the maximum value in the range

labelFormatter - the label formatter

images - the images to use for the slider

HSliderBar

public HSliderBar(double minValue,
                  double maxValue,
                  SliderBar.LabelFormatter labelFormatter,
                  com.google.gwt.user.client.ui.AbstractImagePrototype[] images,
                  String styleBaseName)

Create a slider bar.

Parameters:

minValue - the minimum value in the range

maxValue - the maximum value in the range

labelFormatter - the label formatter

images - the images to use for the slider

styleBaseName - the base name from which CSS style names for the slider are derived

Method Detail

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Listen for events that will move the knob.

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

Parameters:

event - the event that occurred

onResize

public void onResize(int width,
                     int height)

This method is called when the dimensions of the parent element change. Subclasses should override this method as needed.

Parameters:

width - the new client width of the element

height - the new client height of the element

shiftLeft

public void shiftLeft(int numSteps)

Shift to the left (smaller value).

Parameters:

numSteps - the number of steps to shift

shiftRight

public void shiftRight(int numSteps)

Shift to the right (greater value).

Parameters:

numSteps - the number of steps to shift

drawKnob

protected void drawKnob()

Draw the knob where it is supposed to be relative to the line.

Specified by:

drawKnob in class SliderBar

drawLabels

protected void drawLabels()

Draw the labels along the line.

Specified by:

drawLabels in class SliderBar

drawTicks

protected void drawTicks()

Draw the tick along the line.

Specified by:

drawTicks in class SliderBar

startSliding

protected void startSliding(boolean highlight,
                            boolean fireEvent)

Start sliding the knob.

Specified by:

startSliding in class SliderBar

Parameters:

highlight - true to change the style

fireEvent - true to fire the event

stopSliding

protected void stopSliding(boolean unhighlight,
                           boolean fireEvent)

Stop sliding the knob.

Specified by:

stopSliding in class SliderBar

Parameters:

unhighlight - true to change the style

fireEvent - true to fire the event