Package io.jmix.flowui.facet

Interface Timer

All Superinterfaces:

Facet

All Known Implementing Classes:

TimerImpl

public interface Timer
extends Facet

Client-side timer component that fires events at fixed intervals.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Timer.TimerActionEvent	Event fired on timer tick.
static class	Timer.TimerStopEvent	Event fired on timer stop after stop() call.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addTimerActionListener(Consumer<Timer.TimerActionEvent> listener)	Adds Timer.TimerActionEvent listener.
com.vaadin.flow.shared.Registration	addTimerStopListener(Consumer<Timer.TimerStopEvent> listener)	Adds Timer.TimerStopEvent listener.
int	getDelay()
boolean	isAutostart()
boolean	isRepeating()
void	setAutostart(boolean autostart)	Sets whether timer should start automatically when added to a view
void	setDelay(int delayMs)
void	setRepeating(boolean repeating)	Sets repetitive mode for timer action.
void	start()	Starts the timer.
void	stop()	Stops the timer if it is running.

Methods inherited from interface io.jmix.flowui.facet.Facet

getId, getOwner, setId, setOwner

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

isRepeating

boolean isRepeating()

Returns:

true if timer action is repetitive

setRepeating

void setRepeating(boolean repeating)

Sets repetitive mode for timer action.

Parameters:

repeating - repeating flag

getDelay

int getDelay()

Returns:

delay in milliseconds.

setDelay

void setDelay(int delayMs)

Parameters:

delayMs - delay in milliseconds.

isAutostart

boolean isAutostart()

Returns:

true if timer starts automatically when added to a view.

setAutostart

void setAutostart(boolean autostart)

Sets whether timer should start automatically when added to a view

Parameters:

autostart - autostart flag

start

void start()

Starts the timer. If the timer is already started call will be ignored.

stop

void stop()

Stops the timer if it is running.

addTimerActionListener

com.vaadin.flow.shared.Registration addTimerActionListener(Consumer<Timer.TimerActionEvent> listener)

Adds Timer.TimerActionEvent listener.

Parameters:

listener - Timer.TimerActionEvent listener

Returns:

listener registration

addTimerStopListener

com.vaadin.flow.shared.Registration addTimerStopListener(Consumer<Timer.TimerStopEvent> listener)

Adds Timer.TimerStopEvent listener.

Parameters:

listener - Timer.TimerStopEvent listener

Returns:

listener registration