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

Class StiMarkerBase

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.StiMarkerBase

All Implemented Interfaces:

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

Direct Known Subclasses:

StiLinearMarker, StiRadialMarker

public abstract class StiMarkerBase
extends StiIndicatorBase
implements IStiGaugeMarker

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
StiMarkerBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a new object that is a copy of the current instance.
protected StiGaugeElementSkin	getActualSkin()
StiGaugeElementSkin	getCustomSkin()
StiFont	getFont() font of component.
java.lang.String	getFormat() the format string for the ShowValue property.
double	getOffset() offset of the scale object from the scale bar.
double	getRelativeHeight() relative height of the indicator.
double	getRelativeWidth() relative width of the indicator.
StiMarkerSkin	getSkin() the skin of the component rendering.
StiBrush	getTextBrush() a brush to draw text.
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	setFont(StiFont font) font of component.
void	setFormat(java.lang.String format) the format string for the ShowValue property.
void	setOffset(double offset) offset of the scale object from the scale bar.
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(StiMarkerSkin skin) the skin of the component rendering.
void	setTextBrush(StiBrush textBrush) a brush to draw text.

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

getBorderBrush, getBorderWidth, getBrush, getGetValueEvent, getPlacement, getValue, getValueObj, interactiveClick, InvokeGetValue, OnGetValue, onValueChanged, 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

StiMarkerBase

public StiMarkerBase()

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

getOffset

public double getOffset()

offset of the scale object from the scale bar.

Returns:

the offset

setOffset

public void setOffset(double offset)

offset of the scale object from the scale bar.

Parameters:

offset - the offset 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 StiMarkerSkin getSkin()

the skin of the component rendering.

Returns:

the skin

setSkin

public void setSkin(StiMarkerSkin 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

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

getActualSkin

protected StiGaugeElementSkin getActualSkin()