Class: MacroCommand

see:	org.puremvc.patterns.command.SimpleCommand SimpleCommand
see:	org.puremvc.patterns.observer.Notification Notification
see:	org.puremvc.core.controller.Controller Controller

[ Top ]

Class Methods

constructor __construct [line 62]

MacroCommand __construct(
)

Constructor.

You should not need to define a constructor, instead, override the

initializeMacroCommand

method.

If your subclass does define a constructor, be sure to call

super()

Tags:

access:

public

Overrides Notifier::__construct() (parent method not documented)

[ Top ]

method addSubCommand [line 104]

void addSubCommand(
commandClassRef
$commandClassRef)

Add a SubCommand.

The SubCommands will be called in First In/First Out (FIFO) order.

Tags:

access:

protected

Parameters:

commandClassRef

$commandClassRef

a reference to the

Class

of the

ICommand

[ Top ]

method execute [line 118]

void execute(

$notification)

Execute this

MacroCommand

's SubCommands.

The SubCommands will be called in First In/First Out (FIFO) order.

Tags:

access:

public

Parameters:

notification

$notification

the

INotification

object to be passsed to each SubCommand.

[ Top ]

method initializeMacroCommand [line 91]

void initializeMacroCommand(
)

Initialize the

MacroCommand

In your subclass, override this method to initialize the

MacroCommand

's SubCommand list with

ICommand

class references like this:

<listing> // Initialize MyMacroCommand override protected function initializeMacroCommand( ) : void { addSubCommand( com.me.myapp.controller.FirstCommand ); addSubCommand( com.me.myapp.controller.SecondCommand ); addSubCommand( com.me.myapp.controller.ThirdCommand ); } </listing> Note that SubCommands may be any

ICommand

implementor,

MacroCommand

s or

SimpleCommands

are both acceptable.