Package com.stimulsoft.report.components.indicators

Class StiDataBarIndicator

java.lang.Object

com.stimulsoft.report.components.indicators.StiIndicator

com.stimulsoft.report.components.indicators.StiDataBarIndicator

All Implemented Interfaces:

IStiCanCreateSerializableInstance, IStiSerializable, IStiSerializableToString, IStiDataBarIndicator

public class StiDataBarIndicator
extends StiIndicator
implements IStiDataBarIndicator

Field Summary

Fields

Modifier and Type	Field	Description
StiDataBarShape	shape

Constructor Summary

Constructors

Constructor	Description
StiDataBarIndicator()	Creates a new object of the type StiDataBarIndicator.
StiDataBarIndicator(StiBrushType brushType, StiColor positiveColor, StiColor negativeColor, boolean showBorder, StiColor positiveBorderColor, StiColor negativeBorderColor, StiDataBarDirection direction, float value, float minimum, float maximum)	Creates a new object of the type StiDataBarIndicator.

Method Summary

Modifier and Type	Method	Description
void	deserialize(String strObject)
StiDataBarIndicator	deserializeString(String stringValue)
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 float	getMaximum()	Gets or sets minimum amount.
final float	getMinimum()	Gets or sets minimum amount.
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()	Gets or sets the shape used to draw the data bar indicator.
final boolean	getShowBorder()	Gets or sets value which indicates that border is drawing.
StiDataBarTextPlacement	getTextPlacement()
final float	getValue()	Gets or sets value from maximum or minimum amount.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
String	serialize()
final void	setBrushType(StiBrushType value)
void	setCornerRadius(int cornerRadius)
final void	setDirection(StiDataBarDirection value)
final void	setMaximum(float value)
final void	setMinimum(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)
final void	setValue(float value)

Methods inherited from class com.stimulsoft.report.components.indicators.StiIndicator

deserializeFromString, getInstance, LoadFromJsonObjectInternal

Methods inherited from class java.lang.Object

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

Field Details

shape

public StiDataBarShape shape

Constructor Details

StiDataBarIndicator

public StiDataBarIndicator()

Creates a new object of the type StiDataBarIndicator.

StiDataBarIndicator

public StiDataBarIndicator(StiBrushType brushType,
 StiColor positiveColor,
 StiColor negativeColor,
 boolean showBorder,
 StiColor positiveBorderColor,
 StiColor negativeBorderColor,
 StiDataBarDirection direction,
 float value,
 float minimum,
 float maximum)

Creates a new object of the type StiDataBarIndicator.

Method Details

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

getValue

public final float getValue()

Gets or sets value from maximum or minimum amount.

setValue

public final void setValue(float value)

getMinimum

public final float getMinimum()

Gets or sets minimum amount.

setMinimum

public final void setMinimum(float value)

getMaximum

public final float getMaximum()

Gets or sets minimum amount.

setMaximum

public final void setMaximum(float value)

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

getShape

public final StiDataBarShape getShape()

Gets or sets 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

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

deserialize

public void deserialize(String strObject)

Specified by:

deserialize in interface IStiSerializableToString

Overrides:

deserialize in class StiIndicator

serialize

public String serialize()

Specified by:

serialize in interface IStiSerializableToString

Overrides:

serialize in class StiIndicator

deserializeString

public StiDataBarIndicator deserializeString(String stringValue)

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Overrides:

SaveToJsonObject in class StiIndicator

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Overrides:

LoadFromJsonObject in class StiIndicator

Throws:

JSONException