com.databasesandlife.util.wicket

Class CountingUpThenAutoRefreshingLabel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.databasesandlife.util.wicket.CountingUpThenAutoRefreshingLabel

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class CountingUpThenAutoRefreshingLabel
extends org.apache.wicket.markup.html.panel.Panel

A <span> label which firstly counts up towards its model's value, and secondly auto-refreshes that value. The component implements similar functionality to "worldwide members" number on the avaaz homepage.

Usage:

    <!-- In HTML file -->
    <span wicket:id="numberOfUsers"></span>

    // In Java file
    CountingUpThenAutoRefreshingLabel label = new CountingUpThenAutoRefreshingLabel("numberOfUsers");
    label.setDefaultModel(new PropertyModel(dataSource, "userCount")); // model returns Integer
    add(label);

The first phase of the component lasts two minutes, and the value counts up from zero to the target value. It "tends" towards the target value, i.e. moves fast at the beginning, then slows down as it approaches its target value.

The second phase, triggered after the first two minutes, simply refreshes the value periodically from the server. Initially this is refreshed every two seconds, but this refresh interval is gradually slowed down, so that if N users leave their browsers open for a long time, we will not get N requests every two seconds forever.

Various numerical values above may be altered with:

    label.setCountingUpDurationSeconds(120);
    label.setCountingUpRefreshIntervalSeconds(0.1);
    label.setTendencyThreshold(0.001);
    label.setAutoRefreshingInitialIntervalSeconds(2.0);
    label.setAutoRefreshingIntervalMultiplier(1.2); 

Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	autoRefreshingIntervalMultiplier
protected double	autoRefreshIntervalSeconds
protected double	countingUpDurationSeconds
protected double	countingUpRefreshIntervalSeconds
protected org.apache.wicket.ajax.AbstractAjaxTimerBehavior	currentSelfUpdatingBehavior
protected org.apache.wicket.markup.html.basic.Label	js
protected org.apache.wicket.markup.html.basic.Label	label
protected double	tendencyThreshold

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
CountingUpThenAutoRefreshingLabel(String wicketId)

Method Summary

Modifier and Type	Method and Description
protected void	autoRefreshCallback(org.apache.wicket.ajax.AjaxRequestTarget target)
String	getJs() INTERNAL METHOD -- DO NOT USE
String	getLabelValue() INTERNAL METHOD -- DO NOT USE
protected String	getThousandSeparator()
void	setAutoRefreshingInitialIntervalSeconds(double x) During the auto-refresh phase, what should the duration be between server-refreshes, initially?
void	setAutoRefreshingIntervalMultiplier(double x) During the auto-refresh phase, by what multiplier should the auto-refresh interval durations increase? For example 2.0 means they double; so for example the first duration might be 10s, the next 20s, the next 40s, etc.
void	setCountingUpDurationSeconds(double x) How long should the initial phase of counting up be? Measured in seconds
void	setCountingUpRefreshIntervalSeconds(double x) What should the duration between the updates during the counting up phase be? Measured in seconds.
void	setTendencyThreshold(double x) How close should the counting up phase get to the target value? A value of 0.01 means it gets within 1% of the target value before switching to the second auto-refresh phase.

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

countingUpDurationSeconds

protected double countingUpDurationSeconds

countingUpRefreshIntervalSeconds

protected double countingUpRefreshIntervalSeconds

tendencyThreshold

protected double tendencyThreshold

autoRefreshingIntervalMultiplier

protected double autoRefreshingIntervalMultiplier

label

protected org.apache.wicket.markup.html.basic.Label label

js

protected org.apache.wicket.markup.html.basic.Label js

currentSelfUpdatingBehavior

protected org.apache.wicket.ajax.AbstractAjaxTimerBehavior currentSelfUpdatingBehavior

autoRefreshIntervalSeconds

protected double autoRefreshIntervalSeconds

Constructor Detail

CountingUpThenAutoRefreshingLabel

public CountingUpThenAutoRefreshingLabel(String wicketId)

Method Detail

setCountingUpDurationSeconds

public void setCountingUpDurationSeconds(double x)

How long should the initial phase of counting up be? Measured in seconds

setCountingUpRefreshIntervalSeconds

public void setCountingUpRefreshIntervalSeconds(double x)

What should the duration between the updates during the counting up phase be? Measured in seconds. Can be less than one.

setTendencyThreshold

public void setTendencyThreshold(double x)

How close should the counting up phase get to the target value? A value of 0.01 means it gets within 1% of the target value before switching to the second auto-refresh phase.

setAutoRefreshingInitialIntervalSeconds

public void setAutoRefreshingInitialIntervalSeconds(double x)

During the auto-refresh phase, what should the duration be between server-refreshes, initially?

setAutoRefreshingIntervalMultiplier

public void setAutoRefreshingIntervalMultiplier(double x)

During the auto-refresh phase, by what multiplier should the auto-refresh interval durations increase? For example 2.0 means they double; so for example the first duration might be 10s, the next 20s, the next 40s, etc.

getLabelValue

public String getLabelValue()

INTERNAL METHOD -- DO NOT USE

getThousandSeparator

protected String getThousandSeparator()

getJs

public String getJs()

INTERNAL METHOD -- DO NOT USE

autoRefreshCallback

protected void autoRefreshCallback(org.apache.wicket.ajax.AjaxRequestTarget target)