com.haulmont.cuba.gui.components

Interface Timer

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasXmlDescriptor

All Known Implementing Classes:

WebTimer

public interface Timer
extends Component.HasXmlDescriptor, 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 interface	Timer.TimerListener Deprecated. Use Timer.ActionListener and Timer.StopListener

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addActionListener(Timer.ActionListener listener)
void	addStopListener(Timer.StopListener listener)
void	addTimerListener(Timer.TimerListener listener) Deprecated. Use Timer.ActionListener and Timer.StopListener
int	getDelay()
boolean	isRepeating()
void	removeActionListener(Timer.ActionListener listener)
void	removeStopListener(Timer.StopListener listener)
void	removeTimerListener(Timer.TimerListener listener) Deprecated.
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.HasXmlDescriptor

getXmlDescriptor, setXmlDescriptor

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, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

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.

addTimerListener

@Deprecated
void addTimerListener(Timer.TimerListener listener)

Deprecated. Use Timer.ActionListener and Timer.StopListener

removeTimerListener

@Deprecated
void removeTimerListener(Timer.TimerListener listener)

Deprecated.

addActionListener

void addActionListener(Timer.ActionListener listener)

removeActionListener

void removeActionListener(Timer.ActionListener listener)

addStopListener

void addStopListener(Timer.StopListener listener)

removeStopListener

void removeStopListener(Timer.StopListener listener)