Package com.stimulsoft.report.components.conditions

Class StiDataBarCondition

java.lang.Object

com.stimulsoft.report.components.conditions.StiFilter

com.stimulsoft.report.components.conditions.StiBaseCondition

com.stimulsoft.report.components.conditions.StiDataBarCondition

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableToString, IStiDataBarIndicator, IStiIndicatorCondition, Cloneable

public class StiDataBarCondition
extends StiBaseCondition
implements IStiDataBarIndicator, IStiIndicatorCondition

The class describes the condition with Data Bar indicator.

Field Summary

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

column

Constructor Summary

Constructors

Constructor	Description
StiDataBarCondition()
StiDataBarCondition(String column, StiBrushType brushType, StiColor positiveColor, StiColor negativeColor, boolean showBorder, StiColor positiveBorderColor, StiColor negativeBorderColor, StiDataBarDirection direction, StiMinimumType minimumType, float minimumValue, StiMaximumType maximumType, float maximumValue, int padding, int cornerRadius, StiDataBarTextPlacement textPlacement, StiDataBarShape shape)	Creates a new object of the type StiDataBarCondition.

Method Summary

Modifier and Type	Method	Description
final StiIndicator	CreateIndicator(StiText component)	Creates new indicator for specified condition.
void	deserialize(String strObject)
boolean	equals(Object obj)
final StiBrushType	getBrushType()	Gets or sets value which indicates which type of brush will be used for Data Bar indicator drawing.
int	getCornerRadius()
final StiDataBarDirection	getDirection()	Gets or sets value which direction data bar will be filled by brush, from left to right or from right to left.
final StiMaximumType	getMaximumType()	Gets or sets processing type of maximal values for data bar indicator.
final float	getMaximumValue()	Gets or sets minimal value for data bar indicator.
final StiMinimumType	getMinimumType()	Gets or sets processing type of minimal values for data bar indicator.
final float	getMinimumValue()	Gets or sets minimal value for data bar indicator.
final StiColor	getNegativeBorderColor()	Gets or sets a border color of negative values for Data Bar indicator.
final StiColor	getNegativeColor()	Gets or sets a color of negative values for data bar indicator.
int	getPadding()
final StiColor	getPositiveBorderColor()	Gets or sets a border color of positive values for Data Bar indicator.
final StiColor	getPositiveColor()	Gets or sets a color of positive values for data bar indicator.
final StiDataBarShape	getShape()	The shape used to draw the data bar indicator.
final boolean	getShowBorder()	Gets or sets value which indicates that border is drawing.
StiDataBarTextPlacement	getTextPlacement()
int	hashCode()
void	LoadFromJsonObject(JSONObject jObject)
final void	Reset()	Reset condition to base state.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
String	serialize()
final void	setBrushType(StiBrushType value)
void	setCornerRadius(int cornerRadius)
final void	setDirection(StiDataBarDirection value)
final void	setMaximumType(StiMaximumType value)
final void	setMaximumValue(float value)
final void	setMinimumType(StiMinimumType value)
final void	setMinimumValue(float value)
final void	setNegativeBorderColor(StiColor value)
final void	setNegativeColor(StiColor value)
void	setPadding(int padding)
final void	setPositiveBorderColor(StiColor value)
final void	setPositiveColor(StiColor value)
final void	setShape(StiDataBarShape value)
final void	setShowBorder(boolean value)
void	setTextPlacement(StiDataBarTextPlacement textPlacement)

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

StiDataBarCondition

public StiDataBarCondition()

StiDataBarCondition

public StiDataBarCondition(String column,
 StiBrushType brushType,
 StiColor positiveColor,
 StiColor negativeColor,
 boolean showBorder,
 StiColor positiveBorderColor,
 StiColor negativeBorderColor,
 StiDataBarDirection direction,
 StiMinimumType minimumType,
 float minimumValue,
 StiMaximumType maximumType,
 float maximumValue,
 int padding,
 int cornerRadius,
 StiDataBarTextPlacement textPlacement,
 StiDataBarShape shape)

Creates a new object of the type StiDataBarCondition.

Method Details

CreateIndicator

public final StiIndicator CreateIndicator(StiText component)

Creates new indicator for specified condition.

Specified by:

CreateIndicator in interface IStiIndicatorCondition

Reset

public final void Reset()

Reset condition to base state.

Specified by:

Reset in interface IStiIndicatorCondition

getBrushType

