com.stimulsoft.report.components.simplecomponents

Class StiTextInCells

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

com.stimulsoft.report.components.simplecomponents.StiTextInCells

All Implemented Interfaces:

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

public class StiTextInCells
extends StiText

Describes the class that realizes the component - StiTextInCells.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	PropertyCellHeight
protected static java.lang.Object	PropertyCellWidth
protected static java.lang.Object	PropertyContinuousText
protected static java.lang.Object	PropertyHorSpacing
protected static java.lang.Object	PropertyVertSpacing

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

font, PropertyAllowHtmlTags, PropertyAutoWidth, PropertyCanBreak, PropertyExportAsImage, PropertyMargins, PropertyNullValue, PropertyRenderTo, PropertyShrinkFontToFit, PropertyShrinkFontToFitMinimumSize, PropertyTextQuality, PropertyType

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

PropertyGlobalizedName, PropertyMaxNumberOfLines, PropertyOnlyText, PropertyProcessAt, PropertyProcessingDuplicates, text, totalValueHelp

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

canGrow, canShrink, componentPlacement, conditions, interaction, isRendered, page, parent, parentBookmark, 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 and Description
StiTextInCells() Creates a new StiTextInCells.
StiTextInCells(StiRectangle rect) Creates a new StiTextInCells.
StiTextInCells(StiRectangle rect, java.lang.String text) Creates a new StiTextInCells.

Method Summary

Methods

Modifier and Type	Method and Description
void	convert(StiUnit oldUnit, StiUnit newUnit) Converts a component out of one unit into another.
boolean	getAllowHtmlTags() Gets or sets value that indicates that this component allow Html tags in text.
float	getAngle() Gets or sets angle of a text rotation.
boolean	getAutoWidth() Gets or sets value indicates that this object can change width automatically.
boolean	getCanGrow() gets or sets a value which indicates that this object can grow.
boolean	getCanShrink() gets or sets value which indicates that this object can shrink.
float	getCellHeight() Gets or sets height of the cell.
float	getCellWidth() Gets or sets width of the cell.
boolean	getContinuousText() Gets or sets continuous text flag.
StiExcelValueExpression	getExcelValue() Gets or sets an expression used for export data to Excel.
float	getHorSpacing() Gets or sets horizontal spacing between cells.
StiPenStyle	getLinesOfUnderline() Gets or sets value indicates that it is necessary to lines of underline.
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
int	getMaxNumberOfLines() Gets or sets maximum number of lines which specify the limit of the height stretch.
StiProcessingDuplicatesType	getProcessingDuplicates() Gets or sets value which indicates how report engine processes duplicated 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	getRightToLeft() Gets or sets horizontal output direction.
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	getTextForPaint()
StiTextQuality	getTextQuality() Gets or sets value that indicates quality of text.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
StiVertAlignment	getVertAlignment() Gets or sets the vertical alignment of an object.
float	getVertSpacing() Gets or sets vertical spacing between cells.
boolean	getWordWrap() Gets or sets word wrap.
boolean	isExportAsImage(StiExportFormat format)
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAllowHtmlTags(boolean value)
void	setAngle(float value)
void	setAutoWidth(boolean value)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
void	setCellHeight(float value)
void	setCellWidth(float value)
void	setContinuousText(boolean value)
void	setExcelValue(StiExcelValueExpression value)
void	setHorSpacing(float value)
void	setLinesOfUnderline(StiPenStyle value)
void	setMaxNumberOfLines(int value)
void	setProcessingDuplicates(StiProcessingDuplicatesType value)
void	setRenderTo(java.lang.String value)
void	setRightToLeft(boolean value)
void	setShrinkFontToFit(boolean value)
void	setShrinkFontToFitMinimumSize(float value)
void	setTextQuality(StiTextQuality value)
void	setVertAlignment(StiVertAlignment value)
void	setVertSpacing(float value)
void	setWordWrap(boolean value)
static StiContainer	splitByCells(StiTextInCells masterTextInCells, StiComponent renderedComponent, java.lang.String textString)
static StiContainer	splitByCells(StiTextInCells masterTextInCells, StiComponent renderedComponent, java.lang.String textString, boolean measure)

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

