Class: State

Members

(non-null) api :up.api.Global

Type:

• up.api.Global

(non-null) designEventListeners :Array.<!Array.<string>>

Type:

• Array.<!Array.<string>>

(non-null) errorMessages :Array.<string>

Type:

• Array.<string>

(non-null) messages :Array.<up.api.common.Message>

Type:

• Array.<up.api.common.Message>

name :string

Type:

• string

Inherited From:

• up.api.common.StateMachine.State#name

(non-null) observerIds :Array.<number>

Type:

• Array.<number>

(non-null) observers :Array.<MutationObserver>

Type:

• Array.<MutationObserver>

(nullable) onEnter :function

Type:

• function

Inherited From:

• up.api.common.StateMachine.State#onEnter

(nullable) onExit :function

Type:

• function

Inherited From:

• up.api.common.StateMachine.State#onExit

(non-null) pulseEleIds :Array.<string>

Type:

• Array.<string>

(non-null) stateMachine :up.api.common.TutorialBase

Type:

• up.api.common.TutorialBase

(non-null) taskList :up.api.common.TutorialBase.TaskList

Type:

• up.api.common.TutorialBase.TaskList

Methods

addDesignEventListener(eventType, callback)

Parameters:

Name	Type	Description
eventType	string	The event type to listen for.
callback	function	The callback when the event gets triggered.

checkTaskList(nextState)

Check the task list for completion.

Parameters:

Name	Type	Description
nextState	string	The state to rebind the next button to.

clearDesignEventListeners()

Clear design event listeners.

clearDomWatchers()

Clear DOM watchers.

clearElementPulse(id)

Parameters:

Name	Type	Description
id	string	The id of the element where the pulse should be cleared.

clearMessages()

Clear any displayed messages.

clearPulsingElements()

Revert pulsing elements to their original non-pulsing forms.

enter()

errorMessage(message, opt_showOnceopt)

Parameters:

Name	Type	Attributes	Description
message	string		The error message to show.
opt_showOnce	boolean	<optional>	True to only show this error message once in this state.

exit()

ghostWrite(id, text)

Parameters:

Name	Type	Description
id	string	The id to write to.
text	string	The text to write.

infoMessage(message)

Parameters:

Name	Type	Description
message	string	The info message to show.

pulseElement(id)

Parameters:

Name	Type	Description
id	string	The id of the element to pulse.

warningMessage(message)

Parameters:

Name	Type	Description
message	string	The warning message to show.

watchForDomElement(id, callback)

Parameters:

Name	Type	Description
id	string	The id of the element to watch for.
callback	function	The callback to call when the DOM element is ready.