|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.flagstone.transform.FSTransformObject
com.flagstone.transform.FSMovieObject
com.flagstone.transform.FSDoAction
public class FSDoAction
FSDoAction is used to specify a sequence of actions that are executed when a frame is displayed.
Attributes | |
---|---|
type | Identifies the data structure when it is encoded. Read-only. |
actions | An array of FSActionObjects which are executed by the Flash Player when the current frame is displayed. The actions are executed in the order they appear in the array. |
encodedActions | An array of bytes containing encoded actions can also be set. The encoded actions are typically generated by the parser in the Translate framework. The actions array and encodedActions cannot both be valid at the same time. Accessor methods used to set either of the attributes will set the other to null. |
To define the actions for a given frame the FSDoAction object should be added to a movie after the previous frame is displayed but before the FSShowFrame object that displays the 'current' frame and triggers the actions to be executed.
Only one FSDoAction object can be used to specify the actions for a given frame. If more than one FSDoAction object is added in a single frame only the actions contained in the last FSDoAction object (before the FSShowFrame object) will be executed when the frame is displayed. The other FSDoAction objects will be ignored.
ArrayList actions = new ArrayList(); actions.add(new FSPush("_root")); actions.add(new FSAction(FSAction.GetVariable)); ... movie.add(new FSShowFrame()); // previous frame ... movie.add(new FSDoAction(actions)); movie.add(new FSShowFrame()); // frame where actions will be executed
The FSDoAction class represents the DoAction tag from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 1.
Field Summary |
---|
Constructor Summary | |
---|---|
FSDoAction(java.util.ArrayList anArray)
Constructs an FSDoAction object with an array of actions. |
|
FSDoAction(byte[] bytes)
Constructs an FSDoAction object with an array of encoded actions generated by the classes in Translate. |
|
FSDoAction(FSCoder coder)
Construct an FSDoAction object, initialising it with values decoded from an encoded object. |
|
FSDoAction(FSDoAction obj)
Constructs an FSDoAction object by copying values from an existing object. |
Method Summary | |
---|---|
void |
add(FSActionObject anAction)
Adds the action object to the array of actions. |
void |
appendDescription(java.lang.StringBuffer buffer,
int depth)
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. |
java.lang.Object |
clone()
Creates a deep copy of the entire object. |
void |
decode(FSCoder coder)
|
void |
encode(FSCoder coder)
|
boolean |
equals(java.lang.Object anObject)
Returns true if anObject is equal to this one. |
java.util.ArrayList |
getActions()
Get the array of actions that are executed when the frame is displayed. |
byte[] |
getEncodedActions()
Get the array of encoded actions that are executed when the frame is displayed. |
int |
length(FSCoder coder)
|
void |
setActions(java.util.ArrayList anArray)
Set the array of actions that will be executed when the next ShowFrame tag is executed by the Flash Player. |
void |
setEncodedActions(byte[] bytes)
Set the array of encoded actions generated by the classes in the Translate framework. |
Methods inherited from class com.flagstone.transform.FSMovieObject |
---|
getType |
Methods inherited from class com.flagstone.transform.FSTransformObject |
---|
name, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FSDoAction(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSDoAction(java.util.ArrayList anArray)
anArray
- the array of action objects.public FSDoAction(byte[] bytes)
bytes
- an array of encoded action objects.public FSDoAction(FSDoAction obj)
obj
- an FSDoAction object.Method Detail |
---|
public void add(FSActionObject anAction)
anAction
- an object belonging to a class derived from FSActionObject.public java.util.ArrayList getActions()
public void setActions(java.util.ArrayList anArray)
anArray
- the array of action objects.public byte[] getEncodedActions()
public void setEncodedActions(byte[] bytes)
bytes
- the array of encoded actions.public java.lang.Object clone()
FSTransformObject
clone
in class FSTransformObject
public boolean equals(java.lang.Object anObject)
FSMovieObject
equals
in class FSMovieObject
public void appendDescription(java.lang.StringBuffer buffer, int depth)
FSTransformObject
appendDescription
in class FSMovieObject
buffer
- a StringBuffer to which the description of each object is
appended.depth
- the maximum level of nesting up to which objects will be
displayed.public int length(FSCoder coder)
length
in class FSMovieObject
public void encode(FSCoder coder)
encode
in class FSMovieObject
public void decode(FSCoder coder)
decode
in class FSMovieObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |