Package com.stimulsoft.report.chart.view.axis

Class StiAxisLabels

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.chart.view.axis.StiAxisLabels

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiAxisLabels, IStiFont, IStiTextFormat, Cloneable

public class StiAxisLabels
extends StiSerializedObject
implements IStiAxisLabels, Cloneable, IStiTextFormat, IStiFont

Field Summary

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiAxisLabels()
StiAxisLabels(String format, String textBefore, String textAfter, float angle, StiFont font, boolean antialiasing, StiLabelsPlacement placement, StiColor color, float width, StiMarkerAlignment textAlignment, double step, boolean allowApplyStyle)
StiAxisLabels(String format, String textBefore, String textAfter, float angle, StiFont font, boolean antialiasing, StiLabelsPlacement placement, StiColor color, float width, StiMarkerAlignment textAlignment, double step, boolean allowApplyStyle, boolean wordWrap)

Method Summary

Modifier and Type	Method	Description
final Object	clone()	Creates a new object that is a copy of the current instance.
final boolean	getAllowApplyStyle()	Gets or sets value which indicates that chart style will be used.
final float	getAngle()	Gets or sets angle of label rotation.
final boolean	getAntialiasing()	Gets or sets value which control antialiasing drawing mode.
final StiColor	getColor()	Gets or sets color of labels drawing.
final StiAxisLabelsCoreXF	getCore()
final StiFont	getFont()	Gets or sets font which will be used for axis label drawing.
final String	getFormat()	Gets os sets format string which is used for formating argument values.
StiFormatService	getFormatService()
final StiLabelsPlacement	getPlacement()	Gets or set mode of labels placement on axis.
double	getStep()	Gets or sets value which indicates with what steps do labels be shown on axis.
final String	getTextAfter()	Gets or sets string which will be output after argument string representation.
StiMarkerAlignment	getTextAlignment()	Gets or sets label text alignment.
final String	getTextBefore()	Gets or sets string which will be output before argument string representation.
StiFormatService	getTextFormat()	Gets or sets the format of the text.
final float	getWidth()	Gets or sets fixed width of axis labels.
final boolean	getWordWrap()
final boolean	isShowAsIndex()	A value indicating that axis labels show the ordinal position of the point (1..N) instead of the argument text.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setAllowApplyStyle(boolean value)
final void	setAngle(float value)
final void	setAntialiasing(boolean value)
final void	setColor(StiColor value)
final void	setCore(StiAxisLabelsCoreXF value)
final void	setFont(StiFont value)
final void	setFormat(String value)
void	setFormatService(StiFormatService formatService)
final void	setPlacement(StiLabelsPlacement value)
final void	setShowAsIndex(boolean value)	A value indicating that axis labels show the ordinal position of the point (1..N) instead of the argument text.
void	setStep(double value)
final void	setTextAfter(String value)
void	setTextAlignment(StiMarkerAlignment value)
final void	setTextBefore(String value)
void	setTextFormat(StiFormatService value)
final void	setWidth(float value)
final void	setWordWrap(boolean value)

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

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

getReference, setReference

Constructor Details

StiAxisLabels

public StiAxisLabels()

StiAxisLabels

public StiAxisLabels(String format,
 String textBefore,
 String textAfter,
 float angle,
 StiFont font,
 boolean antialiasing,
 StiLabelsPlacement placement,
 StiColor color,
 float width,
 StiMarkerAlignment textAlignment,
 double step,
 boolean allowApplyStyle)

StiAxisLabels

public StiAxisLabels(String format,
 String textBefore,
 String textAfter,
 float angle,
 StiFont font,
 boolean antialiasing,
 StiLabelsPlacement placement,
 StiColor color,
 float width,
 StiMarkerAlignment textAlignment,
 double step,
 boolean allowApplyStyle,
 boolean wordWrap)

Method Details

clone

public final Object clone()

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

Specified by:

clone in interface IStiAxisLabels

Overrides:

clone in class Object

Returns:

A new object that is a copy of this instance.

getCore

public final StiAxisLabelsCoreXF getCore()

Specified by:

getCore in interface IStiAxisLabels

setCore

public final void setCore(StiAxisLabelsCoreXF value)

Specified by:

setCore in interface IStiAxisLabels

getAllowApplyStyle

public final boolean getAllowApplyStyle()

Gets or sets value which indicates that chart style will be used.

Specified by:

getAllowApplyStyle in interface IStiAxisLabels

