io.jmix.ui.component.impl

Class TimerImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.TimerImpl

All Implemented Interfaces:

Facet, Timer

public class TimerImpl
extends AbstractFacet
implements Timer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TimerImpl.JmixTimerActionListenerWrapper
protected class	TimerImpl.JmixTimerStopListenerWrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.Timer

Timer.TimerActionEvent, Timer.TimerStopEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected JmixTimer	timerImpl

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Fields inherited from interface io.jmix.ui.component.Timer

NAME

Constructor Summary

Constructors

Constructor and Description
TimerImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener) Adds Timer.TimerActionEvent listener.
io.jmix.core.common.event.Subscription	addTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener) Adds Timer.TimerStopEvent listener.
protected void	attachTimerToUi(com.vaadin.ui.Component ownerComponent)
protected JmixTimer	createComponent()
protected void	detachTimerExtension()
int	getDelay()
boolean	isRepeating()
protected void	registerInUI(Frame owner)
protected void	registerOnAttach(com.vaadin.ui.Component ownerComponent)
void	setDelay(int delay)
void	setId(java.lang.String id) Sets facet ID.
void	setOwner(Frame owner) Sets owner frame (Window or Fragment) to the facet.
void	setRepeating(boolean repeating) Sets repetitive mode for timer action.
void	start() Starts timer.
void	stop() Stops timer if it is running.

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, unsubscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner

Field Detail

timerImpl

protected JmixTimer timerImpl

Constructor Detail

TimerImpl

public TimerImpl()

Method Detail

createComponent

protected JmixTimer createComponent()

start

public void start()

Description copied from interface: Timer

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

Specified by:

start in interface Timer

stop

public void stop()

Description copied from interface: Timer

Stops timer if it is running.

Specified by:

stop in interface Timer

isRepeating

public boolean isRepeating()

Specified by:

isRepeating in interface Timer

Returns:

true if timer action is repetitive

setRepeating

public void setRepeating(boolean repeating)

Description copied from interface: Timer

Sets repetitive mode for timer action.

Specified by:

setRepeating in interface Timer

Parameters:

repeating - repeating flag

getDelay

public int getDelay()

Specified by:

getDelay in interface Timer

Returns:

delay in milliseconds.

setDelay

public void setDelay(int delay)

Specified by:

setDelay in interface Timer

Parameters:

delay - delay in milliseconds.

addTimerActionListener

public io.jmix.core.common.event.Subscription addTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)

Description copied from interface: Timer

Adds Timer.TimerActionEvent listener.

Specified by:

addTimerActionListener in interface Timer

Parameters:

listener - listener

Returns:

subscription

addTimerStopListener

public io.jmix.core.common.event.Subscription addTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)

Description copied from interface: Timer

Adds Timer.TimerStopEvent listener.

Specified by:

addTimerStopListener in interface Timer

Parameters:

listener - listener

Returns:

subscription

setId

public void setId(@Nullable
                  java.lang.String id)

Description copied from interface: Facet

Sets facet ID.

Specified by:

setId in interface Facet

Overrides:

setId in class AbstractFacet

Parameters:

id - id

setOwner

public void setOwner(@Nullable
                     Frame owner)

Description copied from interface: Facet

Sets owner frame (Window or Fragment) to the facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - owner frame

registerInUI

protected void registerInUI(Frame owner)

detachTimerExtension

protected void detachTimerExtension()

registerOnAttach

protected void registerOnAttach(com.vaadin.ui.Component ownerComponent)

attachTimerToUi

protected void attachTimerToUi(com.vaadin.ui.Component ownerComponent)