Timer (CUBA 7.2 API)

All Superinterfaces:

Facet
```
public interface Timer
extends Facet
```
Client-side timer component that fires events at fixed intervals.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Timer.ActionListener` Deprecated. Use `addTimerActionListener(Consumer)` with lambda instead.
`static interface`	`Timer.StopListener` Deprecated. Use `addTimerStopListener(Consumer)` with lambda instead.
`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 and Description

static java.lang.String NAME

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
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
`Subscription`	`addTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)` Adds `Timer.TimerActionEvent` listener.
`Subscription`	`addTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)` Adds `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)` Deprecated. Use subscription object instead
`void`	`removeTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)` Deprecated. Use subscription object instead
`void`	`setDelay(int delayMs)`
`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 interface com.haulmont.cuba.gui.components.Facet
getId, getOwner, setId, setOwner

- Field Detail
  - NAME
```
static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - 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.
  - start
```
void start()
```
    Starts timer. If timer is already started call will be ignored.
  - stop
```
void stop()
```
    Stops timer if it is running.
  - addTimerActionListener
```
Subscription addTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)
```
    Adds Timer.TimerActionEvent listener.
    
    Parameters:
    
    listener - listener
    
    Returns:
    
    subscription
  - addTimerStopListener
```
Subscription addTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)
```
    Adds Timer.TimerStopEvent listener.
    
    Parameters:
    
    listener - listener
    
    Returns:
    
    subscription
  - removeTimerActionListener
```
@Deprecated
void removeTimerActionListener(java.util.function.Consumer<Timer.TimerActionEvent> listener)
```
    Deprecated. Use subscription object instead
    
    Removes Timer.TimerActionEvent listener.
    
    Parameters:
    
    listener - listener
  - removeTimerStopListener
```
@Deprecated
void removeTimerStopListener(java.util.function.Consumer<Timer.TimerStopEvent> listener)
```
    Deprecated. Use subscription object instead
    
    Removes Timer.TimerStopEvent listener.
    
    Parameters:
    
    listener - listener
  - 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

Interface Timer

Nested Class Summary

Field Summary

Method Summary

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

Field Detail

NAME

Method Detail

isRepeating

setRepeating

getDelay

setDelay

start

stop

addTimerActionListener

addTimerStopListener

removeTimerActionListener

removeTimerStopListener

addActionListener

removeActionListener

addStopListener

removeStopListener