Break, clone, convertTextBorders, convertTextMargins, getActualFont, getActualFont, getActualFont, getActualSize, getAllStrings, getBorder, getBrush, getCanBreak, getClientRectangle, getComponentPlacement, getComponentStyle, getExcelDataValue, getExportAsImage, getFont, getFormat, getGetExcelValueEvent, getGuid, getHorAlignment, getIndicator, getMargins, getName, getNullValue, getString, getTagValue, getTextBrush, getTextFormat, getTextOptions, getType, getWYSIWYG, invokeEvents, InvokeRenderTo, measureString, OnGetExcelValue, packService, setBorder, setBrush, setCanBreak, setExcelDataValue, setExportAsImage, setFont, setFormat, setGetExcelValueEvent, setHorAlignment, setIndicator, setMargins, setNullValue, setString, setTextBrush, setTextFormat, setTextOptions, setType, setWYSIWYG

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

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

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

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getClickEvent, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDefaultClientRectangle, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, 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, getPrintable, getPrintOn, getPriority, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getStates, getTag, 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, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, 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, 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, finalize, 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

PropertyCellWidth

protected static java.lang.Object PropertyCellWidth

PropertyCellHeight

protected static java.lang.Object PropertyCellHeight

PropertyHorSpacing

protected static java.lang.Object PropertyHorSpacing

PropertyVertSpacing

protected static java.lang.Object PropertyVertSpacing

PropertyContinuousText

protected static java.lang.Object PropertyContinuousText

Constructor Detail

StiTextInCells

public StiTextInCells()

Creates a new StiTextInCells.

StiTextInCells

public StiTextInCells(StiRectangle rect)

Creates a new StiTextInCells.

Parameters:

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

StiTextInCells

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

Creates a new StiTextInCells.

Parameters:

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

text - Text expression.

Method Detail

getVertAlignment

public StiVertAlignment getVertAlignment()

Description copied from class: StiText

Gets or sets the vertical alignment of an object.

Specified by:

getVertAlignment in interface IStiVertAlignment

Overrides:

getVertAlignment in class StiText

setVertAlignment

public void setVertAlignment(StiVertAlignment value)

Specified by:

setVertAlignment in interface IStiVertAlignment

Overrides:

setVertAlignment in class StiText

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiText

convert

public void convert(StiUnit oldUnit,
           StiUnit newUnit)

Converts a component out of one unit into another.

Specified by:

convert in interface IStiUnitConvert

Overrides:

convert in class StiComponent

Parameters:

oldUnit - Old units.

newUnit - New units.

getAutoWidth

public boolean getAutoWidth()

Description copied from class: StiText

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

Specified by:

getAutoWidth in interface IStiAutoWidth

Overrides:

getAutoWidth in class StiText

setAutoWidth

public void setAutoWidth(boolean value)

Specified by:

setAutoWidth in interface IStiAutoWidth

Overrides:

setAutoWidth in class StiText

getCanGrow

public boolean getCanGrow()

Description copied from class: StiComponent

gets or sets a value which indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiComponent

setCanGrow

public void setCanGrow(boolean value)

Specified by:

setCanGrow in interface IStiCanGrow

Overrides:

setCanGrow in class StiComponent

getCanShrink

public boolean getCanShrink()

Description copied from class: StiComponent

gets or sets value which indicates that this object can shrink.

Specified by:

getCanShrink in interface IStiCanShrink

Overrides:

getCanShrink in class StiComponent

setCanShrink

public void setCanShrink(boolean value)

Specified by:

setCanShrink in interface IStiCanShrink

Overrides:

setCanShrink in class StiComponent

getAllowHtmlTags

public boolean getAllowHtmlTags()

Description copied from class: StiText

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

Overrides:

getAllowHtmlTags in class StiText

setAllowHtmlTags

public void setAllowHtmlTags(boolean value)

Overrides:

setAllowHtmlTags in class StiText

getShrinkFontToFit

public boolean getShrinkFontToFit()

Description copied from class: StiText

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

Overrides:

getShrinkFontToFit in class StiText

setShrinkFontToFit

public void setShrinkFontToFit(boolean value)

Overrides:

setShrinkFontToFit in class StiText

getShrinkFontToFitMinimumSize

public float getShrinkFontToFitMinimumSize()

