Package com.stimulsoft.report.chart.view.legend

Class StiLegend

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.chart.view.legend.StiLegend

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiSerializeToCodeAsClass, IStiLegend, Cloneable

public class StiLegend
extends StiSerializedObject
implements IStiLegend, IStiSerializeToCodeAsClass, Cloneable

Field Summary

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiLegend()

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 StiColor	getBorderColor()	Gets or sets border color.
final StiBrush	getBrush()	Gets or sets background brush of legend.
final IStiChart	getChart()
final int	getColumns()	Gets or sets amount of columns.
int	getColumnWidth()
final StiLegendCoreXF	getCore()
StiLegendDirection	getDirection()	Gets or sets direction which used for series drawing in legend.
final StiFont	getFont()	Gets or sets font which used for series title drawing in chart legend.
final boolean	getHideSeriesWithEmptyTitle()	Gets or sets value which shows/hides series with empty title.
StiLegendHorAlignment	getHorAlignment()	Gets or sets horizontal alignment of legend placement.
final int	getHorSpacing()	Gets or sets horizontal spacing between items in legend.
final StiColor	getLabelsColor()	Gets or sets color of the labels.
StiMarkerAlignment	getMarkerAlignment()	Gets or sets alignment of markers related to series title.
boolean	getMarkerBorder()
final StiSize	getMarkerSize()	Gets or sets marker size.
final boolean	getMarkerVisible()	Gets or sets visibility of markers.
final boolean	getShowShadow()	Gets or sets value which indicates draw shadow or no.
final StiSize	getSize()	Gets or sets size of legend.
final String	getTitle()	Gets or sets title of the legend.
final StiColor	getTitleColor()	Gets or sets title color of legend.
final StiFont	getTitleFont()	Gets or sets title font of the chart legend.
StiLegendVertAlignment	getVertAlignment()	Gets or sets vertical alignment of legend placement.
final int	getVertSpacing()	Gets or sets vertical spacing between items in legend.
final boolean	getVisible()	Gets or sets visibility of chart legend.
boolean	isWordWrap()
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setAllowApplyStyle(boolean value)
final void	setBorderColor(StiColor value)
final void	setBrush(StiBrush value)
final void	setChart(IStiChart value)
final void	setColumns(int value)
void	setColumnWidth(int columnWidth)
final void	setCore(StiLegendCoreXF value)
void	setDirection(StiLegendDirection value)
final void	setFont(StiFont value)
final void	setHideSeriesWithEmptyTitle(boolean value)
void	setHorAlignment(StiLegendHorAlignment value)
final void	setHorSpacing(int value)
final void	setLabelsColor(StiColor value)
void	setMarkerAlignment(StiMarkerAlignment value)
void	setMarkerBorder(boolean value)
final void	setMarkerSize(StiSize value)
final void	setMarkerVisible(boolean value)
final void	setShowShadow(boolean value)
final void	setSize(StiSize value)
final void	setTitle(String value)
final void	setTitleColor(StiColor value)
final void	setTitleFont(StiFont value)
void	setVertAlignment(StiLegendVertAlignment value)
final void	setVertSpacing(int value)
final void	setVisible(boolean value)
void	setWordWrap(boolean wordWrap)

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

StiLegend

public StiLegend()

Method Details

clone

public final Object clone()

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

Specified by:

clone in interface IStiLegend

Overrides:

clone in class Object

Returns:

A new object that is a copy of this instance.

getCore

public final StiLegendCoreXF getCore()

Specified by:

getCore in interface IStiLegend

setCore

public final void setCore(StiLegendCoreXF value)

Specified by:

setCore in interface IStiLegend

getAllowApplyStyle

public final boolean getAllowApplyStyle()

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

Specified by:

getAllowApplyStyle in interface IStiLegend

setAllowApplyStyle

public final void setAllowApplyStyle(boolean value)

Specified by:

setAllowApplyStyle in interface IStiLegend

getChart

public final IStiChart getChart()

Specified by:

getChart in interface IStiLegend

setChart

public final void setChart(IStiChart value)

Specified by:

setChart in interface IStiLegend

getHideSeriesWithEmptyTitle

public final boolean getHideSeriesWithEmptyTitle()

Gets or sets value which shows/hides series with empty title.

Specified by:

getHideSeriesWithEmptyTitle in interface IStiLegend

setHideSeriesWithEmptyTitle

public final void setHideSeriesWithEmptyTitle(boolean value)

Specified by:

setHideSeriesWithEmptyTitle in interface IStiLegend

getShowShadow

public final boolean getShowShadow()

Gets or sets value which indicates draw shadow or no.

Specified by:

getShowShadow in interface IStiLegend

setShowShadow

public final void setShowShadow(boolean value)

Specified by:

setShowShadow in interface IStiLegend

getBorderColor

public final StiColor getBorderColor()

Gets or sets border color.

Specified by:

getBorderColor in interface IStiLegend

setBorderColor

public final void setBorderColor(StiColor value)

Specified by:

setBorderColor in interface IStiLegend

getBrush

public final StiBrush getBrush()

