com.flagstone.transform.action
Class Call

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

All Implemented Interfaces:

Action, Copyable<Action>, SWFEncodeable

public final class Call
extends Object
implements Action

Call is used to execute the actions previously assigned to a given frame with an DoAction object. Call is a stack-based action, the value for the frame name or frame number is retrieved from the top of the stack when it is executed.

Method Summary

Call	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
static Call	getInstance() Returns a shared instance of the Call action.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Call getInstance()

Returns a shared instance of the Call action.

Returns:

a singleton used to represent all Call actions.

copy

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

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.