Class HS.Classes.ActionStack

ActionStack is used for controlling task execution based on Last In First Out order
Defined in: controller.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	HS.Classes.ActionStack() The actionStack class is used for controlling the order of task execution and is based on Last In First Out.

Field Summary
Field Attributes	Field Name and Description
	channels
	defaultAction
	pairedAction
	stack

Method Summary
Method Attributes	Method Name and Description
<static>	HS.Classes.ActionStack.addToStack(data) Pushes an action into the action stack making it the next action line unless another action is added.
<static>	HS.Classes.ActionStack.clearStack(returnStack) Clears the stack data
<static>	HS.Classes.ActionStack.close(stackId) Executes the actions needed to close a function
<static>	HS.Classes.ActionStack.closed(chan) signals to the actionStack a certain module is closed an it action will no longer need to be executed.
<static>	HS.Classes.ActionStack.executeStack(stackId) runs the action at the location stated by the stackId parameter.
<static>	HS.Classes.ActionStack.opened(chan, func, data, context) runs the action at the location stated by the stackId parameter.
<static>	HS.Classes.ActionStack.removeFromStack(stackId) Removes an action from the stack based on the actions position in the array.
<static>	HS.Classes.ActionStack.runStack(stackId) runs the action at the location stated by the stackId parameter.
<static>	HS.Classes.ActionStack.setDefaultAction(newDefaultAction) Sets the default action which will be executed when an actionStack is empty
<static>	HS.Classes.ActionStack.setPairedAction(newPairedAction) Sets the paired action which will be executed after any of action is finished executing.
<static>	HS.Classes.ActionStack.startStack() Starts the execution of actions currently in the action stack starting at the 0-array location and then clear out the array when finished.

Class Detail

HS.Classes.ActionStack()

The actionStack class is used for controlling the order of task execution and is based on Last In First Out.

Requires:: Class; HS.Controller.StateMachine

See:: HS.Controller.StateMachine.escapeStack

Field Detail

channels

defaultAction

pairedAction

stack

Method Detail

<static> {Number} HS.Classes.ActionStack.addToStack(data)

Pushes an action into the action stack making it the next action line unless another action is added.

Parameters:
{Object} data: this is the data used for the stack entry. object parameters event: {String|Function}, data: {Object}, context: {Object}

Returns:: {Number} returns the id of the stack item which is based on the new objects position in the stack.

<static> {Object|Undefined} HS.Classes.ActionStack.clearStack(returnStack)

Clears the stack data

Parameters:
{Boolean} returnStack: Specifies if the cleared out stack should be returned or it should not return anything.

Returns:: {Object|Undefined} Contains either the old stacks data or undefined.

<static> {Number|Boolean} HS.Classes.ActionStack.close(stackId)

Executes the actions needed to close a function

Parameters:
{Number} stackId: The stackId that will be executed.

Returns:: {Number|Boolean} the stackId from the stack action that was executed or false if there is no action to run.

<static> {Void} HS.Classes.ActionStack.closed(chan)

signals to the actionStack a certain module is closed an it action will no longer need to be executed.

Parameters:
{String} chan: The channel/module name that is closed. The string is associated with the stackId

Returns:: {Void}

<static> {Number|Boolean} HS.Classes.ActionStack.executeStack(stackId)

runs the action at the location stated by the stackId parameter.

Parameters:
{Number} stackId: The stackId that will be executed.

Returns:: {Number|Boolean} returns either the next id for the action to execute or false.

<static> {Object} HS.Classes.ActionStack.opened(chan, func, data, context)

runs the action at the location stated by the stackId parameter.

Parameters:
{String} chan: Name of channel that going to be added to the channel array
{Function} func: Function that will be used to close the widget if escape is used or close is used
{Object} data: Data passed to the event function when t issi==
{object} context: Used as "this" in the action's function

Returns:: {Object} returns the channel data that was just created by a plugins opening

<static> {Number|Boolean} HS.Classes.ActionStack.removeFromStack(stackId)

Removes an action from the stack based on the actions position in the array.

Parameters:
{Number} stackId: this is the data used for the stack entry.

Returns:: {Number|Boolean} returns the id of the stack item which is based on the new objects position in the stack.

<static> {Number|Boolean} HS.Classes.ActionStack.runStack(stackId)

runs the action at the location stated by the stackId parameter.

Parameters:
{Number} stackId: The stackId that will be executed.

Returns:: {Number|Boolean} the stackId from the stack action that was executed or false if there is no action to run.

Requires:: HS.Controller.PubSub.publish

<static> {Void} HS.Classes.ActionStack.setDefaultAction(newDefaultAction)

Sets the default action which will be executed when an actionStack is empty

Parameters:
{Function} newDefaultAction: The new default action which will now be executed when a stack is finished.

Returns:: {Void}

<static> {Void} HS.Classes.ActionStack.setPairedAction(newPairedAction)

Sets the paired action which will be executed after any of action is finished executing.

Parameters:
{Function} newPairedAction: The new paired action which will now be executed when a stack action has been completed.

Returns:: {Void}

<static> {Void} HS.Classes.ActionStack.startStack()

Starts the execution of actions currently in the action stack starting at the 0-array location and then clear out the array when finished.

Returns:: {Void}