Description copied from class: StiText

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

Overrides:

getShrinkFontToFitMinimumSize in class StiText

setShrinkFontToFitMinimumSize

public void setShrinkFontToFitMinimumSize(float value)

Overrides:

setShrinkFontToFitMinimumSize in class StiText

getAngle

public float getAngle()

Description copied from class: StiText

Gets or sets angle of a text rotation.

Overrides:

getAngle in class StiText

setAngle

public void setAngle(float value)

Overrides:

setAngle in class StiText

getLinesOfUnderline

public StiPenStyle getLinesOfUnderline()

Description copied from class: StiSimpleText

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

Specified by:

getLinesOfUnderline in interface IStiText

Overrides:

getLinesOfUnderline in class StiSimpleText

setLinesOfUnderline

public void setLinesOfUnderline(StiPenStyle value)

Specified by:

setLinesOfUnderline in interface IStiText

Overrides:

setLinesOfUnderline in class StiSimpleText

getMaxNumberOfLines

public int getMaxNumberOfLines()

Description copied from class: StiSimpleText

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

Specified by:

getMaxNumberOfLines in interface IStiText

Overrides:

getMaxNumberOfLines in class StiSimpleText

setMaxNumberOfLines

public void setMaxNumberOfLines(int value)

Specified by:

setMaxNumberOfLines in interface IStiText

Overrides:

setMaxNumberOfLines in class StiSimpleText

getProcessingDuplicates

public StiProcessingDuplicatesType getProcessingDuplicates()

Description copied from class: StiSimpleText

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

Specified by:

getProcessingDuplicates in interface IStiText

Overrides:

getProcessingDuplicates in class StiSimpleText

setProcessingDuplicates

public void setProcessingDuplicates(StiProcessingDuplicatesType value)

Specified by:

setProcessingDuplicates in interface IStiText

Overrides:

setProcessingDuplicates in class StiSimpleText

getRenderTo

public java.lang.String getRenderTo()

Description copied from class: StiText

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.

Overrides:

getRenderTo in class StiText

setRenderTo

public void setRenderTo(java.lang.String value)

Overrides:

setRenderTo in class StiText

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiText

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiText

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiText

getCellWidth

public float getCellWidth()

Gets or sets width of the cell.

setCellWidth

public void setCellWidth(float value)

getCellHeight

public float getCellHeight()

Gets or sets height of the cell.

setCellHeight

public void setCellHeight(float value)

getHorSpacing

public float getHorSpacing()

Gets or sets horizontal spacing between cells.

setHorSpacing

public void setHorSpacing(float value)

getVertSpacing

public float getVertSpacing()

Gets or sets vertical spacing between cells.

setVertSpacing

public void setVertSpacing(float value)

getTextQuality

public StiTextQuality getTextQuality()

Description copied from class: StiText

Gets or sets value that indicates quality of text.

Overrides:

getTextQuality in class StiText

setTextQuality

public void setTextQuality(StiTextQuality value)

Overrides:

setTextQuality in class StiText

getWordWrap

public boolean getWordWrap()

Gets or sets word wrap.

Overrides:

getWordWrap in class StiText

setWordWrap

public void setWordWrap(boolean value)

Overrides:

setWordWrap in class StiText

getRightToLeft

public final boolean getRightToLeft()

Gets or sets horizontal output direction.

setRightToLeft

public final void setRightToLeft(boolean value)

getContinuousText

public boolean getContinuousText()

Gets or sets continuous text flag.

setContinuousText

public void setContinuousText(boolean value)

getExcelValue

public StiExcelValueExpression getExcelValue()

Description copied from class: StiText

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

Overrides:

getExcelValue in class StiText

setExcelValue

public void setExcelValue(StiExcelValueExpression value)

Overrides:

setExcelValue in class StiText

splitByCells

public static StiContainer splitByCells(StiTextInCells masterTextInCells,
                        StiComponent renderedComponent,
                        java.lang.String textString)

splitByCells

public static StiContainer splitByCells(StiTextInCells masterTextInCells,
                        StiComponent renderedComponent,
                        java.lang.String textString,
                        boolean measure)

getTextForPaint

public java.lang.String getTextForPaint()

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiText

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiText

Throws:

JSONException