Package com.stimulsoft.report.styles

Class StiBaseStyle

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.styles.StiBaseStyle

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, Cloneable

Direct Known Subclasses:

StiChartStyle, StiCrossTabStyle, StiDialogStyle, StiEmptyStyle, StiGaugeStyle, StiGaugeStyleXF, StiIndicatorStyle, StiMapStyle, StiStyle, StiTableStyle

public abstract class StiBaseStyle
extends StiSerializedObject
implements Cloneable, IStiName, IStiJsonReportObject

Describes the class that contains a base style.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StiBaseStyle.StiStyleSaver

Field Summary

Fields

Modifier and Type	Field	Description
StiReport	report

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiBaseStyle()	Creates a new object of the type StiBaseStyle.
StiBaseStyle(String name)	Creates a new object of the type StiBaseStyle.
StiBaseStyle(String name, String description)	Creates a new object of the type StiBaseStyle.
StiBaseStyle(String name, String description, StiReport report)	Creates a new object of the type StiBaseStyle.

Method Summary

Modifier and Type	Method	Description
Object	clone()
boolean	equals(Object obj, boolean allowEqualName, boolean allowEqualDescription)
String	getCollectionName()
StiStyleConditionsCollection	getConditions()
final String	getDescription()	Gets or sets the style description.
final String	getName()	Gets or sets a style name.
static StiBaseStyle	getStyle(StiComponent component)
static StiBaseStyle	getStyle(StiComponent component, StiStyleElements styleElements)
static StiBaseStyle	getStyle(StiComponent component, StiStyleElements styleElements, StiBaseStyle componentStyle)
static StiBaseStyle	getStyle(StiComponent component, StiBaseStyle componentStyle)
abstract void	GetStyleFromComponent(StiComponent component, StiStyleElements styleElements)	Gets a style from the component.
final void	GetStyleFromComponents(StiComponentsCollection comps, StiStyleElements styleElements)	Gets a style from the components.
void	LoadFromJsonObject(JSONObject jObject)
static StiBaseStyle	loadStyleFromString(String styleStr)	Loads the style from the string.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
String	saveToString()
void	setCollectionName(String collectionName)
void	setConditions(StiStyleConditionsCollection conditions)
final void	setDescription(String value)
final void	setName(String value)
abstract void	SetStyleToComponent(StiComponent component)	Sets style to a component.
String	toString()	Returns style name.

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, wait, wait, wait

Field Details

report

public StiReport report

Constructor Details

StiBaseStyle

public StiBaseStyle(String name,
 String description,
 StiReport report)

Creates a new object of the type StiBaseStyle.

Parameters:

name - Style name.

description - Style description.

StiBaseStyle

public StiBaseStyle(String name,
 String description)

Creates a new object of the type StiBaseStyle.

Parameters:

name - Style name.

description - Style description.

StiBaseStyle

public StiBaseStyle(String name)

Creates a new object of the type StiBaseStyle.

Parameters:

name - Style name.

StiBaseStyle

public StiBaseStyle()

Creates a new object of the type StiBaseStyle.

Method Details

equals

public boolean equals(Object obj,
 boolean allowEqualName,
 boolean allowEqualDescription)

getStyle

public static StiBaseStyle getStyle(StiComponent component,
 StiStyleElements styleElements)

getStyle

public static StiBaseStyle getStyle(StiComponent component,
 StiStyleElements styleElements,
 StiBaseStyle componentStyle)

getStyle

public static StiBaseStyle getStyle(StiComponent component)

getStyle

public static StiBaseStyle getStyle(StiComponent component,
 StiBaseStyle componentStyle)

GetStyleFromComponents

public final void GetStyleFromComponents(StiComponentsCollection comps,
 StiStyleElements styleElements)

Gets a style from the components.

Parameters:

component - Components collection.

toString

public String toString()

Returns style name.

Overrides:

toString in class Object

Returns:

GetStyleFromComponent

public abstract void GetStyleFromComponent(StiComponent component,
 StiStyleElements styleElements)

Gets a style from the component.

Parameters:

component - Component.

SetStyleToComponent

public abstract void SetStyleToComponent(StiComponent component)

Sets style to a component.

Parameters:

component - Component.

getDescription

public final String getDescription()

Gets or sets the style description.

setDescription

public final void setDescription(String value)

getName

public final String getName()

Gets or sets a style name.

Specified by:

getName in interface IStiName

setName

public final void setName(String value)

Specified by:

setName in interface IStiName

setConditions

public void setConditions(StiStyleConditionsCollection conditions)

getConditions

public StiStyleConditionsCollection getConditions()

setCollectionName

public void setCollectionName(String collectionName)

getCollectionName

public String getCollectionName()

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

clone

public Object clone()

Overrides:

clone in class Object

loadStyleFromString

public static StiBaseStyle loadStyleFromString(String styleStr)

Loads the style from the string.

Parameters:

styleStr -

Returns:

saveToString

public String saveToString()

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException