com.stimulsoft.report.infographics.gauge.primitives.indicators

Class StiBarBase

java.lang.Object

com.stimulsoft.report.infographics.gauge.primitives.base.StiElementBase

com.stimulsoft.report.infographics.gauge.primitives.base.StiGaugeElement

com.stimulsoft.report.infographics.gauge.primitives.indicators.StiIndicatorBase

com.stimulsoft.report.infographics.gauge.primitives.indicators.StiBarBase

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiApplyStyleGauge, java.lang.Cloneable

Direct Known Subclasses:

StiLinearBar, StiRadialBar

public abstract class StiBarBase
extends StiIndicatorBase

Copyright Stimulsoft

Field Summary

Fields inherited from class com.stimulsoft.report.infographics.gauge.primitives.base.StiGaugeElement

animation, scale

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiBarBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	checkActualBrushForTopGeometry()
java.lang.Object	clone() Creates a new object that is a copy of the current instance.
protected abstract StiBarRangeListType	getBarType()
StiBrush	getEmptyBorderBrush() the border brush for the empty part of the bar indicator.
double	getEmptyBorderWidth() the border width for the empty part of the bar indicator.
StiBrush	getEmptyBrush() Gets or sets the brush for the empty part of the bar indicator.
double	getEndWidth() end width of the bar indicator.
double	getOffset() the offset ratio of an item.
StiBarRangeListCollection	getRangeList()
double	getStartWidth() start width of the bar indicator.
boolean	isUseRangeColor() value which indicates whether we should use Brush property of the StiIndicatorBase class as brush for this indicator.
void	LoadFromJsonObject(JSONObject jObject)
protected abstract void	onRangeColorChanged()
protected void	onValueChanged()
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setEmptyBorderBrush(StiBrush emptyBorderBrush) the border brush for the empty part of the bar indicator.
void	setEmptyBorderWidth(double emptyBorderWidth) the border width for the empty part of the bar indicator.
void	setEmptyBrush(StiBrush emptyBrush) Gets or sets the brush for the empty part of the bar indicator.
void	setEndWidth(double endWidth) end width of the bar indicator.
void	setOffset(double offset) the offset ratio of an item.
void	setRangeList(StiBarRangeListCollection rangeList)
void	setStartWidth(double startWidth) start width of the bar indicator.
void	setUseRangeColor(boolean useRangeColor) value which indicates whether we should use Brush property of the StiIndicatorBase class as brush for this indicator.

Methods inherited from class com.stimulsoft.report.infographics.gauge.primitives.indicators.StiIndicatorBase

getBorderBrush, getBorderWidth, getBrush, getGetValueEvent, getPlacement, getValue, getValueObj, interactiveClick, InvokeGetValue, OnGetValue, prepareGaugeElement, setBorderBrush, setBorderWidth, setBrush, setGetValueEvent, setPlacement, setValue, setValueObj

Methods inherited from class com.stimulsoft.report.infographics.gauge.primitives.base.StiGaugeElement

cleanReference, createNew, getAnimation, getElementType, getLocalizeName, getReference, getScale, setAnimation, setReference, setScale

Methods inherited from class com.stimulsoft.report.infographics.gauge.primitives.base.StiElementBase

applyStyle, drawElement, isAllowApplyStyle, setAllowApplyStyle

Methods inherited from class java.lang.Object

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

Constructor Detail

StiBarBase

public StiBarBase()

Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiIndicatorBase

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiIndicatorBase

Throws:

JSONException

clone

public java.lang.Object clone()

Description copied from class: StiElementBase

Creates a new object that is a copy of the current instance.

Overrides:

clone in class StiIndicatorBase

getEmptyBrush

public StiBrush getEmptyBrush()

Gets or sets the brush for the empty part of the bar indicator.

Returns:

the emptyBrush

setEmptyBrush

public void setEmptyBrush(StiBrush emptyBrush)

Gets or sets the brush for the empty part of the bar indicator.

Parameters:

emptyBrush - the emptyBrush to set

getEmptyBorderBrush

public StiBrush getEmptyBorderBrush()

the border brush for the empty part of the bar indicator.

Returns:

the emptyBorderBrush

setEmptyBorderBrush

public void setEmptyBorderBrush(StiBrush emptyBorderBrush)

the border brush for the empty part of the bar indicator.

Parameters:

emptyBorderBrush - the emptyBorderBrush to set

getEmptyBorderWidth

public double getEmptyBorderWidth()

the border width for the empty part of the bar indicator.

Returns:

the emptyBorderWidth

setEmptyBorderWidth

public void setEmptyBorderWidth(double emptyBorderWidth)

the border width for the empty part of the bar indicator.

Parameters:

emptyBorderWidth - the emptyBorderWidth to set

getOffset

public double getOffset()

the offset ratio of an item.

Returns:

the offset

setOffset

public void setOffset(double offset)

the offset ratio of an item.

Parameters:

offset - the offset to set

getStartWidth

public double getStartWidth()

start width of the bar indicator.

Returns:

the startWidth

setStartWidth

public void setStartWidth(double startWidth)

start width of the bar indicator.

Parameters:

startWidth - the startWidth to set

getEndWidth

public double getEndWidth()

end width of the bar indicator.

Returns:

the endWidth

setEndWidth

public void setEndWidth(double endWidth)

end width of the bar indicator.

Parameters:

endWidth - the endWidth to set

isUseRangeColor

public boolean isUseRangeColor()

value which indicates whether we should use Brush property of the StiIndicatorBase class as brush for this indicator.

Returns:

the useRangeColor

setUseRangeColor

public void setUseRangeColor(boolean useRangeColor)

value which indicates whether we should use Brush property of the StiIndicatorBase class as brush for this indicator.

Parameters:

useRangeColor - the useRangeColor to set

getRangeList

public StiBarRangeListCollection getRangeList()

Returns:

the rangeList

setRangeList

public void setRangeList(StiBarRangeListCollection rangeList)

Parameters:

rangeList - the rangeList to set

getBarType

protected abstract StiBarRangeListType getBarType()

onRangeColorChanged

protected abstract void onRangeColorChanged()

checkActualBrushForTopGeometry

protected abstract void checkActualBrushForTopGeometry()

onValueChanged

protected void onValueChanged()

Overrides:

onValueChanged in class StiIndicatorBase