com.stimulsoft.report.styles

Class StiStyle

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.styles.StiBaseStyle

com.stimulsoft.report.styles.StiStyle

All Implemented Interfaces:

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

public class StiStyle
extends StiBaseStyle

Describes the class that contains a style for components.

Nested Class Summary

Nested classes/interfaces inherited from class com.stimulsoft.report.styles.StiBaseStyle

StiBaseStyle.StiStyleSaver

Field Summary

Fields inherited from class com.stimulsoft.report.styles.StiBaseStyle

report

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiStyle() Creates a new object of the type StiStyle.
StiStyle(java.lang.String name) Creates a new object of the type StiStyle.
StiStyle(java.lang.String name, java.lang.String description) Creates a new object of the type StiStyle.
StiStyle(java.lang.String name, java.lang.String description, StiReport report) Creates a new object of the type StiStyle.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	getAllowUseBorderFormatting() Gets or sets a value which indicates whether a report engine can use Border formatting or not.
boolean	getAllowUseBorderSides() Gets or sets a value which indicates whether a report engine can use Border Sides or not.
boolean	getAllowUseborderSidesFromLocation()
boolean	getAllowUseBrush() Gets or sets a value which indicates whether a report engine can use Brush formatting or not.
boolean	getAllowUseFont() Gets or sets a value which indicates whether a report engine can use Font formatting or not.
boolean	getAllowUseHorAlignment() Gets or sets a value which indicates whether a report engine can use HorAlignment formatting or not.
boolean	getAllowUseImage() Gets or sets a value which indicates whether a report engine can use Image formatting or not.
boolean	getAllowUseTextBrush() Gets or sets a value which indicates whether a report engine can use TextBrush formatting or not.
boolean	getAllowUseTextOptions() Gets or sets a value which indicates whether a report engine can use TextOptions formatting or not.
boolean	getAllowUseVertAlignment() Gets or sets a value which indicates whether a report engine can use VertAlignment formatting or not.
StiBorder	getBorder() Gets or sets frame of the component.
StiBrush	getBrush() Gets or sets a brush to fill a style.
StiFont	getFont() Gets or sets font of style.
StiTextHorAlignment	getHorAlignment() Gets or sets the style horizontal alignment.
StiImage	getImage() Gets or sets the image to fill Image property of Image component.
StiStyleCode	getStyleCode() Gets or sets a value which indicates on which band in a report this style can be apply when applying style automatically.
void	GetStyleFromComponent(StiComponent component, StiStyleElements styleElements) Gets a style from the component.
void	GetStyleFromComponent(StiComponent component, StiStyleElements styleElements, StiBaseStyle componentStyle) Gets a style from the component.
StiBrush	getTextBrush() Gets or sets a brush to draw text.
StiTextOptions	getTextOptions() Do not use this property.
StiVertAlignment	getVertAlignment() Gets or sets the vertical alignment of an style.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAllowUseBorderFormatting(boolean value)
void	setAllowUseBorderSides(boolean value)
void	setAllowUseborderSidesFromLocation(boolean allowUseborderSidesFromLocation)
void	setAllowUseBrush(boolean value)
void	setAllowUseFont(boolean value)
void	setAllowUseHorAlignment(boolean value)
void	setAllowUseImage(boolean value)
void	setAllowUseTextBrush(boolean value)
void	setAllowUseTextOptions(boolean value)
void	setAllowUseVertAlignment(boolean value)
void	setBorder(StiBorder value)
void	setBrush(StiBrush value)
void	setFont(StiFont value)
void	setHorAlignment(StiTextHorAlignment value)
void	setImage(StiImage value)
void	setStyleCode(StiStyleCode value)
void	SetStyleToComponent(StiComponent component) Sets style to a component.
void	setTextBrush(StiBrush value)
void	setTextOptions(StiTextOptions value)
void	setVertAlignment(StiVertAlignment value)

Methods inherited from class com.stimulsoft.report.styles.StiBaseStyle

equals, getCollectionName, getConditions, getDescription, getName, getStyle, getStyle, getStyle, getStyle, GetStyleFromComponents, loadStyleFromString, saveToString, setCollectionName, setConditions, setDescription, setName, toString

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

Constructor Detail

StiStyle

public StiStyle(java.lang.String name,
        java.lang.String description,
        StiReport report)

Creates a new object of the type StiStyle.

Parameters:

name - Style name.

description - Style description.

StiStyle

public StiStyle(java.lang.String name,
        java.lang.String description)

Creates a new object of the type StiStyle.

Parameters:

name - Style name.

description - Style description.

StiStyle

public StiStyle(java.lang.String name)

Creates a new object of the type StiStyle.

