com.haulmont.cuba.gui.components

Interface Timer

All Superinterfaces:

Component, Component.BelongToFrame

All Known Implementing Classes:

WebTimer

public interface Timer
extends Component.BelongToFrame

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Timer.ActionListener Listener for timer events.
static interface	Timer.StopListener Listener for timer stop event.
static class	Timer.TimerActionEvent
static class	Timer.TimerStopEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
default void	addActionListener(Timer.ActionListener listener) Deprecated. Use addTimerActionListener(Consumer) instead
default void	addStopListener(Timer.StopListener listener) Deprecated. Use addTimerStopListener(Consumer) instead
com.haulmont.bali.events.Subscription	addTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)
com.haulmont.bali.events.Subscription	addTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)
int	getDelay()
boolean	isRepeating()
default void	removeActionListener(Timer.ActionListener listener) Deprecated. Use removeTimerActionListener(Consumer) instead
default void	removeStopListener(Timer.StopListener listener) Deprecated. Use removeTimerStopListener(Consumer) instead
void	removeTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)
void	removeTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)
void	setDelay(int delayMs)
void	setRepeating(boolean repeating)
void	start() Starts timer.
void	stop() Stops timer if it is running.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

isRepeating

boolean isRepeating()

setRepeating

void setRepeating(boolean repeating)

getDelay

int getDelay()

Returns:

delay in milliseconds.

setDelay

void setDelay(int delayMs)

Parameters:

delayMs - delay in milliseconds.

start

void start()

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

stop

void stop()

Stops timer if it is running.

addActionListener

@Deprecated
default void addActionListener(Timer.ActionListener listener)

Deprecated. Use addTimerActionListener(Consumer) instead

removeActionListener

@Deprecated
default void removeActionListener(Timer.ActionListener listener)

Deprecated. Use removeTimerActionListener(Consumer) instead

addStopListener

@Deprecated
default void addStopListener(Timer.StopListener listener)

Deprecated. Use addTimerStopListener(Consumer) instead

removeStopListener

@Deprecated
default void removeStopListener(Timer.StopListener listener)

Deprecated. Use removeTimerStopListener(Consumer) instead

addTimerActionListener

com.haulmont.bali.events.Subscription addTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)

removeTimerActionListener

void removeTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)

addTimerStopListener

com.haulmont.bali.events.Subscription addTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)

removeTimerStopListener

void removeTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)