com.stimulsoft.report.components.simplecomponents
Class StiText

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
                      com.stimulsoft.report.components.simplecomponents.StiText

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiAutoWidth, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiEditable, IStiExportImage, IStiExportImageExtended, IStiFont, IStiGlobalizedName, IStiGrowToHeight, IStiIndicator, IStiInteraction, IStiOnlyText, IStiPrintOn, IStiProcessAt, IStiProcessAtEnd, IStiSelect, IStiShift, IStiText, IStiTextBrush, IStiTextFormat, IStiTextHorAlignment, IStiTextOptions, IStiUnitConvert, IStiVertAlignment, IStiReportProperty, IStiGlobalizationProvider, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable

Direct Known Subclasses:

StiContourText, StiCrossField, StiSystemText, StiTableCell, StiTextInCells

public class StiText
extends StiSimpleText
implements IStiTextOptions, IStiAutoWidth, IStiTextHorAlignment, IStiVertAlignment, IStiBorder, IStiFont, IStiBrush, IStiTextBrush, IStiTextFormat, IStiSerializable, IStiSerializableToAttributes, IStiBreakable, IStiExportImageExtended, IStiPrintOn, IStiIndicator, java.lang.Cloneable, IStiGlobalizationProvider

Describes the class that realizes the component - Text.

Field Summary

StiFont

font

Fields inherited from class com.stimulsoft.report.components.simplecomponents.StiSimpleText

text, totalValueHelp

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

canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

StiText()
Creates a new StiText.

StiText(StiRectangle rect)
Creates a new StiText.

StiText(StiRectangle rect, java.lang.String text)
Creates a new StiText.

Method Summary

boolean	Break(StiComponent dividedComponent, double devideFactor, StiRefObject<java.lang.Double> divideLine) Occurs when the ExcelValue is calculated.
java.lang.Object	clone() Creates a new object that is a copy of the current instance.
StiRectangle	convertTextBorders(StiRectangle rect, boolean convert)
StiRectangle	convertTextMargins(StiRectangle rect, boolean convert)
StiFont	getActualFont(StiExpression text, float minFontSize)
StiFont	getActualFont(java.lang.String text)
StiFont	getActualFont(java.lang.String text, float minFontSize)
StiSize	getActualSize() Initializes a new instance of the StiSize class from the specified dimensi.
boolean	getAllowHtmlTags() Gets or sets value that indicates that this component allow Html tags in text.
java.lang.String[]	getAllStrings() Returns array of the property names which can be localized.
float	getAngle() Gets or sets angle of a text rotation.
boolean	getAutoWidth() Gets or sets value indicates that this object can change width automatically.
StiBorder	getBorder() Gets or sets frame of the component.
StiBrush	getBrush() Gets or sets a brush to fill a component.
boolean	getCanBreak() Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
StiRectangle	getClientRectangle() gets or sets the client area of a component.
java.lang.String	getComponentPlacement() gets or sets a value which indicates placement of a simple component.
java.lang.String	getComponentStyle() gets or sets a style of a component.
java.lang.String	getExcelDataValue() Gets or sets excel data value.
StiExcelValueExpression	getExcelValue() Gets or sets an expression used for export data to Excel.
boolean	getExportAsImage() Gets or sets value which indicates how content of text will be exported as image or as text.
StiFont	getFont() Gets or sets font of component.
java.lang.String	getFormat()
StiGetExcelValueEvent	getGetExcelValueEvent() Occurs when the ExcelValue is calculated.
java.lang.String	getGuid() gets or sets a guid of component.
StiTextHorAlignment	getHorAlignment() Gets or sets the text horizontal alignment.
StiIndicator	getIndicator() Gets or sets special indicator for text component.
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
StiMargins	getMargins() Gets or sets text margins.
java.lang.String	getName() Gets or sets a component name.
java.lang.String	getNullValue() Gets or sets a value which shows instead null values.
java.lang.String	getRenderTo() In the property specify the Text component in what the text that is out of the current Text component bound will be continued to be output.
boolean	getShrinkFontToFit() Gets or sets value that indicates that this component is descrease size of font to fit content of component.
float	getShrinkFontToFitMinimumSize() Gets or sets value that indicates minimum font size for ShrinkFontToFit operation.
java.lang.String	getString(java.lang.String propertyName) Gets localized string from specified property name.
java.lang.Object	getTagValue() gets or sets tag of a component.
StiBrush	getTextBrush() Gets or sets a brush to draw text.
StiFormatService	getTextFormat() Gets or sets the format of the text.
StiTextOptions	getTextOptions() Gets or sets options to control of the text showing.
StiTextQuality	getTextQuality() Gets or sets value that indicates quality of text.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
StiSystemTextType	getType()
StiVertAlignment	getVertAlignment() Gets or sets the vertical alignment of an object.
boolean	getWordWrap() Gets or sets word wrap.
boolean	getWYSIWYG() Gets or sets value that indicates that this component is to be output as WYSIWYG concept.
void	invokeEvents() Invokes all events for this components.
void	InvokeRenderTo(StiSimpleText textFrom)
boolean	isExportAsImage(StiExportFormat format)
void	LoadFromJsonObject(JSONObject jObject)
StiSize	measureString()
void	packService() Packs a service.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAllowHtmlTags(boolean value)
void	setAngle(float value)
void	setAutoWidth(boolean value)
void	setBorder(StiBorder value)
void	setBrush(StiBrush value)
void	setCanBreak(boolean value)
void	setExcelDataValue(java.lang.String value)
void	setExcelValue(StiExcelValueExpression value)
void	setExportAsImage(boolean value)
void	setFont(StiFont value)
void	setFormat(java.lang.String value)
void	setGetExcelValueEvent(StiGetExcelValueEvent value)
void	setHorAlignment(StiTextHorAlignment value)
void	setIndicator(StiIndicator value)
void	setMargins(StiMargins value)
void	setNullValue(java.lang.String value)
void	setRenderTo(java.lang.String value)
void	setShrinkFontToFit(boolean value)
void	setShrinkFontToFitMinimumSize(float value)
void	setString(java.lang.String propertyName, java.lang.String value) Sets localized string to specified property name.
void	setTextBrush(StiBrush value)
void	setTextFormat(StiFormatService value)
void	setTextOptions(StiTextOptions value)
void	setTextQuality(StiTextQuality value)
void	setType(StiSystemTextType value)
void	setVertAlignment(StiVertAlignment value)
void	setWordWrap(boolean value)
void	setWYSIWYG(boolean value)

Methods inherited from class com.stimulsoft.report.components.simplecomponents.StiSimpleText

checkDuplicates, getComponentGuid, getEditable, getEvents, getGetValueEvent, getGlobalizedName, getHideZeros, getLinesOfUnderline, getLinesOfUnderlining, getMaxNumberOfLines, getOnlyText, getProcessAt, getProcessAtEnd, getProcessingDuplicates, getQuickInfo, getText, getTextInternal, getTextValue, GetTextWithoutZero, getTotalValueHelp, InvokeGetValue, InvokeTextProcess, ProcessText, RestoreState, SaveState, saveState, setComponentGuid, setEditable, setGetValueEvent, setGlobalizedName, setHideZeros, setLinesOfUnderline, setLinesOfUnderlining, setMaxNumberOfLines, setOnlyText, setProcessAt, setProcessAtEnd, setProcessingDuplicates, SetText, setText, setText, setTextInternal, SetTextInternal, setTextValue, setTotalValueHelp

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

addSize, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getCanGrow, getCanShrink, getClickEvent, 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, 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, getTag, getTagStrValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnRemoveComponent, 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

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, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getReference, setReference

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImageExtended

getImage

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImage

getImage

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiPrintOn

getPrintOn, setPrintOn

Field Detail

font

public StiFont font

Constructor Detail

StiText

public StiText()

Creates a new StiText.

StiText

public StiText(StiRectangle rect)

Creates a new StiText.

Parameters:

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

StiText

public StiText(StiRectangle rect,
               java.lang.String text)

Creates a new StiText.

Parameters:

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

text - Text expression.

Method Detail

Break

public boolean Break(StiComponent dividedComponent,
                     double devideFactor,
                     StiRefObject<java.lang.Double> divideLine)

Occurs when the ExcelValue is calculated.

Specified by:

Break in interface IStiBreakable

Parameters:

dividedComponent - Component for store part of content.

Returns:

If true, then component is successful divided.

getIndicator

public StiIndicator getIndicator()

Gets or sets special indicator for text component.

setIndicator

public void setIndicator(StiIndicator value)

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiComponent

setString

public void setString(java.lang.String propertyName,
                      java.lang.String value)

Sets localized string to specified property name.

Specified by:

setString in interface IStiGlobalizationProvider

getString

public java.lang.String getString(java.lang.String propertyName)

Gets localized string from specified property name.

Specified by:

getString in interface IStiGlobalizationProvider

Returns:

getAllStrings

public java.lang.String[] getAllStrings()

Returns array of the property names which can be localized.

Specified by:

getAllStrings in interface IStiGlobalizationProvider

Returns:

Returns array of the property names which can be localized.

getCanBreak

public boolean getCanBreak()

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.

Specified by:

getCanBreak in interface IStiBreakable

setCanBreak

public void setCanBreak(boolean value)

Specified by:

setCanBreak in interface IStiBreakable

getAutoWidth

public boolean getAutoWidth()

Gets or sets value indicates that this object can change width automatically.

Specified by:

getAutoWidth in interface IStiAutoWidth

setAutoWidth

public void setAutoWidth(boolean value)

Specified by:

setAutoWidth in interface IStiAutoWidth

getRenderTo

public java.lang.String getRenderTo()

In the property specify the Text component in what the text that is out of the current Text component bound will be continued to be output.

setRenderTo

public void setRenderTo(java.lang.String value)

InvokeRenderTo

public void InvokeRenderTo(StiSimpleText textFrom)

Overrides:

InvokeRenderTo in class StiSimpleText

getWYSIWYG

public boolean getWYSIWYG()

Gets or sets value that indicates that this component is to be output as WYSIWYG concept.

setWYSIWYG

public void setWYSIWYG(boolean value)

getHorAlignment

public StiTextHorAlignment getHorAlignment()

Gets or sets the text horizontal alignment.

Specified by:

getHorAlignment in interface IStiTextHorAlignment

setHorAlignment

public void setHorAlignment(StiTextHorAlignment value)

Specified by:

setHorAlignment in interface IStiTextHorAlignment

getVertAlignment

public StiVertAlignment getVertAlignment()

Gets or sets the vertical alignment of an object.

Specified by:

getVertAlignment in interface IStiVertAlignment

setVertAlignment

public void setVertAlignment(StiVertAlignment value)

Specified by:

setVertAlignment in interface IStiVertAlignment

getFont

public StiFont getFont()

Gets or sets font of component.

Specified by:

getFont in interface IStiFont

setFont

public void setFont(StiFont value)

Specified by:

setFont in interface IStiFont

getBorder

public final StiBorder getBorder()

Gets or sets frame of the component.

Specified by:

getBorder in interface IStiBorder

setBorder

public final void setBorder(StiBorder value)

Specified by:

setBorder in interface IStiBorder

getBrush

public final StiBrush getBrush()

Gets or sets a brush to fill a component.

Specified by:

getBrush in interface IStiBrush

setBrush

public final void setBrush(StiBrush value)

Specified by:

setBrush in interface IStiBrush

getTextBrush

public StiBrush getTextBrush()

Gets or sets a brush to draw text.

Specified by:

getTextBrush in interface IStiTextBrush

setTextBrush

public void setTextBrush(StiBrush value)

Specified by:

setTextBrush in interface IStiTextBrush

getTextFormat

public StiFormatService getTextFormat()

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

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String value)

getTextOptions

public StiTextOptions getTextOptions()

Gets or sets options to control of the text showing.

Specified by:

getTextOptions in interface IStiTextOptions

setTextOptions

public void setTextOptions(StiTextOptions value)

Specified by:

setTextOptions in interface IStiTextOptions

convertTextMargins

public final StiRectangle convertTextMargins(StiRectangle rect,
                                             boolean convert)

convertTextBorders

public final StiRectangle convertTextBorders(StiRectangle rect,
                                             boolean convert)

packService

public void packService()

Description copied from class: StiComponent

Packs a service.

Overrides:

packService in class StiComponent

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiComponent

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiBase

getExcelDataValue

public final java.lang.String getExcelDataValue()

Gets or sets excel data value.

setExcelDataValue

public final void setExcelDataValue(java.lang.String value)

getExcelValue

public StiExcelValueExpression getExcelValue()

Gets or sets an expression used for export data to Excel. Only for numeric values.

setExcelValue

public void setExcelValue(StiExcelValueExpression value)

invokeEvents

public void invokeEvents()

Invokes all events for this components.

Overrides:

invokeEvents in class StiComponent

getGetExcelValueEvent

public final StiGetExcelValueEvent getGetExcelValueEvent()

Occurs when the ExcelValue is calculated.

setGetExcelValueEvent

public final void setGetExcelValueEvent(StiGetExcelValueEvent value)

getNullValue

public final java.lang.String getNullValue()

Gets or sets a value which shows instead null values.

setNullValue

public final void setNullValue(java.lang.String value)

getType

public final StiSystemTextType getType()

setType

public final void setType(StiSystemTextType value)

getWordWrap

public boolean getWordWrap()

Gets or sets word wrap.

setWordWrap

public void setWordWrap(boolean value)

getAngle

public float getAngle()

Gets or sets angle of a text rotation.

setAngle

public void setAngle(float value)

getExportAsImage

public boolean getExportAsImage()

Gets or sets value which indicates how content of text will be exported as image or as text.

setExportAsImage

public void setExportAsImage(boolean value)

getTextQuality

public StiTextQuality getTextQuality()

Gets or sets value that indicates quality of text.

setTextQuality

public void setTextQuality(StiTextQuality value)

getAllowHtmlTags

public boolean getAllowHtmlTags()

Gets or sets value that indicates that this component allow Html tags in text.

setAllowHtmlTags

public void setAllowHtmlTags(boolean value)

getMargins

public StiMargins getMargins()

Gets or sets text margins.

setMargins

public void setMargins(StiMargins value)

getShrinkFontToFit

public boolean getShrinkFontToFit()

Gets or sets value that indicates that this component is descrease size of font to fit content of component.

setShrinkFontToFit

public void setShrinkFontToFit(boolean value)

getShrinkFontToFitMinimumSize

public float getShrinkFontToFitMinimumSize()

Gets or sets value that indicates minimum font size for ShrinkFontToFit operation.

setShrinkFontToFitMinimumSize

public void setShrinkFontToFitMinimumSize(float value)

getActualFont

public final StiFont getActualFont(java.lang.String text)

getActualFont

public final StiFont getActualFont(StiExpression text,
                                   float minFontSize)

getActualFont

public final StiFont getActualFont(java.lang.String text,
                                   float minFontSize)

clone

public java.lang.Object clone()

Description copied from class: StiSimpleText

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

Overrides:

clone in class StiSimpleText

Returns:

A new object that is a copy of this instance.

getActualSize

public StiSize getActualSize()

Description copied from class: StiComponent

Initializes a new instance of the StiSize class from the specified dimensi.

Overrides:

getActualSize in class StiComponent

Returns:

A class of the StiSize type which represents an actual size of the component.

getClientRectangle

public StiRectangle getClientRectangle()

Description copied from class: StiComponent

gets or sets the client area of a component.

Overrides:

getClientRectangle in class StiComponent

getName

public java.lang.String getName()

Description copied from class: StiBase

Gets or sets a component name.

Specified by:

getName in interface IStiName

Overrides:

getName in class StiBase

getComponentPlacement

public java.lang.String getComponentPlacement()

Description copied from class: StiComponent

gets or sets a value which indicates placement of a simple component. Available values: "rt" - StiReportTitleBand "rs" - StiReportSummaryBand "ph" - StiPageHeaderBand "pf" - StiPageFooterBand "h" - StiHeaderBand "h.ap" - StiHeaderBand (OnAllPages) "f" - StiFooterBand "f.ap" - StiFooterBand (OnAllPages) "d" - StiDataBand "gh" - StiGroupHeaderBand "gf" - StiGroupFooterBand "e" - StiEmptyBand "p" - StiPage

Overrides:

getComponentPlacement in class StiComponent

getGuid

public java.lang.String getGuid()

Description copied from class: StiComponent

gets or sets a guid of component.

Specified by:

getGuid in interface IStiComponentGuid

Overrides:

getGuid in class StiComponent

getTagValue

public java.lang.Object getTagValue()

Description copied from class: StiComponent

gets or sets tag of a component.

Overrides:

getTagValue in class StiComponent

getComponentStyle

public java.lang.String getComponentStyle()

Description copied from class: StiComponent

gets or sets a style of a component.

Overrides:

getComponentStyle in class StiComponent

measureString

public StiSize measureString()

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiSimpleText

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiSimpleText

Throws:

JSONException