FlowSection

Kind of class: public class
Package:
Inherits from:
  • MovieClip
Implements:
Known subclasses:
Classpath: org.asaplibrary.management.flow.FlowSection
File last modified: Wednesday, 11 May 2011, 18:40:30
Building block of navigatable site sections. Subclasses will most likely override startAction and stopAction, see example below. It is also possible to override start and stop for non-timebased actions. Each FlowSection needs to have a name to be addressable by FlowManager. Simply pass the name with the super constructor call: 
public class Gallery extends FlowSection {
    
function Gallery () {
super( "Gallery" );
...
}

}
or better: 
function Gallery () {
super( APPSETTINGS.SECTION_GALLERY );
...
}
Example
  • Overriding the default stop action with a scaling animation: 
    public override function get stopAction () : IAction {
var queue:ActionQueue = new ActionQueue("Section1_1 stop");
const CURRENT:Number = Number.NaN;
var effect:Function = Quadratic.easeOut;
queue.addAction(new AQScale().scale(this, .3, CURRENT, CURRENT, 0, 0, effect));
queue.addAction(new AQSet().setVisible(this, false));
return queue;
}

Summary

Instance properties
Instance methods
  • setFlowManager (inFlowManager:FlowManager) : void
    • Sets the FlowManager.
  • getFlowManager () : FlowManager
  • registerWithFlowManager () : void
    • Registers this FlowSection with the FlowManager - only if getName returns a valid name (not null).
  • getName () : String
    • Returns the name that is used to register this class to the FlowManager.
  • setName (inName:String) : void
    • Sets the name of the section
  • die () : void
    • To be implemented by subclasses.
  • start () : void
    • Default start function.
  • stop () : void
    • Default stop function.

Instance properties

startAction

startAction:IAction(read)

The Action to be run when the section is shown. Actions are run by ActionRunner.

stopAction

stopAction:IAction(read)

The Action to be run when the section is hidden. Actions are run by ActionRunner.

Instance methods

die

function die() : void

To be implemented by subclasses.

getFlowManager

function getFlowManager() : FlowManager
Returns

getName

function getName() : String

Returns the name that is used to register this class to the FlowManager. Override this function to set the name of a FlowSection subclass.

Example 
  • public override function getName () : String {
return "Gallery";
}

registerWithFlowManager

function registerWithFlowManager() : void

Registers this FlowSection with the FlowManager - only if getName returns a valid name (not null). This method is called automatically by the constructor. Only call this function if you have set a non-default FlowManager in setFlowManager, or if you don't pass a name in the constuctor.

setFlowManager

function setFlowManager(inFlowManager:FlowManager) : void

Sets the FlowManager. You must call registerWithFlowManager after setting the FlowManager.

Parameters
inFlowManager:FlowManager to set

setName

function setName(inName:String) : void

Sets the name of the section

Parameters
inName:new name of the FlowSection

start

function start() : void

Default start function.

stop

override function stop() : void

Default stop function.

Overrides
  • MovieClip.stop