|
|||||||||
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.FSActionObject
com.flagstone.transform.FSWaitForFrame
public class FSWaitForFrame
The FSWaitForFrame action instructs the player to wait until the specified frame number has been loaded.
If the frame has been loaded then the actions in the following n actions are executed. This action is most often used to execute a short animation loop that plays until the main part of a movie has been loaded.
Attributes | |
---|---|
type | Identifies the action when it is encoded. Read-only. |
frameNumber | The number of the frame to check to see whether it has been loaded. |
actionCount | The number of actions, following the FSWaitForFrame action that will be executed when the frame has been loaded. |
actions.add(new FSWaitForFrame(8, 1)); actions.add(new FSGotoFrame(8));
This method of waiting until a frame has been loaded is considered obsolete. Determining the number of frames loaded using the FramesLoaded property of the Flash player in combination with an FSIf action is now the preferred mechanism:
FSDoAction actions = new FSDoAction(); actions.add(new FSPush("_root")); actions.add(new FSAction(FSAction.GetVariable)); actions.add(new FSPush(FSPush.FramesLoaded)); actions.add(new FSAction(FSAction.GetProperty)); actions.add(new FSPush(8)); actions.add(new FSAction(FSAction.Less)); actions.add(new FSIf(-29)); actions.add(new FSGotoFrame(8));
The FSWaitForFrame class represents the ActionWaitForFrame action of the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 3.
Field Summary |
---|
Fields inherited from class com.flagstone.transform.FSActionObject |
---|
Call, ExceptionHandler, GetUrl, GetUrl2, GotoFrame, GotoFrame2, GotoLabel, If, Jump, length, NewFunction, NewFunction2, Push, RegisterCopy, SetTarget, Table, type, WaitForFrame, WaitForFrame2, With |
Constructor Summary | |
---|---|
FSWaitForFrame(FSCoder coder)
Construct an FSWaitForFrame object, initialising it with values decoded from an encoded object. |
|
FSWaitForFrame(FSWaitForFrame obj)
Constructs an FSWaitForFrame object by copying values from an existing object. |
|
FSWaitForFrame(int aFrameNumber,
int anActionCount)
Constructs an FSWaitForFrame object with the specified frame number and the number of actions that will be executed when the frame is loaded. |
Method Summary | |
---|---|
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. |
void |
decode(FSCoder coder)
|
void |
encode(FSCoder coder)
|
boolean |
equals(java.lang.Object anObject)
Returns true if anObject is equal to this one. |
int |
getActionCount()
Gets the number of actions that will be executed when the specified frame is loaded. |
int |
getFrameNumber()
Gets the frame number. |
int |
length(FSCoder coder)
|
void |
setActionCount(int aNumber)
Sets the number of actions to execute if the frame has been loaded. |
void |
setFrameNumber(int aNumber)
Sets the frame number. |
Methods inherited from class com.flagstone.transform.FSActionObject |
---|
getType, length |
Methods inherited from class com.flagstone.transform.FSTransformObject |
---|
clone, name, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FSWaitForFrame(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSWaitForFrame(int aFrameNumber, int anActionCount)
aFrameNumber
- the number of the frame to wait for.anActionCount
- the number of actions to execute.public FSWaitForFrame(FSWaitForFrame obj)
obj
- an FSWaitForFrame object.Method Detail |
---|
public int getFrameNumber()
public int getActionCount()
public void setFrameNumber(int aNumber)
aNumber
- the number of the frame to wait for.public void setActionCount(int aNumber)
aNumber
- the number of actions to execute.public boolean equals(java.lang.Object anObject)
FSActionObject
equals
in class FSActionObject
public void appendDescription(java.lang.StringBuffer buffer, int depth)
FSTransformObject
appendDescription
in class FSTransformObject
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 FSActionObject
public void encode(FSCoder coder)
encode
in class FSActionObject
public void decode(FSCoder coder)
decode
in class FSActionObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |