Package com.stimulsoft.report.components.simplecomponents

Class StiSimpleText

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.StiBase

com.stimulsoft.report.components.StiComponent

com.stimulsoft.report.components.simplecomponents.StiSimpleText

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiEditable, IStiGlobalizedName, IStiGrowToHeight, IStiInteraction, IStiOnlyText, IStiPrintOn, IStiProcessAt, IStiProcessAtEnd, IStiSelect, IStiShift, IStiText, IStiUnitConvert, IStiReportProperty, IStiInherited, IStiStateSaveRestore, Cloneable

Direct Known Subclasses:

StiRichText, StiText

public abstract class StiSimpleText
extends StiComponent
implements IStiGlobalizedName, IStiText, IStiEditable, IStiProcessAtEnd, IStiProcessAt, IStiOnlyText

Describes the class that realizes the component - StiText.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Object	PropertyGlobalizedName
protected static Object	PropertyMaxNumberOfLines
protected static Object	PropertyOnlyText
protected static Object	PropertyProcessAt
protected static Object	PropertyProcessingDuplicates
StiExpression	text
String	totalValueHelp

Fields inherited from class com.stimulsoft.report.components.StiComponent

canGrow, canShrink, componentPlacement, conditions, currentPointer, eventFlags, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, width

Fields inherited from class com.stimulsoft.base.services.StiService

properties

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiSimpleText()	Creates a new object of the type StiSimpleText.
StiSimpleText(StiRectangle rect)	Creates a new component of the type StiSimpleText.
StiSimpleText(StiRectangle rect, String text)	Creates a new component of the type StiSimpleText.

Method Summary

Modifier and Type	Method	Description
void	checkDuplicates(StiComponent sender, StiGetValueEventArgs e)
Object	clone()	Creates a new object that is a copy of the current instance.
final String	getComponentGuid()	Internal use only.
boolean	getEditable()	Gets or sets value indicates that a component can be edited in the window of viewer.
StiEventsCollection	getEvents()	Return events collection of this component.
final StiGetValueEvent	getGetValueEvent()	Occurs when the text is being prepared for rendering.
String	getGlobalizedName()	Gets or sets special identificator which will be used for report globalization.
boolean	getHideZeros()	Gets or sets value indicates that no need show zeroes.
StiPenStyle	getLinesOfUnderline()	Gets or sets value indicates that it is necessary to lines of underline.
boolean	getLinesOfUnderlining()	Gets or sets value indicates that it is necessary to lines of underlining.
int	getMaxNumberOfLines()	Gets or sets maximum number of lines which specify the limit of the height stretch.
boolean	getOnlyText()	Gets or sets value indicates that the text expression contains a text only.
StiProcessAt	getProcessAt()	Gets or sets value indicates that a text is processed at the end of the report execution.
boolean	getProcessAtEnd()	Gets or sets value indicates that a text is processed at the end of the report execution.
StiProcessingDuplicatesType	getProcessingDuplicates()	Gets or sets value which indicates how report engine processes duplicated values.
String	getQuickInfo()
StiExpression	getText()	Gets or sets text expression.
String	getTextInternal()	Internal use only.
String	getTextValue()	Gets or sets text value.
final String	GetTextWithoutZero(String text)
String	getTotalValueHelp()	Internal use only.
void	InvokeGetValue(StiComponent sender, StiGetValueEventArgs e)
void	InvokeRenderTo(StiSimpleText textBox)
final void	InvokeTextProcess(StiComponent sender, StiValueEventArgs e)	Raises the TextProcess event.
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnGetValue(StiGetValueEventArgs e)	Raises the GetValue event.
String	ProcessText(String text)
void	RestoreState(String stateName)	Restores the earlier saved object state.
void	saveState(String stateName)	Saves the current state of an object.
String	SaveState()	Saves state of editable value.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setComponentGuid(String value)
void	setEditable(boolean value)
final void	setGetValueEvent(StiGetValueEvent value)
void	setGlobalizedName(String value)
void	setHideZeros(boolean value)
void	setLinesOfUnderline(StiPenStyle value)
void	setLinesOfUnderlining(boolean value)
void	setMaxNumberOfLines(int value)
void	setOnlyText(boolean value)
void	setProcessAt(StiProcessAt value)
void	setProcessAtEnd(boolean value)
void	setProcessingDuplicates(StiProcessingDuplicatesType value)
void	setText(StiExpression value)
void	setText(String value)
void	SetText(Object getValue, String value)	Sets the text value in all printed objects.
void	setTextInternal(String value)	Internal use only.
void	SetTextInternal(String value)	Internal use only.
void	setTextValue(String value)
void	setTotalValueHelp(String value)

Methods inherited from class com.stimulsoft.report.components.StiComponent

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getActualSize, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getCanGrow, getCanShrink, getClickEvent, getClientRectangle, getComponentPlacement, getComponentStyle, GetComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDefaultClientRectangle, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getExpressions, getForceRedrawAll, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGrowToHeight, getGuid, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLeft, getLevel, getLinked, getLocked, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getPrintable, getPrintOn, getPriority, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getStates, getTag, getTagStrValue, getTagValue, getToolboxPosition, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, isAutomaticDock, isDesigning, isExportAsImage, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanGrow, setCanShrink, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGrowToHeight, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeft, setLeftProp, setLinked, setLocked, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setPrintable, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getLocalizedCategory, getLocalizedName, getName, getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

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

PropertyGlobalizedName

protected static Object PropertyGlobalizedName

PropertyProcessingDuplicates

protected static Object PropertyProcessingDuplicates

PropertyOnlyText

protected static Object PropertyOnlyText

PropertyMaxNumberOfLines

protected static Object PropertyMaxNumberOfLines

PropertyProcessAt

protected static Object PropertyProcessAt

text

public StiExpression text

totalValueHelp

public String totalValueHelp

Constructor Details

StiSimpleText

public StiSimpleText()

Creates a new object of the type StiSimpleText.

StiSimpleText

public StiSimpleText(StiRectangle rect)

Creates a new component of the type StiSimpleText.

Parameters:

rect - The rectangle describes size and position of the component.

StiSimpleText

public StiSimpleText(StiRectangle rect,
 String text)

Creates a new component of the type StiSimpleText.

Parameters:

rect - The rectangle describes size and position of the component.

text - Text expression

Method Details

InvokeTextProcess

public final void InvokeTextProcess(StiComponent sender,
 StiValueEventArgs e)

Raises the TextProcess event.

setComponentGuid

public final void setComponentGuid(String value)

getGlobalizedName

public String getGlobalizedName()

Gets or sets special identificator which will be used for report globalization.

Specified by:

getGlobalizedName in interface IStiGlobalizedName

setGlobalizedName

public void setGlobalizedName(String value)

Specified by:

setGlobalizedName in interface IStiGlobalizedName

saveState

public void saveState(String stateName)

Saves the current state of an object.

Specified by:

saveState in interface IStiStateSaveRestore

Overrides:

saveState in class StiComponent

Parameters:

stateName - A name of the state being saved.

RestoreState

public void RestoreState(String stateName)

Restores the earlier saved object state.

Specified by:

RestoreState in interface IStiEditable

Overrides:

RestoreState in class StiComponent

Parameters:

stateName - A name of the state being restored.

clone

public Object clone()

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

Overrides:

clone in class StiComponent

Returns:

A new object that is a copy of this instance.

GetTextWithoutZero

public final String GetTextWithoutZero(String text)

getLinesOfUnderline

public StiPenStyle getLinesOfUnderline()

Gets or sets value indicates that it is necessary to lines of underline.

Specified by:

getLinesOfUnderline in interface IStiText

setLinesOfUnderline

public void setLinesOfUnderline(StiPenStyle value)

Specified by:

setLinesOfUnderline in interface IStiText

getLinesOfUnderlining

public boolean getLinesOfUnderlining()

Gets or sets value indicates that it is necessary to lines of underlining.

setLinesOfUnderlining

public void setLinesOfUnderlining(boolean value)

getHideZeros

public boolean getHideZeros()

Gets or sets value indicates that no need show zeroes.

Specified by:

getHideZeros in interface IStiText

setHideZeros

public void setHideZeros(boolean value)

Specified by:

setHideZeros in interface IStiText