setAllowApplyStyle

public final void setAllowApplyStyle(boolean value)

Specified by:

setAllowApplyStyle in interface IStiAxisLabels

getFormat

public final String getFormat()

Gets os sets format string which is used for formating argument values.

Specified by:

getFormat in interface IStiAxisLabels

setFormat

public final void setFormat(String value)

Specified by:

setFormat in interface IStiAxisLabels

getAngle

public final float getAngle()

Gets or sets angle of label rotation.

Specified by:

getAngle in interface IStiAxisLabels

setAngle

public final void setAngle(float value)

Specified by:

setAngle in interface IStiAxisLabels

getWidth

public final float getWidth()

Gets or sets fixed width of axis labels.

Specified by:

getWidth in interface IStiAxisLabels

setWidth

public final void setWidth(float value)

Specified by:

setWidth in interface IStiAxisLabels

getTextBefore

public final String getTextBefore()

Gets or sets string which will be output before argument string representation.

Specified by:

getTextBefore in interface IStiAxisLabels

setTextBefore

public final void setTextBefore(String value)

Specified by:

setTextBefore in interface IStiAxisLabels

getTextAfter

public final String getTextAfter()

Gets or sets string which will be output after argument string representation.

Specified by:

getTextAfter in interface IStiAxisLabels

setTextAfter

public final void setTextAfter(String value)

Specified by:

setTextAfter in interface IStiAxisLabels

getFont

public final StiFont getFont()

Gets or sets font which will be used for axis label drawing.

Specified by:

getFont in interface IStiAxisLabels

Specified by:

getFont in interface IStiFont

setFont

public final void setFont(StiFont value)

Specified by:

setFont in interface IStiAxisLabels

Specified by:

setFont in interface IStiFont

getAntialiasing

public final boolean getAntialiasing()

Gets or sets value which control antialiasing drawing mode.

Specified by:

getAntialiasing in interface IStiAxisLabels

setAntialiasing

public final void setAntialiasing(boolean value)

Specified by:

setAntialiasing in interface IStiAxisLabels

getPlacement

public final StiLabelsPlacement getPlacement()

Gets or set mode of labels placement on axis.

Specified by:

getPlacement in interface IStiAxisLabels

setPlacement

public final void setPlacement(StiLabelsPlacement value)

Specified by:

setPlacement in interface IStiAxisLabels

getColor

public final StiColor getColor()

Gets or sets color of labels drawing.

Specified by:

getColor in interface IStiAxisLabels

setColor

public final void setColor(StiColor value)

Specified by:

setColor in interface IStiAxisLabels

getTextAlignment

public StiMarkerAlignment getTextAlignment()

Gets or sets label text alignment.

Specified by:

getTextAlignment in interface IStiAxisLabels

setTextAlignment

public void setTextAlignment(StiMarkerAlignment value)

Specified by:

setTextAlignment in interface IStiAxisLabels

getStep

public double getStep()

Gets or sets value which indicates with what steps do labels be shown on axis.

Specified by:

getStep in interface IStiAxisLabels

setStep

public void setStep(double value)

Specified by:

setStep in interface IStiAxisLabels

isShowAsIndex

public final boolean isShowAsIndex()

A value indicating that axis labels show the ordinal position of the point (1..N) instead of the argument text.

Specified by:

isShowAsIndex in interface IStiAxisLabels

Returns:

setShowAsIndex

public final void setShowAsIndex(boolean value)

A value indicating that axis labels show the ordinal position of the point (1..N) instead of the argument text.

Specified by:

setShowAsIndex in interface IStiAxisLabels

Parameters:

value -

getWordWrap

public final boolean getWordWrap()

Specified by:

getWordWrap in interface IStiAxisLabels

setWordWrap

public final void setWordWrap(boolean value)

Specified by:

setWordWrap in interface IStiAxisLabels

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException

getFormatService

public StiFormatService getFormatService()

Specified by:

getFormatService in interface IStiAxisLabels

setFormatService

public void setFormatService(StiFormatService formatService)

Specified by:

setFormatService in interface IStiAxisLabels

getTextFormat

public StiFormatService getTextFormat()

Description copied from interface: IStiTextFormat

Gets or sets the format of the text.

Specified by:

getTextFormat in interface IStiTextFormat

setTextFormat

public void setTextFormat(StiFormatService value)

Specified by:

setTextFormat in interface IStiTextFormat