com.google.gwt.widgetideas.client

Class SliderBar

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

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>

Direct Known Subclasses:

HSliderBar, VSliderBar

public abstract class SliderBar
extends com.google.gwt.user.client.ui.FocusPanel
implements ResizableWidget, SourcesSliderEvents

Abstract base class for slider bars.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SliderBar.KeyTimer The timer used to continue to shift the knob as the user holds down one of the left/right arrow keys.
static class	SliderBar.LabelFormatter A formatter used to format the labels displayed in the widget.

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

Modifier and Type	Field and Description
protected double	curValue The current value.
protected com.google.gwt.user.client.ui.AbstractImagePrototype[]	images The images used with the sliding bar.
protected SliderBar.KeyTimer	keyTimer The timer used to continue to shift the knob if the user holds down a key.
protected com.google.gwt.user.client.ui.Image	knobImage The knob that slides across the line.
protected List	labelElements The elements used to display labels above the ticks.
protected SliderBar.LabelFormatter	labelFormatter The formatter used to generate label text.
protected com.google.gwt.user.client.Element	lineElement The line that the knob moves over.
protected int	lineOffset The offset between the edge of the shell and the line.
protected double	maxValue The maximum slider value.
protected double	minValue The minimum slider value.
protected int	numLabels The number of labels to show.
protected int	numTicks The number of tick marks to show.
protected SliderListenerCollection	sliderListeners A collection of widgets to notify on slider events.
protected boolean	slidingKeyboard A bit indicating whether or not we are currently sliding the slider bar due to keyboard events.
protected boolean	slidingMouse A bit indicating whether or not we are currently sliding the slider bar due to mouse events.
protected double	stepSize The size of the increments between knob positions.
protected String	styleBaseName The base name from which CSS style names for the slider are derived.
protected List	tickElements The elements used to display tick marks, which are the vertical lines along the slider bar.

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
SliderBar()

Method Summary

Modifier and Type	Method and Description
void	addSliderListener(SliderListener listener) Adds a listener interface to receive slider events.
protected abstract void	drawKnob() Draw the knob where it is supposed to be relative to the line.
protected abstract void	drawLabels() Draw the labels along the line.
protected abstract void	drawTicks() Draw the tick along the line.
protected String	formatLabel(double value) Format the label to display above the ticks Override this method in a subclass to customize the format.
double	getCurrentValue() Return the current value.
protected double	getKnobPercent() Get the percentage of the knob's position relative to the size of the line.
SliderBar.LabelFormatter	getLabelFormatter() Return the label formatter.
double	getMaxValue() Return the max value.
double	getMinValue() Return the minimum value.
int	getNumLabels() Return the number of labels.
int	getNumTicks() Return the number of ticks.
double	getStepSize() Return the step size.
double	getTotalRange() Return the total range between the minimum and maximum values.
protected void	highlight() Highlight this widget.
protected void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	redraw() Redraw the progress bar when something changes the layout.
void	removeSliderListener(SliderListener listener) Removes a previously added listener interface.
protected void	resetCurrentValue() Reset the progress to constrain the progress to the current range and redraw the knob as needed.
void	setCurrentValue(double curValue) Set the current value and fire the onValueChange event.
void	setCurrentValue(double curValue, boolean fireEvent) Set the current value and optionally fire the onValueChange event.
void	setLabelFormatter(SliderBar.LabelFormatter labelFormatter) Set the label formatter.
void	setMaxValue(double maxValue) Set the max value.
void	setMinValue(double minValue) Set the minimum value.
void	setNumLabels(int numLabels) Set the number of labels to show on the line.
void	setNumTicks(int numTicks) Set the number of ticks to show on the line.
void	setStepSize(double stepSize) Set the step size.
protected abstract void	startSliding(boolean highlight, boolean fireEvent) Start sliding the knob.
protected abstract void	stopSliding(boolean unhighlight, boolean fireEvent) Stop sliding the knob.
protected void	unhighlight() Unhighlight this widget.

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

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

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

curValue

protected double curValue

The current value.

images

protected com.google.gwt.user.client.ui.AbstractImagePrototype[] images

The images used with the sliding bar.

knobImage

protected com.google.gwt.user.client.ui.Image knobImage

The knob that slides across the line.

keyTimer

protected SliderBar.KeyTimer keyTimer

The timer used to continue to shift the knob if the user holds down a key.

labelElements

protected List labelElements

The elements used to display labels above the ticks.

labelFormatter

protected SliderBar.LabelFormatter labelFormatter

The formatter used to generate label text.

lineElement

protected com.google.gwt.user.client.Element lineElement

The line that the knob moves over.

lineOffset

protected int lineOffset

The offset between the edge of the shell and the line.

maxValue

protected double maxValue

The maximum slider value.

minValue

protected double minValue

The minimum slider value.

numLabels

protected int numLabels

The number of labels to show.

numTicks

protected int numTicks

The number of tick marks to show.

slidingKeyboard

protected boolean slidingKeyboard

A bit indicating whether or not we are currently sliding the slider bar due to keyboard events.

sliderListeners

protected SliderListenerCollection sliderListeners