Gets or sets background brush of legend.

Specified by:

getBrush in interface IStiLegend

setBrush

public final void setBrush(StiBrush value)

Specified by:

setBrush in interface IStiLegend

getTitleColor

public final StiColor getTitleColor()

Gets or sets title color of legend.

Specified by:

getTitleColor in interface IStiLegend

setTitleColor

public final void setTitleColor(StiColor value)

Specified by:

setTitleColor in interface IStiLegend

getLabelsColor

public final StiColor getLabelsColor()

Gets or sets color of the labels.

Specified by:

getLabelsColor in interface IStiLegend

setLabelsColor

public final void setLabelsColor(StiColor value)

Specified by:

setLabelsColor in interface IStiLegend

getDirection

public StiLegendDirection getDirection()

Gets or sets direction which used for series drawing in legend.

Specified by:

getDirection in interface IStiLegend

setDirection

public void setDirection(StiLegendDirection value)

Specified by:

setDirection in interface IStiLegend

getHorAlignment

public StiLegendHorAlignment getHorAlignment()

Gets or sets horizontal alignment of legend placement.

Specified by:

getHorAlignment in interface IStiLegend

setHorAlignment

public void setHorAlignment(StiLegendHorAlignment value)

Specified by:

setHorAlignment in interface IStiLegend

getVertAlignment

public StiLegendVertAlignment getVertAlignment()

Gets or sets vertical alignment of legend placement.

Specified by:

getVertAlignment in interface IStiLegend

setVertAlignment

public void setVertAlignment(StiLegendVertAlignment value)

Specified by:

setVertAlignment in interface IStiLegend

getTitleFont

public final StiFont getTitleFont()

Gets or sets title font of the chart legend.

Specified by:

getTitleFont in interface IStiLegend

setTitleFont

public final void setTitleFont(StiFont value)

Specified by:

setTitleFont in interface IStiLegend

getFont

public final StiFont getFont()

Gets or sets font which used for series title drawing in chart legend.

Specified by:

getFont in interface IStiLegend

setFont

public final void setFont(StiFont value)

Specified by:

setFont in interface IStiLegend

getVisible

public final boolean getVisible()

Gets or sets visibility of chart legend.

Specified by:

getVisible in interface IStiLegend

setVisible

public final void setVisible(boolean value)

Specified by:

setVisible in interface IStiLegend

getMarkerVisible

public final boolean getMarkerVisible()

Gets or sets visibility of markers.

Specified by:

getMarkerVisible in interface IStiLegend

setMarkerVisible

public final void setMarkerVisible(boolean value)

Specified by:

setMarkerVisible in interface IStiLegend

getMarkerBorder

public boolean getMarkerBorder()

Specified by:

getMarkerBorder in interface IStiLegend

setMarkerBorder

public void setMarkerBorder(boolean value)

Specified by:

setMarkerBorder in interface IStiLegend

getMarkerSize

public final StiSize getMarkerSize()

Gets or sets marker size.

Specified by:

getMarkerSize in interface IStiLegend

setMarkerSize

public final void setMarkerSize(StiSize value)

Specified by:

setMarkerSize in interface IStiLegend

getMarkerAlignment

public StiMarkerAlignment getMarkerAlignment()

Gets or sets alignment of markers related to series title.

Specified by:

getMarkerAlignment in interface IStiLegend

setMarkerAlignment

public void setMarkerAlignment(StiMarkerAlignment value)

Specified by:

setMarkerAlignment in interface IStiLegend

getColumns

public final int getColumns()

Gets or sets amount of columns.

Specified by:

getColumns in interface IStiLegend

setColumns

public final void setColumns(int value)

Specified by:

setColumns in interface IStiLegend

getHorSpacing

public final int getHorSpacing()

Gets or sets horizontal spacing between items in legend.

Specified by:

getHorSpacing in interface IStiLegend

setHorSpacing

public final void setHorSpacing(int value)

Specified by:

setHorSpacing in interface IStiLegend

getVertSpacing

public final int getVertSpacing()

Gets or sets vertical spacing between items in legend.

Specified by:

getVertSpacing in interface IStiLegend

setVertSpacing

public final void setVertSpacing(int value)

Specified by:

setVertSpacing in interface IStiLegend

getSize

public final StiSize getSize()

Gets or sets size of legend.

Specified by:

getSize in interface IStiLegend

setSize

public final void setSize(StiSize value)

Specified by:

setSize in interface IStiLegend

getTitle

public final String getTitle()

Gets or sets title of the legend.

Specified by:

getTitle in interface IStiLegend

setTitle

public final void setTitle(String value)

Specified by:

setTitle in interface IStiLegend

getColumnWidth

public int getColumnWidth()

Specified by:

getColumnWidth in interface IStiLegend

setColumnWidth

public void setColumnWidth(int columnWidth)

Specified by:

setColumnWidth in interface IStiLegend

isWordWrap

public boolean isWordWrap()

Specified by:

isWordWrap in interface IStiLegend

setWordWrap

public void setWordWrap(boolean wordWrap)

Specified by:

setWordWrap in interface IStiLegend

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