Parameters:

name - Style name.

StiStyle

public StiStyle()

Creates a new object of the type StiStyle.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class StiBaseStyle

getHorAlignment

public StiTextHorAlignment getHorAlignment()

Gets or sets the style horizontal alignment.

setHorAlignment

public void setHorAlignment(StiTextHorAlignment value)

getVertAlignment

public StiVertAlignment getVertAlignment()

Gets or sets the vertical alignment of an style.

setVertAlignment

public void setVertAlignment(StiVertAlignment value)

getFont

public final StiFont getFont()

Gets or sets font of style.

setFont

public final void setFont(StiFont value)

getBorder

public final StiBorder getBorder()

Gets or sets frame of the component.

setBorder

public final void setBorder(StiBorder value)

getBrush

public final StiBrush getBrush()

Gets or sets a brush to fill a style.

setBrush

public final void setBrush(StiBrush value)

getTextBrush

public final StiBrush getTextBrush()

Gets or sets a brush to draw text.

setTextBrush

public final void setTextBrush(StiBrush value)

getTextOptions

public final StiTextOptions getTextOptions()

Do not use this property.

setTextOptions

public final void setTextOptions(StiTextOptions value)

getAllowUseHorAlignment

public final boolean getAllowUseHorAlignment()

Gets or sets a value which indicates whether a report engine can use HorAlignment formatting or not.

setAllowUseHorAlignment

public final void setAllowUseHorAlignment(boolean value)

getAllowUseVertAlignment

public final boolean getAllowUseVertAlignment()

Gets or sets a value which indicates whether a report engine can use VertAlignment formatting or not.

setAllowUseVertAlignment

public final void setAllowUseVertAlignment(boolean value)

getAllowUseImage

public final boolean getAllowUseImage()

Gets or sets a value which indicates whether a report engine can use Image formatting or not.

setAllowUseImage

public final void setAllowUseImage(boolean value)

getAllowUseFont

public final boolean getAllowUseFont()

Gets or sets a value which indicates whether a report engine can use Font formatting or not.

setAllowUseFont

public final void setAllowUseFont(boolean value)

getAllowUseBorderFormatting

public final boolean getAllowUseBorderFormatting()

Gets or sets a value which indicates whether a report engine can use Border formatting or not.

setAllowUseBorderFormatting

public final void setAllowUseBorderFormatting(boolean value)

setAllowUseborderSidesFromLocation

public void setAllowUseborderSidesFromLocation(boolean allowUseborderSidesFromLocation)

getAllowUseborderSidesFromLocation

public boolean getAllowUseborderSidesFromLocation()

getAllowUseBorderSides

public final boolean getAllowUseBorderSides()

Gets or sets a value which indicates whether a report engine can use Border Sides or not.

setAllowUseBorderSides

public final void setAllowUseBorderSides(boolean value)

getAllowUseBrush

public final boolean getAllowUseBrush()

Gets or sets a value which indicates whether a report engine can use Brush formatting or not.

setAllowUseBrush

public final void setAllowUseBrush(boolean value)

getAllowUseTextBrush

public final boolean getAllowUseTextBrush()

Gets or sets a value which indicates whether a report engine can use TextBrush formatting or not.

setAllowUseTextBrush

public final void setAllowUseTextBrush(boolean value)

getAllowUseTextOptions

public final boolean getAllowUseTextOptions()

Gets or sets a value which indicates whether a report engine can use TextOptions formatting or not.

setAllowUseTextOptions

public final void setAllowUseTextOptions(boolean value)

GetStyleFromComponent

public void GetStyleFromComponent(StiComponent component,
                         StiStyleElements styleElements)

Gets a style from the component.

Specified by:

GetStyleFromComponent in class StiBaseStyle

Parameters:

component - Component.

GetStyleFromComponent

public final void GetStyleFromComponent(StiComponent component,
                         StiStyleElements styleElements,
                         StiBaseStyle componentStyle)

Gets a style from the component.

Parameters:

component - Component

styleElements - Elements of style

componentStyle - Odd/Even/Component style of component, if present

SetStyleToComponent

public void SetStyleToComponent(StiComponent component)

Sets style to a component.

Specified by:

SetStyleToComponent in class StiBaseStyle

Parameters:

component - Component.

getStyleCode

public final StiStyleCode getStyleCode()

Gets or sets a value which indicates on which band in a report this style can be apply when applying style automatically.

setStyleCode

public final void setStyleCode(StiStyleCode value)

getImage

public final StiImage getImage()

Gets or sets the image to fill Image property of Image component.

setImage

public final void setImage(StiImage value)

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiBaseStyle

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiBaseStyle

Throws:

JSONException