com.stimulsoft.report.infographics.gauge.primitives.tick
Class StiTickBase

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.tick.StiTickBase

All Implemented Interfaces:

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

Direct Known Subclasses:

StiTickLabelBase, StiTickMarkBase

public abstract class StiTickBase
extends StiGaugeElement

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

StiTickBase()

Method Summary

protected boolean	checkTickValue(double[] skipValues, double[] skipIndices, double key, int value)
java.lang.Object	clone() Creates a new object that is a copy of the current instance.
protected java.util.TreeMap<java.lang.Double,java.lang.Double>	getMajorCollections()
java.lang.Double	getMaximumValue() the maximum value to which displaying should be.
java.lang.Double	getMinimumValue() the minimum value, with which displaying should begin.
protected java.util.TreeMap<java.lang.Double,java.lang.Double>	getMinorCollections()
double	getOffset() the offset from the scale based on the StiPlacement.
protected double	getOffset(java.lang.Double value)
StiPlacement	getPlacement() the placement of the tick relative to the scale.
protected StiPlacement	getPlacement(StiPlacement value)
protected java.util.TreeMap<java.lang.Double,java.lang.Double>	getPointCollection()
StiSkipIndicesExpression	getSkipIndices() the indexes of values that cannot be displayed.
double[]	getSkipIndicesObj()
StiSkipValuesExpression	getSkipValues() the values that should not be rendered.
double[]	getSkipValuesObj()
protected boolean	isSkipMajorValues()
void	LoadFromJsonObject(JSONObject jObject)
void	prepareGaugeElement()
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setMaximumValue(java.lang.Double maximumValue) the maximum value to which displaying should be.
void	setMinimumValue(java.lang.Double minimumValue) the minimum value, with which displaying should begin.
void	setOffset(double offset) the offset from the scale based on the StiPlacement.
void	setPlacement(StiPlacement placement) the placement of the tick relative to the scale.
void	setSkipIndices(StiSkipIndicesExpression skipIndices) the indexes of values that cannot be displayed.
void	setSkipIndicesObj(double[] skipIndicesObj)
void	setSkipValues(StiSkipValuesExpression skipValues) the values that should not be rendered.
void	setSkipValuesObj(double[] skipValuesObj)

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

StiTickBase

public StiTickBase()

Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiGaugeElement

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiGaugeElement

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 StiElementBase

getSkipValues

public StiSkipValuesExpression getSkipValues()

the values that should not be rendered. Example: 1;2;3

Returns:

the skipValues

setSkipValues

public void setSkipValues(StiSkipValuesExpression skipValues)

the values that should not be rendered. Example: 1;2;3

Parameters:

skipValues - the skipValues to set

getSkipIndices

public StiSkipIndicesExpression getSkipIndices()

the indexes of values that cannot be displayed. Example: 1;2;3

Returns:

the skipIndices

setSkipIndices

public void setSkipIndices(StiSkipIndicesExpression skipIndices)

the indexes of values that cannot be displayed. Example: 1;2;3

Parameters:

skipIndices - the skipIndices to set

getPlacement

public StiPlacement getPlacement()

the placement of the tick relative to the scale.

Returns:

the placement

setPlacement

public void setPlacement(StiPlacement placement)

the placement of the tick relative to the scale.

Parameters:

placement - the placement to set

getSkipValuesObj

public double[] getSkipValuesObj()

Returns:

the skipValuesObj

setSkipValuesObj

public void setSkipValuesObj(double[] skipValuesObj)

Parameters:

skipValuesObj - the skipValuesObj to set

getSkipIndicesObj

public double[] getSkipIndicesObj()

Returns:

the skipIndicesObj

setSkipIndicesObj

public void setSkipIndicesObj(double[] skipIndicesObj)

Parameters:

skipIndicesObj - the skipIndicesObj to set

getOffset

public double getOffset()

the offset from the scale based on the StiPlacement.

Returns:

the offset

setOffset

public void setOffset(double offset)

the offset from the scale based on the StiPlacement.

Parameters:

offset - the offset to set

getMinimumValue

public java.lang.Double getMinimumValue()

the minimum value, with which displaying should begin.

Returns:

the minimumValue

setMinimumValue

public void setMinimumValue(java.lang.Double minimumValue)

the minimum value, with which displaying should begin.

Parameters:

minimumValue - the minimumValue to set

getMaximumValue

public java.lang.Double getMaximumValue()

the maximum value to which displaying should be.

Returns:

the maximumValue

setMaximumValue

public void setMaximumValue(java.lang.Double maximumValue)

the maximum value to which displaying should be.

Parameters:

maximumValue - the maximumValue to set

isSkipMajorValues

protected boolean isSkipMajorValues()

getPointCollection

protected java.util.TreeMap<java.lang.Double,java.lang.Double> getPointCollection()

getMinorCollections

protected java.util.TreeMap<java.lang.Double,java.lang.Double> getMinorCollections()

getMajorCollections

protected java.util.TreeMap<java.lang.Double,java.lang.Double> getMajorCollections()

checkTickValue

protected boolean checkTickValue(double[] skipValues,
                                 double[] skipIndices,
                                 double key,
                                 int value)

prepareGaugeElement

public void prepareGaugeElement()

Overrides:

prepareGaugeElement in class StiGaugeElement

getOffset

protected double getOffset(java.lang.Double value)

getPlacement

protected StiPlacement getPlacement(StiPlacement value)