com.flagstone.transform
Class ShowFrame

java.lang.Object
  com.flagstone.transform.ShowFrame

All Implemented Interfaces:

Copyable<MovieTag>, SWFEncodeable, MovieTag

public final class ShowFrame
extends Object
implements MovieTag

ShowFrame is used to instruct the Flash Player to display a single frame in a movie or movie clip.

When a frame is displayed the Flash Player performs the following:

• Any actions defined using a DoAction object are executed.
• The contents of the Flash Player's display list are drawn on the screen.

The scope of a frame is delineated by successive ShowFrame objects. All the commands that affect change the state of the display list or define actions to be executed take effect when the Flash Player displays the frame. All the objects displayed in a frame must be defined before they can be displayed.

Method Summary

ShowFrame	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
static ShowFrame	getInstance() Returns a shared ShowFrame object.
static ShowFrame	getInstance(SWFDecoder coder, Context context) Returns a shared ShowFrame object.
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

Method Detail

getInstance

public static ShowFrame getInstance()

Returns a shared ShowFrame object.

Returns:

an object that can safely be shared among objects.

getInstance

public static ShowFrame getInstance(SWFDecoder coder,
                                    Context context)
                             throws IOException

Returns a shared ShowFrame object.

Parameters:

coder - an SWFEncoder object.

context - a Context object used to obtain the total number of frames in a movie.

Returns:

an object that can safely be shared among objects.

Throws:

IOException - if an error occurs while encoding the object.

copy

public ShowFrame copy()

Creates a complete copy of this object.

Specified by:

copy in interface Copyable<MovieTag>

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.