A collection of widgets to notify on slider events.

slidingMouse

protected boolean slidingMouse

A bit indicating whether or not we are currently sliding the slider bar due to mouse events.

stepSize

protected double stepSize

The size of the increments between knob positions.

styleBaseName

protected String styleBaseName

The base name from which CSS style names for the slider are derived.

tickElements

protected List tickElements

The elements used to display tick marks, which are the vertical lines along the slider bar.

Constructor Detail

SliderBar

public SliderBar()

Method Detail

addSliderListener

public void addSliderListener(SliderListener listener)

Description copied from interface: SourcesSliderEvents

Adds a listener interface to receive slider events.

Specified by:

addSliderListener in interface SourcesSliderEvents

Parameters:

listener - the listener interface to add

getCurrentValue

public double getCurrentValue()

Return the current value.

Returns:

the current value

getLabelFormatter

public SliderBar.LabelFormatter getLabelFormatter()

Return the label formatter.

Returns:

the label formatter

getMaxValue

public double getMaxValue()

Return the max value.

Returns:

the max value

getMinValue

public double getMinValue()

Return the minimum value.

Returns:

the minimum value

getNumLabels

public int getNumLabels()

Return the number of labels.

Returns:

the number of labels

getNumTicks

public int getNumTicks()

Return the number of ticks.

Returns:

the number of ticks

getStepSize

public double getStepSize()

Return the step size.

Returns:

the step size

getTotalRange

public double getTotalRange()

Return the total range between the minimum and maximum values.

Returns:

the total range

redraw

public void redraw()

Redraw the progress bar when something changes the layout.

removeSliderListener

public void removeSliderListener(SliderListener listener)

Description copied from interface: SourcesSliderEvents

Removes a previously added listener interface.

Specified by:

removeSliderListener in interface SourcesSliderEvents

Parameters:

listener - the listener interface to remove

setCurrentValue

public void setCurrentValue(double curValue)

Set the current value and fire the onValueChange event.

Parameters:

curValue - the current value

setCurrentValue

public void setCurrentValue(double curValue,
                            boolean fireEvent)

Set the current value and optionally fire the onValueChange event.

Parameters:

curValue - the current value

fireEvent - fire the onValue change event if true

setLabelFormatter

public void setLabelFormatter(SliderBar.LabelFormatter labelFormatter)

Set the label formatter.

Parameters:

labelFormatter - the label formatter

setMaxValue

public void setMaxValue(double maxValue)

Set the max value.

Parameters:

maxValue - the current value

setMinValue

public void setMinValue(double minValue)

Set the minimum value.

Parameters:

minValue - the current value

setNumLabels

public void setNumLabels(int numLabels)

Set the number of labels to show on the line. Labels indicate the value of the slider at that point. Use this method to enable labels. If you set the number of labels equal to the total range divided by the step size, you will get a properly aligned "jumping" effect where the knob jumps between labels. Note that the number of labels displayed will be one more than the number you specify, so specify 1 labels to show labels on either end of the line. In other words, numLabels is really the number of slots between the labels. setNumLabels(0) will disable labels.

Parameters:

numLabels - the number of labels to show

setNumTicks

public void setNumTicks(int numTicks)

Set the number of ticks to show on the line. A tick is a vertical line that represents a division of the overall line. Use this method to enable ticks. If you set the number of ticks equal to the total range divided by the step size, you will get a properly aligned "jumping" effect where the knob jumps between ticks. Note that the number of ticks displayed will be one more than the number you specify, so specify 1 tick to show ticks on either end of the line. In other words, numTicks is really the number of slots between the ticks. setNumTicks(0) will disable ticks.

Parameters:

numTicks - the number of ticks to show

setStepSize

public void setStepSize(double stepSize)

Set the step size.

Parameters:

stepSize - the current value

drawKnob

protected abstract void drawKnob()

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

drawLabels

protected abstract void drawLabels()

Draw the labels along the line.

drawTicks

protected abstract void drawTicks()

Draw the tick along the line.

formatLabel

protected String formatLabel(double value)

Format the label to display above the ticks Override this method in a subclass to customize the format. By default, this method returns the integer portion of the value.

Parameters:

value - the value at the label

Returns:

the text to put in the label

getKnobPercent

protected double getKnobPercent()

Get the percentage of the knob's position relative to the size of the line. The return value will be between 0.0 and 1.0.

Returns:

the current percent complete

onLoad

protected void onLoad()

This method is called immediately after a widget becomes attached to the browser's document.

Overrides:

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

highlight

protected void highlight()

Highlight this widget.

resetCurrentValue

protected void resetCurrentValue()

Reset the progress to constrain the progress to the current range and redraw the knob as needed.

startSliding

protected abstract void startSliding(boolean highlight,
                                     boolean fireEvent)

Start sliding the knob.

Parameters:

highlight - true to change the style

fireEvent - true to fire the event

stopSliding

protected abstract void stopSliding(boolean unhighlight,
                                    boolean fireEvent)

Stop sliding the knob.

Parameters:

unhighlight - true to change the style

fireEvent - true to fire the event

unhighlight

protected void unhighlight()

Unhighlight this widget.