com.flagstone.transform.movieclip
Class QuicktimeMovie

java.lang.Object
  com.flagstone.transform.movieclip.QuicktimeMovie

All Implemented Interfaces:

Copyable<MovieTag>, SWFEncodeable, MovieTag

public final class QuicktimeMovie
extends Object
implements MovieTag

The QuicktimeMovie defines the path to an Quicktime movie to be played.

Constructor Summary

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

QuicktimeMovie(String aString)
Creates a QuicktimeMovie object referencing the specified file.

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

Method Summary

QuicktimeMovie	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
String	getPath() Get the reference to the file containing the movie.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
void	setPath(String aString) Sets the reference to the file containing the movie.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QuicktimeMovie

public QuicktimeMovie(SWFDecoder coder)
               throws IOException

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

QuicktimeMovie

public QuicktimeMovie(String aString)

Creates a QuicktimeMovie object referencing the specified file.

Parameters:

aString - the file or URL where the file is located. Must not be null.

QuicktimeMovie

public QuicktimeMovie(QuicktimeMovie object)

Creates and initialises a QuicktimeMovie object using the values copied from another QuicktimeMovie object.

Parameters:

object - a QuicktimeMovie object from which the values will be copied.

Method Detail

getPath

public String getPath()

Get the reference to the file containing the movie.

Returns:

the path to the Quicktime movie.

setPath

public void setPath(String aString)

Sets the reference to the file containing the movie.

Parameters:

aString - the file or URL where the file is located. Must not be null.

copy

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