com.flagstone.transform.fillstyle
Class SolidFill

java.lang.Object
  com.flagstone.transform.fillstyle.SolidFill

All Implemented Interfaces:

Copyable<FillStyle>, SWFEncodeable, FillStyle

public final class SolidFill
extends Object
implements FillStyle

SolidFill defines a solid colour that is used to fill an enclosed area in a shape. Shapes can be filled with transparent colours but only if the fill style is used in a DefineShape3 object.

Constructor Summary

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

SolidFill(SolidFill object)
Creates and initialises a SolidFill fill style using the values copied from another SolidFill object.

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

Method Summary

SolidFill	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 of the fill style.
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 of the fill style.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SolidFill

public SolidFill(SWFDecoder coder,
                 Context context)
          throws IOException

Creates and initialises a SolidFill fill style 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.

SolidFill

public SolidFill(Color aColor)

Creates a SolidFill object with the specified colour.

Parameters:

aColor - an Color object that defines the colour that the area will be filled with. Must not be null.

SolidFill

public SolidFill(SolidFill object)

Creates and initialises a SolidFill fill style using the values copied from another SolidFill object.

Parameters:

object - a SolidFill fill style from which the values will be copied.

Method Detail

getColor

public Color getColor()

Get the colour of the fill style.

Returns:

the fill colour

setColor

public void setColor(Color aColor)

Sets the colour of the fill style.

Parameters:

aColor - an Color object that defines the colour that the area will be filled with. Must not be null.

copy

public SolidFill copy()

Creates a complete copy of this object.

Specified by:

copy in interface Copyable<FillStyle>

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.