Package com.stimulsoft.report.components.conditions

Class StiColorScaleCondition

java.lang.Object

com.stimulsoft.report.components.conditions.StiFilter

com.stimulsoft.report.components.conditions.StiBaseCondition

com.stimulsoft.report.components.conditions.StiColorScaleCondition

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableToString, IStiIndicatorCondition, Cloneable

public class StiColorScaleCondition
extends StiBaseCondition
implements IStiIndicatorCondition

The class describes the condition with Color Scale indicator.

Field Summary

Fields inherited from class com.stimulsoft.report.components.conditions.StiFilter

column

Constructor Summary

Constructors

Constructor	Description
StiColorScaleCondition()
StiColorScaleCondition(String column, StiColorScaleType scaleType, StiColor minimumColor, StiColor midColor, StiColor maximumColor, StiMinimumType minimumType, float minimumValue, StiMidType midType, float midValue, StiMaximumType maximumType, float maximumValue)	Creates a new object of the type StiColorScaleCondition.

Method Summary

Modifier and Type	Method	Description
StiIndicator	CreateIndicator(StiText component)
void	deserialize(String value)
boolean	equals(Object obj)
final StiColor	getMaximumColor()	Gets or sets a color for maximal values.
final StiMaximumType	getMaximumType()	Gets or sets processing type of maximal values for color scale indicator.
final float	getMaximumValue()	Gets or sets minimal value for color scale indicator.
final StiColor	getMidColor()	Gets or sets a color for mid values.
final StiMidType	getMidType()	Gets or sets processing type of mid values for color scale indicator.
final float	getMidValue()	Gets or sets mid value for color scale indicator.
final StiColor	getMinimumColor()	Gets or sets a color for minimum values.
final StiMinimumType	getMinimumType()	Gets or sets processing type of minimal values for color scale indicator.
final float	getMinimumValue()	Gets or sets minimal value for color scale indicator.
final StiColorScaleType	getScaleType()	Gets or sets type of Color Scale indicator.
int	hashCode()
void	LoadFromJsonObject(JSONObject jObject)
final void	Reset()	Reset condition to base state.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
String	serialize()
final void	setMaximumColor(StiColor value)
final void	setMaximumType(StiMaximumType value)
final void	setMaximumValue(float value)
final void	setMidColor(StiColor value)
final void	setMidType(StiMidType value)
final void	setMidValue(float value)
final void	setMinimumColor(StiColor value)
final void	setMinimumType(StiMinimumType value)
final void	setMinimumValue(float value)
final void	setScaleType(StiColorScaleType value)

Methods inherited from class com.stimulsoft.report.components.conditions.StiBaseCondition

getTag, setTag

Methods inherited from class com.stimulsoft.report.components.conditions.StiFilter

getColumn, getCondition, getDataType, getExpression, getItem, getValue1, getValue2, setColumn, setCondition, setDataType, setExpression, setItem, setValue1, setValue2

Methods inherited from class java.lang.Object

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

Constructor Details

StiColorScaleCondition

public StiColorScaleCondition()

StiColorScaleCondition

public StiColorScaleCondition(String column,
 StiColorScaleType scaleType,
 StiColor minimumColor,
 StiColor midColor,
 StiColor maximumColor,
 StiMinimumType minimumType,
 float minimumValue,
 StiMidType midType,
 float midValue,
 StiMaximumType maximumType,
 float maximumValue)

Creates a new object of the type StiColorScaleCondition.

Method Details

Reset

public final void Reset()

Reset condition to base state.

Specified by:

Reset in interface IStiIndicatorCondition

getScaleType

public final StiColorScaleType getScaleType()

Gets or sets type of Color Scale indicator.

setScaleType

public final void setScaleType(StiColorScaleType value)

getMinimumColor

public final StiColor getMinimumColor()

Gets or sets a color for minimum values.

setMinimumColor

public final void setMinimumColor(StiColor value)

getMidColor

public final StiColor getMidColor()

Gets or sets a color for mid values.

setMidColor

public final void setMidColor(StiColor value)

getMaximumColor

public final StiColor getMaximumColor()

Gets or sets a color for maximal values.

setMaximumColor

public final void setMaximumColor(StiColor value)

getMinimumType

public final StiMinimumType getMinimumType()

Gets or sets processing type of minimal values for color scale indicator.

setMinimumType

public final void setMinimumType(StiMinimumType value)

getMinimumValue

public final float getMinimumValue()

Gets or sets minimal value for color scale indicator.

setMinimumValue

public final void setMinimumValue(float value)

getMidType

public final StiMidType getMidType()

Gets or sets processing type of mid values for color scale indicator.

setMidType

public final void setMidType(StiMidType value)

getMidValue

public final float getMidValue()

Gets or sets mid value for color scale indicator.

setMidValue

public final void setMidValue(float value)

getMaximumType

public final StiMaximumType getMaximumType()

Gets or sets processing type of maximal values for color scale indicator.

setMaximumType

public final void setMaximumType(StiMaximumType value)

getMaximumValue

public final float getMaximumValue()

Gets or sets minimal value for color scale indicator.

setMaximumValue

public final void setMaximumValue(float value)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

serialize

public String serialize()

Specified by:

serialize in interface IStiSerializableToString

Overrides:

serialize in class StiFilter

deserialize

public void deserialize(String value)

Specified by:

deserialize in interface IStiSerializableToString

Overrides:

deserialize in class StiFilter

CreateIndicator

public StiIndicator CreateIndicator(StiText component)

Specified by:

CreateIndicator in interface IStiIndicatorCondition

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiFilter

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiFilter

Throws:

JSONException