Package com.vaadin.client

Class UILifecycle

java.lang.Object

com.vaadin.client.UILifecycle

public class UILifecycle
extends Object

Manages the lifecycle of a UI.

Since:

1.0

Author:

Vaadin Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UILifecycle.StateChangeEvent	Event triggered when the lifecycle state of a UI is changed.
static interface	UILifecycle.StateChangeHandler	A listener for listening to UI lifecycle events.
static enum	UILifecycle.UIState	Describes the state of a UI.

Constructor Summary

Constructors

Constructor	Description
UILifecycle()

Method Summary

Modifier and Type	Method	Description
<H extends UILifecycle.StateChangeHandler> com.google.web.bindery.event.shared.HandlerRegistration	addHandler(H handler)	Adds a state change event handler.
UILifecycle.UIState	getState()	Gets the state of the UI.
boolean	isRunning()	Check if the state is UILifecycle.UIState.RUNNING.
boolean	isTerminated()	Check if the state is UILifecycle.UIState.TERMINATED.
void	setState(UILifecycle.UIState state)	Sets the state of the UI to the given value.

Methods inherited from class java.lang.Object

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

Constructor Details

UILifecycle

public UILifecycle()

Method Details

getState

public UILifecycle.UIState getState()

Gets the state of the UI.

Returns:

the current state of the UI

setState

public void setState(UILifecycle.UIState state)

Sets the state of the UI to the given value.

Only allows state changes in one direction: UILifecycle.UIState.INITIALIZING -> UILifecycle.UIState.RUNNING -> UILifecycle.UIState.TERMINATED.

Changing the state fires a UILifecycle.StateChangeEvent.

Parameters:

state - the new UI state

isRunning

public boolean isRunning()

Check if the state is UILifecycle.UIState.RUNNING.

Returns:

true if the status is UILifecycle.UIState.RUNNING, false otherwise

isTerminated

public boolean isTerminated()

Check if the state is UILifecycle.UIState.TERMINATED.

Returns:

true if the status is UILifecycle.UIState.TERMINATED, false otherwise

addHandler

public <H extends UILifecycle.StateChangeHandler>
com.google.web.bindery.event.shared.HandlerRegistration addHandler(H handler)

Adds a state change event handler.

Type Parameters:

H - the handler type

Parameters:

handler - the handler to add

Returns:

a handler registration object which can be used to remove the handler