com.flagstone.transform
Class FSGotoFrame

java.lang.Object
  extended by com.flagstone.transform.FSTransformObject
      extended by com.flagstone.transform.FSActionObject
          extended by com.flagstone.transform.FSGotoFrame
All Implemented Interfaces:
java.lang.Cloneable

public class FSGotoFrame
extends FSActionObject

The FSGotoFrame action instructs the player to move to the specified frame in the current movie's main time-line.

Attributes
type Identifies the action when it is encoded. Read-only.
frameNumber The number of the frame in the movie's main time-line, in the range 1..65535, to move to.

The movie will start playing immediately from the specified frame.

Examples

 FSGotoFrame gotoFrame = new FSGotoFrame(12);
 

FSGotoFrame is only used to control the main time-line of a movie. Controlling how an individual movie clip is played is handled by a different mechanism. From Flash 5 onward movie clips are defined as objects. The ExecuteMethod action is used to execute the gotoAndPlay() or gotoAndStop() methods that control a movie clip's time-line:

 // Push the arguments followed by the number of arguments onto the stack
 
 frameAction.add(new FSPush("frameName"));
 frameAction.add(new FSPush(1));
 
 // Get a reference to the object.
 
 frameAction.add(new FSPush("_root"));
 frameAction.add(new FSPush("movieClip"));
 frameAction.add(new FSAction(FSAction.GetAttribute));
 
 // Place the name of the method on the stack then execute it.
 
 frameAction.add(new FSPush("gotoAndPlay"));
 frameAction.add(new FSAction(FSAction.ExecuteMethod));
 

History

The FSGotoFrame represents the ActionGotoFrame action of the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 3. This class is now superseded by the FSGotoFrame2 action which allows either the name of a frame or a number of be specified.


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
FSGotoFrame(FSCoder coder)
          Construct an FSGotoFrame object, initialising it with values decoded from an encoded object.
FSGotoFrame(FSGotoFrame obj)
          Constructs an FSGotoFrame object by copying values from an existing object.
FSGotoFrame(int aNumber)
          Constructs an FSGotoFrame with the specified frame number.
 
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 getFrameNumber()
          Gets the number of the frame to move the main time-line to.
 int length(FSCoder coder)
           
 void setFrameNumber(int aNumber)
          Sets the number of the frame to move the main time-line to.
 
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

FSGotoFrame

public FSGotoFrame(FSCoder coder)
Construct an FSGotoFrame object, initialising it with values decoded from an encoded object.

Parameters:
coder - an FSCoder containing the binary data.

FSGotoFrame

public FSGotoFrame(int aNumber)
Constructs an FSGotoFrame with the specified frame number. The frame number must be in the range 1..65535.

Parameters:
aNumber - the number of the frame.

FSGotoFrame

public FSGotoFrame(FSGotoFrame obj)
Constructs an FSGotoFrame object by copying values from an existing object.

Parameters:
obj - an FSGotoFrame object.
Method Detail

getFrameNumber

public int getFrameNumber()
Gets the number of the frame to move the main time-line to.

Returns:
the frame number.

setFrameNumber

public void setFrameNumber(int aNumber)
Sets the number of the frame to move the main time-line to. The frame number must be in the range 1..65535.

Parameters:
aNumber - the frame number.

equals

public boolean equals(java.lang.Object anObject)
Description copied from class: FSActionObject
Returns true if anObject is equal to this one. Objects are considered equal if they would generate identical binary data when they are encoded to a Flash file.

Overrides:
equals in class FSActionObject
Returns:
true if this object would be identical to anObject when encoded.

appendDescription

public void appendDescription(java.lang.StringBuffer buffer,
                              int depth)
Description copied from class: FSTransformObject
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. This method provide a more controlled way of creating a string representation of an object since large objects such as font or shape definitions can contain dozens of nested objects. The representation of the object is appended to the StringBuffer, showing the name of the class and values of the attributes it contains. If the object contains any attributes that are objects then the object graph will be traversed up to the specified depth. If objects are nested at a level less than specified depth then the full string representation of the object is displayed. For objects at the specified depth only the name of the class is displayed. Any objects below this depth are not displayed.

Specified by:
appendDescription in class FSTransformObject
Parameters:
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.

length

public int length(FSCoder coder)
Overrides:
length in class FSActionObject

encode

public void encode(FSCoder coder)
Overrides:
encode in class FSActionObject

decode

public void decode(FSCoder coder)
Overrides:
decode in class FSActionObject