Package 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, 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, Cloneable, IStiGlobalizationProvider
Describes the class that realizes the component - Text.

  • Field Details

    • PropertyCanBreak

      protected static Object PropertyCanBreak

    • PropertyAutoWidth

      protected static Object PropertyAutoWidth

    • PropertyRenderTo

      protected static Object PropertyRenderTo

    • font

      public StiFont font

    • PropertyNullValue

      protected static Object PropertyNullValue

    • PropertyType

      protected static Object PropertyType

    • PropertyExportAsImage

      protected static Object PropertyExportAsImage

    • PropertyTextQuality

      protected static Object PropertyTextQuality

    • PropertyAllowHtmlTags

      protected static Object PropertyAllowHtmlTags

    • PropertyMargins

      protected static Object PropertyMargins

    • PropertyShrinkFontToFit

      protected static Object PropertyShrinkFontToFit

    • PropertyShrinkFontToFitMinimumSize

      protected static Object PropertyShrinkFontToFitMinimumSize

    • PropertyLineSpacing

      protected static Object PropertyLineSpacing

  • Constructor Details

    • 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, String text)
      Creates a new StiText.
      Parameters:
      rect - The rectangle describes sizes and position of the component.
      text - Text expression.

  • Method Details

    • Break

      public boolean Break(StiComponent dividedComponent, double devideFactor, StiRefObject<Double> divideLine, StiRefObject<Boolean> haveBreaked)
      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(String propertyName, String value)
      Sets localized string to specified property name.
      Specified by:
      setString in interface IStiGlobalizationProvider
      Parameters:
      propertyName -
      value -

    • getString

      public String getString(String propertyName)
      Gets localized string from specified property name.
      Specified by:
      getString in interface IStiGlobalizationProvider
      Parameters:
      propertyName -
      Returns:

    • getAllStrings

      public 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 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(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 String getFormat()

    • setFormat

      public void setFormat(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 String getLocalizedCategory()
      Gets a localized name of the component category.
      Overrides:
      getLocalizedCategory in class StiBase

    • getLocalizedName

      public String getLocalizedName()
      Gets a localized component name.
      Overrides:
      getLocalizedName in class StiBase

    • getExcelDataValue

      public final String getExcelDataValue()
      Gets or sets excel data value.

    • setExcelDataValue

      public final void setExcelDataValue(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

    • OnGetExcelValue

      protected void OnGetExcelValue(StiGetExcelValueEventArgs e)
      Raises the GetExcelValue event.

    • InvokeGetExcelValue

      public void InvokeGetExcelValue(StiComponent sender, StiGetExcelValueEventArgs e)

    • getGetExcelValueEvent

      public final StiGetExcelValueEvent getGetExcelValueEvent()
      Occurs when the ExcelValue is calculated.

    • setGetExcelValueEvent

      public final void setGetExcelValueEvent(StiGetExcelValueEvent value)

    • getNullValue

      public final String getNullValue()
      Gets or sets a value which shows instead null values.

    • setNullValue

      public final void setNullValue(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)

    • getRightToLeft

      public boolean getRightToLeft()

    • setRightToLeft

      public void setRightToLeft(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)

    • getLineSpacing

      public float getLineSpacing()
      Returns:
      the propertyLineSpacing

    • setLineSpacing

      public void setLineSpacing(float lineSpacing)
      Parameters:
      propertyLineSpacing - the propertyLineSpacing to set

    • 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(String text)

    • getActualFont

      public final StiFont getActualFont(StiExpression text, float minFontSize)

    • getActualFont

      public final StiFont getActualFont(String text, float minFontSize)

    • clone

      public 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 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 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 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 Object getTagValue()
      Description copied from class: StiComponent
      gets or sets tag of a component.
      Overrides:
      getTagValue in class StiComponent

    • getComponentStyle

      public 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

    • checkAllowHtmlTags

      public boolean checkAllowHtmlTags()