com.flagstone.transform.action
Class GotoLabel

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

All Implemented Interfaces:

Action, Copyable<Action>, SWFEncodeable

public final class GotoLabel
extends Object
implements Action

The GotoLabel action instructs the player to move to the frame in the current movie with the specified label - previously assigned using a FrameLabel object.

Constructor Summary

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

GotoLabel(String aString)
Creates a GotoLabel action with the specified frame label.

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

Method Summary

GotoLabel	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
String	getLabel() Get the frame label.
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

GotoLabel

public GotoLabel(SWFDecoder coder)
          throws IOException

Creates and initialises a GotoLabel 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.

GotoLabel

public GotoLabel(String aString)

Creates a GotoLabel action with the specified frame label.

Parameters:

aString - the label assigned a particular frame in the movie. Must not be null or an empty string.

GotoLabel

public GotoLabel(GotoLabel object)

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

Parameters:

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

Method Detail

getLabel

public String getLabel()

Get the frame label.

Returns:

the label assigned a particular frame in the movie.

copy

public GotoLabel 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.