public final StiBrushType getBrushType()

Gets or sets value which indicates which type of brush will be used for Data Bar indicator drawing.

Specified by:

getBrushType in interface IStiDataBarIndicator

setBrushType

public final void setBrushType(StiBrushType value)

Specified by:

setBrushType in interface IStiDataBarIndicator

getPositiveColor

public final StiColor getPositiveColor()

Gets or sets a color of positive values for data bar indicator.

Specified by:

getPositiveColor in interface IStiDataBarIndicator

setPositiveColor

public final void setPositiveColor(StiColor value)

Specified by:

setPositiveColor in interface IStiDataBarIndicator

getNegativeColor

public final StiColor getNegativeColor()

Gets or sets a color of negative values for data bar indicator.

Specified by:

getNegativeColor in interface IStiDataBarIndicator

setNegativeColor

public final void setNegativeColor(StiColor value)

Specified by:

setNegativeColor in interface IStiDataBarIndicator

getPositiveBorderColor

public final StiColor getPositiveBorderColor()

Gets or sets a border color of positive values for Data Bar indicator.

Specified by:

getPositiveBorderColor in interface IStiDataBarIndicator

setPositiveBorderColor

public final void setPositiveBorderColor(StiColor value)

Specified by:

setPositiveBorderColor in interface IStiDataBarIndicator

getNegativeBorderColor

public final StiColor getNegativeBorderColor()

Gets or sets a border color of negative values for Data Bar indicator.

Specified by:

getNegativeBorderColor in interface IStiDataBarIndicator

setNegativeBorderColor

public final void setNegativeBorderColor(StiColor value)

Specified by:

setNegativeBorderColor in interface IStiDataBarIndicator

getShowBorder

public final boolean getShowBorder()

Gets or sets value which indicates that border is drawing.

Specified by:

getShowBorder in interface IStiDataBarIndicator

setShowBorder

public final void setShowBorder(boolean value)

Specified by:

setShowBorder in interface IStiDataBarIndicator

getDirection

public final StiDataBarDirection getDirection()

Gets or sets value which direction data bar will be filled by brush, from left to right or from right to left.

Specified by:

getDirection in interface IStiDataBarIndicator

setDirection

public final void setDirection(StiDataBarDirection value)

Specified by:

setDirection in interface IStiDataBarIndicator

getMinimumType

public final StiMinimumType getMinimumType()

Gets or sets processing type of minimal values for data bar indicator.

setMinimumType

public final void setMinimumType(StiMinimumType value)

getMinimumValue

public final float getMinimumValue()

Gets or sets minimal value for data bar indicator.

setMinimumValue

public final void setMinimumValue(float value)

getMaximumType

public final StiMaximumType getMaximumType()

Gets or sets processing type of maximal values for data bar indicator.

setMaximumType

public final void setMaximumType(StiMaximumType value)

getMaximumValue

public final float getMaximumValue()

Gets or sets minimal value for data bar indicator.

setMaximumValue

public final void setMaximumValue(float value)

getShape

public final StiDataBarShape getShape()

The shape used to draw the data bar indicator. Arrow and Banner shapes are mirrored horizontally depending on the value sign (pointing right for positive, left for negative).

Specified by:

getShape in interface IStiDataBarIndicator

setShape

public final void setShape(StiDataBarShape value)

Specified by:

setShape in interface IStiDataBarIndicator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPadding

public int getPadding()

Specified by:

getPadding in interface IStiDataBarIndicator

setPadding

public void setPadding(int padding)

Specified by:

setPadding in interface IStiDataBarIndicator

getCornerRadius

public int getCornerRadius()

Specified by:

getCornerRadius in interface IStiDataBarIndicator

setCornerRadius

public void setCornerRadius(int cornerRadius)

Specified by:

setCornerRadius in interface IStiDataBarIndicator

getTextPlacement

public StiDataBarTextPlacement getTextPlacement()

Specified by:

getTextPlacement in interface IStiDataBarIndicator

setTextPlacement

public void setTextPlacement(StiDataBarTextPlacement textPlacement)

Specified by:

setTextPlacement in interface IStiDataBarIndicator

serialize

public String serialize()

Specified by:

serialize in interface IStiSerializableToString

Overrides:

serialize in class StiFilter

deserialize

public void deserialize(String strObject)

Specified by:

deserialize in interface IStiSerializableToString

Overrides:

deserialize in class StiFilter

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