com.stimulsoft.report.infographics.gauge.indicators
Class StiStateIndicator

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.indicators.StiStateIndicator

All Implemented Interfaces:

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

public class StiStateIndicator
extends StiIndicatorBase
implements IStiGaugeMarker

Copyright Stimulsoft

Field Summary

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

StiStateIndicator()

Method Summary

java.lang.Object	clone() Creates a new object that is a copy of the current instance.
StiGaugeElement	createNew()
void	drawElement(StiGaugeContextPainter context)
StiComponentId	getComponentId()
StiGaugeElementSkin	getCustomSkin()
StiGaugeElemenType	getElementType()
StiFilterCollection	getFilters()
StiFont	getFont() font of component.
java.lang.String	getFormat() the format string for the ShowValue property.
double	getLeft() X coordinate of the indicator relative to the scale dimension.
java.lang.String	getLocalizeName()
double	getRelativeHeight() relative height of the indicator.
double	getRelativeWidth() relative width of the indicator.
StiStateSkin	getSkin() the skin of the component rendering.
StiBrush	getTextBrush() a brush to draw text.
double	getTop() Y coordinate of the indicator relative to the scale dimension.
boolean	isShowValue() a value indicating whether to display a current value of the indicator.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCustomSkin(StiGaugeElementSkin customSkin)
void	setFilters(StiFilterCollection filters)
void	setFont(StiFont font) font of component.
void	setFormat(java.lang.String format) the format string for the ShowValue property.
void	setLeft(double left) X coordinate of the indicator relative to the scale dimension.
void	setRelativeHeight(double relativeHeight) relative height of the indicator.
void	setRelativeWidth(double relativeWidth) relative width of the indicator.
void	setShowValue(boolean showValue) a value indicating whether to display a current value of the indicator.
void	setSkin(StiStateSkin skin) the skin of the component rendering.
void	setTextBrush(StiBrush textBrush) a brush to draw text.
void	setTop(double top) Y coordinate of the indicator relative to the scale dimension.

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

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

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

cleanReference, getAnimation, getReference, getScale, setAnimation, setReference, setScale

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

applyStyle, isAllowApplyStyle, setAllowApplyStyle

Methods inherited from class java.lang.Object

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

Constructor Detail

StiStateIndicator

public StiStateIndicator()

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

getComponentId

public StiComponentId getComponentId()

getFormat

public java.lang.String getFormat()

the format string for the ShowValue property.

Specified by:

getFormat in interface IStiGaugeMarker

Returns:

the format

setFormat

public void setFormat(java.lang.String format)

the format string for the ShowValue property.

Specified by:

setFormat in interface IStiGaugeMarker

Parameters:

format - the format to set

isShowValue

public boolean isShowValue()

a value indicating whether to display a current value of the indicator.

Specified by:

isShowValue in interface IStiGaugeMarker

Returns:

the showValue

setShowValue

public void setShowValue(boolean showValue)

a value indicating whether to display a current value of the indicator.

Specified by:

setShowValue in interface IStiGaugeMarker

Parameters:

showValue - the showValue to set

getTextBrush

public StiBrush getTextBrush()

a brush to draw text.

Specified by:

getTextBrush in interface IStiGaugeMarker

Returns:

the textBrush

setTextBrush

public void setTextBrush(StiBrush textBrush)

a brush to draw text.

Specified by:

setTextBrush in interface IStiGaugeMarker

Parameters:

textBrush - the textBrush to set

getFont

public StiFont getFont()

font of component.

Specified by:

getFont in interface IStiGaugeMarker

Returns:

the font

setFont

public void setFont(StiFont font)

font of component.

Specified by:

setFont in interface IStiGaugeMarker

Parameters:

font - the font to set

getElementType

public StiGaugeElemenType getElementType()

Overrides:

getElementType in class StiGaugeElement

getLocalizeName

public java.lang.String getLocalizeName()

Overrides:

getLocalizeName in class StiGaugeElement

getFilters

public StiFilterCollection getFilters()

Returns:

the filters

setFilters

public void setFilters(StiFilterCollection filters)

Parameters:

filters - the filters to set

getLeft

public double getLeft()

X coordinate of the indicator relative to the scale dimension.

Returns:

the left

setLeft

public void setLeft(double left)

X coordinate of the indicator relative to the scale dimension.

Parameters:

left - the left to set

getTop

public double getTop()

Y coordinate of the indicator relative to the scale dimension.

Returns:

the top

setTop

public void setTop(double top)

Y coordinate of the indicator relative to the scale dimension.

Parameters:

top - the top to set

getRelativeWidth

public double getRelativeWidth()

relative width of the indicator. It is given as part of the scale dimension.

Returns:

the relativeWidth

setRelativeWidth

public void setRelativeWidth(double relativeWidth)

relative width of the indicator. It is given as part of the scale dimension.

Parameters:

relativeWidth - the relativeWidth to set

getRelativeHeight

public double getRelativeHeight()

relative height of the indicator. It is given as part of the scale dimension.

Returns:

the relativeHeight

setRelativeHeight

public void setRelativeHeight(double relativeHeight)

relative height of the indicator. It is given as part of the scale dimension.

Parameters:

relativeHeight - the relativeHeight to set

getSkin

public StiStateSkin getSkin()

the skin of the component rendering.

Returns:

the skin

setSkin

public void setSkin(StiStateSkin skin)

the skin of the component rendering.

Parameters:

skin - the skin to set

getCustomSkin

public StiGaugeElementSkin getCustomSkin()

Returns:

the customSkin

setCustomSkin

public void setCustomSkin(StiGaugeElementSkin customSkin)

Parameters:

customSkin - the customSkin to set

createNew

public StiGaugeElement createNew()

Overrides:

createNew in class StiGaugeElement

drawElement

public void drawElement(StiGaugeContextPainter context)

Overrides:

drawElement in class StiElementBase