Package com.stimulsoft.base.drawing

Class StiGlareBrush

java.lang.Object

com.stimulsoft.base.drawing.StiBrush

com.stimulsoft.base.drawing.StiGlareBrush

All Implemented Interfaces:

IStiInvalidator, IStiSerializable, IStiSerializableToString, Cloneable

public class StiGlareBrush
extends StiBrush

Class describes a glare gradient brush.

Field Summary

Fields

Modifier and Type	Field	Description
double	angle

Constructor Summary

Constructors

Constructor	Description
StiGlareBrush()	Creates a new instance of the StiGlareBrush class.
StiGlareBrush(StiColor startColor, StiColor endColor, double angle)	Creates a new instance of the StiGlareBrush class.
StiGlareBrush(StiColor startColor, StiColor endColor, double angle, float focus, float scale)	Creates a new instance of the StiGlareBrush class.

Method Summary

Modifier and Type	Method	Description
void	deserialize(String value)
boolean	equals(Object obj)
final double	getAngle()	Gets or sets the angle, measured in degrees clockwise from the x-axis, of the gradient's orientation line.
final StiColor	getEndColor()	Gets or sets the ending color for the gradient.
final float	getFocus()	Gets or sets value from 0 through 1 that specifies the center of the gradient (the point where the gradient is composed of only the ending color).
Paint	getPaint()
StiRectangle	getRectangle()
final float	getScale()	Gets or sets value from 0 through 1 that specifies how fast the colors falloff from the focus.
final StiColor	getStartColor()	Gets or sets the starting color for the gradient.
int	hashCode()
void	LoadValuesFromJson(JSONObject jObject)
String	serialize()
final void	setAngle(double value)
final void	setEndColor(StiColor value)
final void	setFocus(float value)
void	setRectangle(StiRectangle rectangle)
final void	setScale(float value)
final void	setStartColor(StiColor value)

Methods inherited from class com.stimulsoft.base.drawing.StiBrush

clone, dispose, getBrush, getInvalidator, getReference, invalidate, light, LoadFromJson, setInvalidator, setReference, ToColor

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

angle

public double angle

Constructor Details

StiGlareBrush

public StiGlareBrush()

Creates a new instance of the StiGlareBrush class.

StiGlareBrush

public StiGlareBrush(StiColor startColor,
 StiColor endColor,
 double angle)

Creates a new instance of the StiGlareBrush class.

Parameters:

startColor - the starting color for the gradient.

endColor - The ending color for the gradient.

angle - The angle, measured in degrees clockwise from the x-axis, of the gradient's orientation line.

StiGlareBrush

public StiGlareBrush(StiColor startColor,
 StiColor endColor,
 double angle,
 float focus,
 float scale)

Creates a new instance of the StiGlareBrush class.

Parameters:

startColor - the starting color for the gradient.

endColor - The ending color for the gradient.

angle - The angle, measured in degrees clockwise from the x-axis, of the gradient's orientation line.

focus - The value from 0 through 1 that specifies the center of the gradient (the point where the gradient is composed of only the ending color).

scale - The value from 0 through 1 that specifies how fast the colors falloff from the focus.

Method Details

serialize

public String serialize()

deserialize

public void deserialize(String value)

getStartColor

public final StiColor getStartColor()

Gets or sets the starting color for the gradient.

setStartColor

public final void setStartColor(StiColor value)

getEndColor

public final StiColor getEndColor()

Gets or sets the ending color for the gradient.

setEndColor

public final void setEndColor(StiColor value)

getAngle

public final double getAngle()

Gets or sets the angle, measured in degrees clockwise from the x-axis, of the gradient's orientation line.

setAngle

public final void setAngle(double value)

getFocus

public final float getFocus()

Gets or sets value from 0 through 1 that specifies the center of the gradient (the point where the gradient is composed of only the ending color).

setFocus

public final void setFocus(float value)

getPaint

public Paint getPaint()

getScale

public final float getScale()

Gets or sets value from 0 through 1 that specifies how fast the colors falloff from the focus.

setScale

public final void setScale(float value)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getRectangle

public StiRectangle getRectangle()

Returns:

the rectangle

setRectangle

public void setRectangle(StiRectangle rectangle)

Parameters:

rectangle - the rectangle to set

LoadValuesFromJson

public void LoadValuesFromJson(JSONObject jObject)
                        throws JSONException

Throws:

JSONException