|
|||||||||
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.FSInitialize
public class FSInitialize
FSInitialize is used to specify a sequence of actions that are executed to initialise a movie clip before it is displayed.
It implements the #initclip pragma in the ActionScript language.
Attributes | |
---|---|
type | Identifies the data structure when it is encoded. Read-only. |
identifier | The identifier of the FSDefineMovieClip object that defines the movie clip. |
actions | An array of actions that will be executed to initialize the movie clips. |
Unlike the FSDoAction class which specifies the actions that are executed when a particular frame is displayed the actions contained in an FSInitialize object are executed only once, regardless of where the object is included in a movie. If a frame containing the FSInitialize object is played again the actions are skipped. Also there can only be one FSInitialize object for each movie clip defined in the movie.
ArrayList actions = new ArrayList(); actions.add(new FSPush("_root")); actions.add(FSAction.GetVariable()); int clipId = movie.newIdentifier(); movie.add(new FSDefineMovieClip(clipId, clipObjects)); ... movie.add(new FSInitialize(clipId, actions)); ... movie.add(new FSShowFrame());
The FSInitialize class represents the DoInitAction tag from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 6.
FSDoAction
Field Summary |
---|
Constructor Summary | |
---|---|
FSInitialize(FSCoder coder)
Construct an FSInitialize object, initialising it with values decoded from an encoded object. |
|
FSInitialize(FSInitialize obj)
Constructs an FSInitialize object by copying values from an existing object. |
|
FSInitialize(int anIdentifier,
java.util.ArrayList anArray)
Constructs an FSInitialize object that will initialize the movie clip with the specified identifier with the actions in the array. |
|
FSInitialize(int anIdentifier,
byte[] bytes)
Constructs an FSInitialize object that will initialize the movie clip with the specified identifier with the encoded actions. |
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 used to initialize the movie clip. |
byte[] |
getEncodedActions()
Get the array of encoded actions that are executed when the frame is displayed. |
int |
getIdentifier()
Returns the identifier of the movie clip that will be initialized. |
int |
length(FSCoder coder)
|
void |
setActions(java.util.ArrayList anArray)
Set the array of actions of the movie clip that will be initialized |
void |
setEncodedActions(byte[] bytes)
Set the array of encoded actions generated by the classes in the Translate framework. |
void |
setIdentifier(int aNumber)
Sets the identifier of the movie clip that will be initialized. |
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 FSInitialize(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSInitialize(int anIdentifier, java.util.ArrayList anArray)
anIdentifier
- the identifier of the movie clip to initializeanArray
- the array of action objects.public FSInitialize(int anIdentifier, byte[] bytes)
anIdentifier
- the identifier of the movie clip to initializebytes
- an array of encoded action objects.public FSInitialize(FSInitialize obj)
obj
- an FSInitialize object.Method Detail |
---|
public int getIdentifier()
public void setIdentifier(int aNumber)
aNumber
- the identifier of the movie clip. The value must be in the
range 1..65535.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 |