com.arctorus.documents
Class FillFormat

java.lang.Object
  extended by com.arctorus.documents.FillFormat
All Implemented Interfaces:
java.lang.Cloneable

public final class FillFormat
extends java.lang.Object
implements java.lang.Cloneable

Defines how to fill a shape. By default shapes are not filled.


Constructor Summary
FillFormat()
          Default constructor.
 
Method Summary
 FillFormat clone()
          Creates and returns a copy of this object.
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 java.awt.Color getColor()
          Get color of a solid fill style.
 Gradient getGradient()
          Get gradient fill parameters.
 Texture getTexture()
          Return texture fill parameters.
 float getTransparency()
          Get transparency of a shape.
 FillFormatType getType()
          Get shape fill type.
 int hashCode()
          Returns a hash code value for the object.
 void setColor(java.awt.Color color)
          Set color of a solid fill style.
 void setGradient(Gradient gradient)
          Set gradient fill parameters.
 void setTexture(Texture texture)
          Set texture fill parameters.
 void setTransparency(float transparency)
          Set transparency of a shape.
 void setType(FillFormatType type)
          Set shape fill type.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FillFormat

public FillFormat()
Default constructor.

Method Detail

getType

public FillFormatType getType()
Get shape fill type.


setType

public void setType(FillFormatType type)
Set shape fill type.

Parameters:
type - new fill type.

getColor

public java.awt.Color getColor()
Get color of a solid fill style.


setColor

public void setColor(java.awt.Color color)
Set color of a solid fill style.

Parameters:
color - new solid color. Null to turn the filling off.

getTransparency

public float getTransparency()
Get transparency of a shape. Value is in the range [0..1].


setTransparency

public void setTransparency(float transparency)
Set transparency of a shape.

Parameters:
transparency - new transparency. Must be in the range [0..1].

getGradient

public Gradient getGradient()
Get gradient fill parameters. By default gradient is GradientLinear

See Also:
GradientLinear, GradientFromCenter

setGradient

public void setGradient(Gradient gradient)
Set gradient fill parameters.

Parameters:
gradient - new gradient. Null to turn the filling off.

getTexture

public Texture getTexture()
Return texture fill parameters.


setTexture

public void setTexture(Texture texture)
Set texture fill parameters.

Parameters:
texture - new texture. Null to turn the filling off.

hashCode

public int hashCode()
Returns a hash code value for the object.

Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.

Overrides:
equals in class java.lang.Object

clone

public FillFormat clone()
                 throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.

Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException