|
|||||||||
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.FSGotoLabel
public class FSGotoLabel
The FSGotoLabel action instructs the player to move to the frame in the current movie with the specified label.
The label is assigned to the frame using the FSFrameLabel object.
Attributes | |
---|---|
type | Identifies the action when it is encoded. Read-only. |
label | The name that will be assigned to the current frame. |
FSMovie movie = new FSMovie(); // Assign the name to the "current" frame movie.add(new FSFrameLabel("FirstFrame")); movie.add(new FSShowFrame()); ... // Move the timeline back to the named frame when the actions // associated with this frame is executed. FSDoAction actions = new FSDoAction(); actions.add(new FSGotoLabel("FirstFrame")); movie.add(actions); movie.add(new FSShowFrame());
The scope of a frame is delineated by successive FSShowFrame objects. To assign a label to a frame the FSFrameLabel object can be added at any point prior to the FSShowFrame object that marks the end of the frame.
FSGotoLabel represents the ActionGotoLabel 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 | |
---|---|
FSGotoLabel(FSCoder coder)
Construct an FSGotoLabel object, initialising it with values decoded from an encoded object. |
|
FSGotoLabel(FSGotoLabel obj)
Constructs an FSGotoLabel object by copying values from an existing object. |
|
FSGotoLabel(java.lang.String aString)
Constructs an FSGotoLabel action with the specified frame label. |
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. |
java.lang.String |
getLabel()
Gets the frame label. |
int |
length(FSCoder coder)
|
void |
setLabel(java.lang.String aString)
Sets the frame label. |
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 FSGotoLabel(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSGotoLabel(java.lang.String aString)
aString
- the label assigned a particular frame in the movie.public FSGotoLabel(FSGotoLabel obj)
obj
- an FSGotoLabel object.Method Detail |
---|
public java.lang.String getLabel()
public void setLabel(java.lang.String aString)
aString
- the label assigned a particular frame in the movie.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 |