State source

Specializes Montage

Properties

enterState :Property source

Default Value:
  • {string} null

exitState :Property source

Default Value:
  • {string} null

initialSubstate :Function source

The intitial substate.

Default Value:
  • {string} null

name :Property source

The name of the state.

Default Value:
  • {string} null

parentState :Property source

The state's parent state.

Default Value:
  • {string} null

path :Function source

Default Value:
  • {string} null

substates :Property source

The set of substates.

Default Value:
  • {string} null

Methods

callDelegateMethod(name) source

This method calls the method named with the identifier prefix if it exists. Example: If the name parameter is "shouldDoSomething" and the caller's identifier is "bob", then this method will try and call "bobShouldDoSomething"

Parameters:
Name Type Description
name string
Inherited From:

equals(anObject) → {boolean} source

Returns true if two objects are equal, otherwise returns false.

Parameters:
Name Type Description
anObject Object

The object to compare for equality.

Inherited From:
Returns: boolean

Returns true if the calling object and anObject are identical and their uuid properties are also equal. Otherwise, returns false.

gotoState(state, owner) source

Parameters:
Name Type Description
state Property
owner Property
Returns:

this._stateChart._gotoState(state, owner)

init(options) → {State} source

Initializes a State object with a set of options.

Parameters:
Name Type Description
options string

The options for the new State.

Returns: State

isInState(otherState) source

Parameters:
Name Type Description
otherState string
Returns:

!!this.path.match(new RegExp(".?" + otherState + ".?"))

toString() source

Returns:

"[State " + this.path + " ]"

Generated from a4679af

comments powered by Disqus

More help?

Can't find what you are looking for? Get in touch, we're more than happy in helping answer your questions.