getProcessingDuplicates

public StiProcessingDuplicatesType getProcessingDuplicates()

Gets or sets value which indicates how report engine processes duplicated values.

Specified by:

getProcessingDuplicates in interface IStiText

setProcessingDuplicates

public void setProcessingDuplicates(StiProcessingDuplicatesType value)

Specified by:

setProcessingDuplicates in interface IStiText

getMaxNumberOfLines

public int getMaxNumberOfLines()

Gets or sets maximum number of lines which specify the limit of the height stretch.

Specified by:

getMaxNumberOfLines in interface IStiText

setMaxNumberOfLines

public void setMaxNumberOfLines(int value)

Specified by:

setMaxNumberOfLines in interface IStiText

ProcessText

public String ProcessText(String text)

getOnlyText

public boolean getOnlyText()

Gets or sets value indicates that the text expression contains a text only.

Specified by:

getOnlyText in interface IStiOnlyText

Specified by:

getOnlyText in interface IStiText

setOnlyText

public void setOnlyText(boolean value)

Specified by:

setOnlyText in interface IStiOnlyText

Specified by:

setOnlyText in interface IStiText

getEditable

public boolean getEditable()

Gets or sets value indicates that a component can be edited in the window of viewer.

Specified by:

getEditable in interface IStiEditable

setEditable

public void setEditable(boolean value)

Specified by:

setEditable in interface IStiEditable

getProcessAtEnd

public boolean getProcessAtEnd()

Gets or sets value indicates that a text is processed at the end of the report execution.

Specified by:

getProcessAtEnd in interface IStiProcessAtEnd

setProcessAtEnd

public void setProcessAtEnd(boolean value)

Specified by:

setProcessAtEnd in interface IStiProcessAtEnd

getProcessAt

public StiProcessAt getProcessAt()

Gets or sets value indicates that a text is processed at the end of the report execution.

Specified by:

getProcessAt in interface IStiProcessAt

setProcessAt

public void setProcessAt(StiProcessAt value)

Specified by:

setProcessAt in interface IStiProcessAt

InvokeRenderTo

public void InvokeRenderTo(StiSimpleText textBox)

getQuickInfo

public String getQuickInfo()

Overrides:

getQuickInfo in class StiComponent

getEvents

public StiEventsCollection getEvents()

Return events collection of this component.

Overrides:

getEvents in class StiComponent

getText

public StiExpression getText()

Gets or sets text expression.

Specified by:

getText in interface IStiText

setText

public void setText(StiExpression value)

Specified by:

setText in interface IStiText

setText

public void setText(String value)

SetText

public void SetText(Object getValue,
 String value)

Sets the text value in all printed objects.

Parameters:

text - Value for setting.

getTextInternal

public String getTextInternal()

Internal use only.

Specified by:

getTextInternal in interface IStiText

SetTextInternal

public void SetTextInternal(String value)

Internal use only.

setTextInternal

public void setTextInternal(String value)

Description copied from interface: IStiText

Internal use only.

Specified by:

setTextInternal in interface IStiText

getTextValue

public String getTextValue()

Gets or sets text value. If the text is not null thet it is necessary to use this text.

Specified by:

getTextValue in interface IStiText

setTextValue

public void setTextValue(String value)

Specified by:

setTextValue in interface IStiText

OnGetValue

protected void OnGetValue(StiGetValueEventArgs e)

Raises the GetValue event.

getGetValueEvent

public final StiGetValueEvent getGetValueEvent()

Occurs when the text is being prepared for rendering.

setGetValueEvent

public final void setGetValueEvent(StiGetValueEvent value)

getTotalValueHelp

public String getTotalValueHelp()

Internal use only.

setTotalValueHelp

public void setTotalValueHelp(String value)

getComponentGuid

public final String getComponentGuid()

Internal use only.

InvokeGetValue

public void InvokeGetValue(StiComponent sender,
 StiGetValueEventArgs e)

checkDuplicates

public void checkDuplicates(StiComponent sender,
 StiGetValueEventArgs e)

SaveState

public String SaveState()

Saves state of editable value.

Specified by:

SaveState in interface IStiEditable

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiComponent

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiComponent

Throws:

JSONException