com.flagstone.transform.action
Class GotoFrame

java.lang.Object
  com.flagstone.transform.action.GotoFrame

All Implemented Interfaces:

Action, Copyable<Action>, SWFEncodeable

public final class GotoFrame
extends Object
implements Action

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

GotoFrame 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 and the ExecuteMethod action is used to execute the gotoAndPlay() or gotoAndStop() which start and stop playing a movie clip.

See Also:

GotoFrame2

Constructor Summary

GotoFrame(GotoFrame object)
Creates and initialises a GotoFrame action using the values copied from another GotoFrame action.

GotoFrame(int number)
Creates a GotoFrame with the specified frame number.

GotoFrame(SWFDecoder coder)
Creates and initialises an GotoFrame action using values encoded in the Flash binary format.

Method Summary

GotoFrame	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
int	getFrameNumber() Returns the number of the frame to move the main time-line to.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GotoFrame

public GotoFrame(SWFDecoder coder)
          throws IOException

Creates and initialises an GotoFrame action using values encoded in the Flash binary format.

Parameters:

coder - an SWFDecoder object that contains the encoded Flash data.

Throws:

IOException - if an error occurs while decoding the data.

GotoFrame

public GotoFrame(int number)

Creates a GotoFrame with the specified frame number.

Parameters:

number - the number of the frame. Must be in the range 0..65535.

GotoFrame

public GotoFrame(GotoFrame object)

Creates and initialises a GotoFrame action using the values copied from another GotoFrame action.

Parameters:

object - a GotoFrame action from which the values will be copied.

Method Detail

getFrameNumber

public int getFrameNumber()

Returns the number of the frame to move the main time-line to.

Returns:

the offset to the next frame to be displayed.

copy

public GotoFrame copy()

Creates a complete copy of this object.

Specified by:

copy in interface Copyable<Action>

Returns:

a deep-copy of this object. New instances of mutable objects are copied and immutable instances are shared.

toString

public String toString()

Overrides:

toString in class Object

prepareToEncode

public int prepareToEncode(Context context)

Prepare an object for encoding, returning the expected size of an object when it is encoded. This method also used to initialise variables, such as offsets and flags that will be used when the object is encoded. Generally the method returns the size in bytes, however when called on objects that use bit fields such as shapes the methods will return the size in bits.

Specified by:

prepareToEncode in interface SWFEncodeable

Parameters:

context - an Context that allows information to be passed between objects to control how they are initialised for encoding.

Returns:

the size of the object when it is encoded.

encode

public void encode(SWFEncoder coder,
                   Context context)
            throws IOException

Encode an object to the Flash binary format.

Specified by:

encode in interface SWFEncodeable

Parameters:

coder - an SWFEncoder object.

context - an Context that allows information to be passed between objects to control how they are initialised for encoding.

Throws:

IOException - if an error occurs while encoding the object.