Class Spinner

Object

UIObject

Widget

Composite

Spinner

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsRenderable, IsWidget

public class Spinner
extends Composite

Small CSS-driven spinner widget with optional delayed activation.

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field	Description
private int	delay	Delay in milliseconds before the spinner becomes visible.
private final Timer	showTimer	Timer to defer showing the spinner for short-lived tasks.
private static final String	SPINNER_HTML	HTML structure for the CSS-only spinner.
private boolean	spinning	true while spinning has been requested.
private static final String	STYLE_ACTIVE	Style added while the spinner should be visible.
private static final String	STYLE_NAME	Base style of the spinner widget.
private boolean	visible	true while the spinner is currently visible.

Fields inherited from class UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
Spinner()	Create a new spinner widget.

Method Summary

Modifier and Type	Method	Description
private void	hide()	Hide the spinner.
protected void	onLoad()
void	setDelay(int delay)	Set the activation delay in milliseconds.
void	setSpinning(boolean spinning)	Set whether the spinner should be spinning.
private void	show()	Show the spinner.

Methods inherited from class Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

STYLE_NAME

private static final String STYLE_NAME

Base style of the spinner widget.

See Also:

• Constant Field Values

STYLE_ACTIVE

private static final String STYLE_ACTIVE

Style added while the spinner should be visible.

See Also:

• Constant Field Values

SPINNER_HTML

private static final String SPINNER_HTML

HTML structure for the CSS-only spinner.

See Also:

• Constant Field Values

delay

private int delay

Delay in milliseconds before the spinner becomes visible.

spinning

private boolean spinning

true while spinning has been requested.

visible

private boolean visible

true while the spinner is currently visible.

showTimer

private final Timer showTimer

Timer to defer showing the spinner for short-lived tasks.

Constructor Details

Spinner

public Spinner()

Create a new spinner widget.

Method Details

onLoad

protected void onLoad()

Overrides:

onLoad in class Widget

setDelay

public void setDelay(int delay)

Set the activation delay in milliseconds.

Parameters:

delay - the delay before showing the spinner

setSpinning

public void setSpinning(boolean spinning)

Set whether the spinner should be spinning.

Parameters:

spinning - true to start spinning

show

private void show()

Show the spinner.

hide

private void hide()

Hide the spinner.