|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.flagstone.transform.FSTransformObject
com.flagstone.transform.FSGradient
public class FSGradient
FSGradient defines a control point that is used to specify how a gradient colour is displayed.
Two or more control points are used to define how the colour changes across the gradient square. Each control point specifies:
Attributes | |
---|---|
ratio | The location of the control point across the gradient square. |
color | The colour displayed at the control point. |
The location of the control point is defined by a ratio - a number between 0 and 255 - that specifies the relative location in the square. For Linear Gradient Fills a ratio of zero is mapped to the left side of the gradient square and 255 is mapped to the right side of the square. For Radial Gradient Fills a ratio of zero is mapped to the centre of the gradient square and 255 is mapped to the edge of the largest circle that fits inside the gradient square. A ratio is used rather than specifying coordinates within the gradient square as the coordinate space is transformed to fit the shape that the gradient is being displayed in.
Note that the object used to create the shape definition determines whether the alpha channel is encoded in the gradient colours. Simply specifying the level of transparency in the FSColor object is not sufficient.
The FSGradient class represents the GradientRecord structure from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 1.
Constructor Summary | |
---|---|
FSGradient(FSCoder coder)
Construct an FSGradient object, initialising it with values decoded from an encoded object. |
|
FSGradient(FSGradient obj)
Constructs an FSGradient object by copying values from an existing object. |
|
FSGradient(int aRatio,
FSColor aColor)
Constructs an FSGradient object with the specified ratio and color. |
Method Summary | |
---|---|
void |
appendDescription(java.lang.StringBuffer buffer,
int depth)
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. |
java.lang.Object |
clone()
Creates a deep copy of the entire object. |
void |
decode(FSCoder coder)
|
void |
encode(FSCoder coder)
|
boolean |
equals(java.lang.Object anObject)
Returns true if anObject is equal to this one. |
FSColor |
getColor()
Gets the colour that is displayed at the control point across the gradient square defined by the ratio. |
int |
getRatio()
Gets the ratio that defines the relative point across the gradient square. |
int |
length(FSCoder coder)
|
void |
setColor(FSColor aColor)
Sets the colour that is displayed at the control point across the gradient square. |
void |
setRatio(int aNumber)
Sets the ratio that defines the control point across the gradient square. |
Methods inherited from class com.flagstone.transform.FSTransformObject |
---|
name, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FSGradient(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSGradient(int aRatio, FSColor aColor)
aRatio
- the ratio along the gradient square.aColor
- the color at the control point.public FSGradient(FSGradient obj)
obj
- an FSGradient object.Method Detail |
---|
public int getRatio()
public FSColor getColor()
public void setRatio(int aNumber)
aNumber
- the ratio along the gradient square.public void setColor(FSColor aColor)
aColor
- the color at the control point.public java.lang.Object clone()
FSTransformObject
clone
in class FSTransformObject
public boolean equals(java.lang.Object anObject)
equals
in class FSTransformObject
public void appendDescription(java.lang.StringBuffer buffer, int depth)
FSTransformObject
appendDescription
in class FSTransformObject
buffer
- a StringBuffer to which the description of each object is
appended.depth
- the maximum level of nesting up to which objects will be
displayed.public int length(FSCoder coder)
length
in class FSTransformObject
public void encode(FSCoder coder)
encode
in class FSTransformObject
public void decode(FSCoder coder)
decode
in class FSTransformObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |