Package com.storedobject.vaadin

Class TimerComponent

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.littemplate.LitTemplate

com.storedobject.helper.LitComponent

com.storedobject.vaadin.TimerComponent

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.internal.Template, Serializable

@Tag("so-timer")
@JsModule("./so/timer/so-timer.js")
public class TimerComponent
extends LitComponent
implements com.vaadin.flow.component.HasStyle

A simple component to use as an up/down counter. The counting is done in seconds.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimerComponent.Listener	Listener interface for the TimerComponent class.

Constructor Summary

Constructors

Constructor	Description
TimerComponent()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	abort()	Abort the timer.
com.vaadin.flow.shared.Registration	addListener(TimerComponent.Listener listener)	Add a listener to this timer.
void	countDown(int seconds)	Count down.
void	countUp(int seconds)	Count up.
com.vaadin.flow.dom.Style	getStyle()
void	setPrefix(String prefix)	Set a prefix for the display.
void	setSuffix(String suffix)	Set a suffix for the display.

Methods inherited from class com.storedobject.helper.LitComponent

executeJS, onDetach

Methods inherited from class com.vaadin.flow.component.littemplate.LitTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

TimerComponent

public TimerComponent()

Constructor.

Method Details

addListener

public com.vaadin.flow.shared.Registration addListener(TimerComponent.Listener listener)

Add a listener to this timer.

Parameters:

listener - Listener.

Returns:

Registration that can be used to remove the listener.

countUp

public void countUp(int seconds)

Count up.

Parameters:

seconds - Seconds

countDown

public void countDown(int seconds)

Count down.

Parameters:

seconds - Seconds

abort

public void abort()

Abort the timer.

setPrefix

public void setPrefix(String prefix)

Set a prefix for the display. This value will be displayed as a prefix to the timer value.

For example, you may want to display something like "Waiting for 23 seconds". Here, "Waiting for " is the prefix and " seconds" is the suffix.

Parameters:

prefix - Prefix.

setSuffix

public void setSuffix(String suffix)

Set a suffix for the display. This value will be displayed as a prefix to the timer value.

For example, you may want to display something like "Waiting for 23 seconds". Here, "Waiting for " is the prefix and " seconds" is the suffix.

Parameters:

suffix - Suffix.

getStyle

public com.vaadin.flow.dom.Style getStyle()

Specified by:

getStyle in interface com.vaadin.flow.component.HasStyle