com.flagstone.transform
Class Background

java.lang.Object
  com.flagstone.transform.Background

All Implemented Interfaces:

Copyable<MovieTag>, SWFEncodeable, MovieTag

public final class Background
extends Object
implements MovieTag

Background sets the background colour displayed in every frame in the movie.

Although the colour is specified using an Color object the colour displayed is completely opaque - the alpha channel information in the object is ignored.

The background colour must be set before the first frame is displayed otherwise the background colour defaults to white. This is typically the first object in a coder. If more than one Background object is added to a movie then only first one sets the background colour. Subsequent objects are ignored.

See Also:

Color

Constructor Summary

Background(Background object)
Creates and initialises an Background object using the values copied from another Background object.

Background(Color aColor)
Creates a Background object with a the specified colour.

Background(SWFDecoder coder, Context context)
Creates and initialises a Background object using values encoded in the Flash binary format.

Method Summary

Background	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
Color	getColor() Get the colour for the movie background.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
void	setColor(Color aColor) Sets the colour for the movie background.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Background

public Background(SWFDecoder coder,
                  Context context)
           throws IOException

Creates and initialises a Background object using values encoded in the Flash binary format.

Parameters:

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

context - a Context object used to manage the decoders for different type of object and to pass information on how objects are decoded.

Throws:

IOException - if an error occurs while decoding the data.

Background

public Background(Color aColor)

Creates a Background object with a the specified colour.

Parameters:

aColor - the colour for the background. Must not be null.

Background

public Background(Background object)

Creates and initialises an Background object using the values copied from another Background object.

Parameters:

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

Method Detail

getColor

public Color getColor()

Get the colour for the movie background.

Returns:

the Color for the background of the Flash Player screen.

setColor

public void setColor(Color aColor)

Sets the colour for the movie background.

Parameters:

aColor - the colour for the background. Must not be null.

copy

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