Package com.stimulsoft.report.dialogs

Class StiTextBoxControl

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.complexcomponents.StiContainer

com.stimulsoft.report.dialogs.StiReportControl

com.stimulsoft.report.dialogs.StiTextBoxControl

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportControl, IStiTextBoxControl, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable

public class StiTextBoxControl
extends StiReportControl
implements IStiTextBoxControl

Represents a Windows text box control.

Field Summary

Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

border, brush, collapsingIndex, components, engine, ParentComponentIsBand, ParentComponentIsCrossBand, PropertyBlocked

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
StiTextBoxControl()	Creates a new StiTextBoxControl.
StiTextBoxControl(StiRectangle rect)	Creates a new StiTextBoxControl.

Method Summary

Modifier and Type	Method	Description
boolean	getAcceptsReturn()	Gets or sets a value indicating whether pressing ENTER in a multiline TextBox control creates a new line of text in the control or activates the default button for the form.
boolean	getAcceptsTab()	Gets or sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.
StiEvent	GetDefaultEvent()	Gets default event for this report control.
double	getHeight()	Gets or sets the height of the control.
String	getLocalizedName()	Gets a localized component name.
final int	getMaxLength()	Gets or sets the maximum number of characters the user can type into the text box control.
boolean	getMultiline()	Gets or sets a value indicating whether this is a multiline text box control.
final char	getPasswordChar()	Gets or sets the character used to mask characters of a password in a single-line TextBox control.
final String	getText()	Gets or sets the current text in the text box.
final String	getTextBinding()	Gets the data bindings for the text.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
boolean	getWordWrap()	Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAcceptsReturn(boolean value)
void	setAcceptsTab(boolean value)
void	setHeight(double value)
final void	setMaxLength(int value)
void	setMultiline(boolean value)
final void	setPasswordChar(char value)
final void	setText(String value)
final void	setTextBinding(String value)
void	setWordWrap(boolean value)

Methods inherited from class com.stimulsoft.report.dialogs.StiReportControl

canContainIn, clone, convert, getAfterPrintEvent, getBackColor, getBeforePrintEvent, getBookmark, getBorder, getBrush, getCanGrow, getCanShrink, getClickEvent, getComponentStyle, getConditions, getControlWpf, getDefaultClientRectangle, getDockStyle, getDoubleClickEvent, getEnabled, getEnterEvent, getEvents, getFont, getForeColor, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGrowToHeight, getHyperlink, getInteraction, getIsReportContainer, getLeaveEvent, getLeft, getLocalizedCategory, getLocation, getMaxSize, getMinSize, getMouseDownEvent, getMouseEnterEvent, getMouseLeaveEvent, getMouseMoveEvent, getMouseUpEvent, getPrintable, getPrintOn, getServiceCategory, getShiftMode, getSize, getTag, getTagValueBinding, getToolTip, getTop, getUseParentStyles, getVisible, getWidth, InvokeEnter, InvokeLeave, InvokeMouseDown, InvokeMouseMove, InvokeMouseUp, packService, setAfterPrintEvent, setBackColor, setBeforePrintEvent, setBookmark, setBorder, setBrush, setCanGrow, setCanShrink, setClickEvent, setComponentStyle, setConditions, setControlWpf, setDockStyle, setDoubleClickEvent, setEnabled, setEnterEvent, setFont, setForeColor, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGrowToHeight, setHyperlink, setInteraction, setLeaveEvent, setLeft, setLocation, setMaxSize, setMinSize, setMouseDownEvent, setMouseEnterEvent, setMouseLeaveEvent, setMouseMoveEvent, setMouseUpEvent, setPrintable, setPrintOn, setShiftMode, setSize, setTag, setTagValueBinding, setToolTip, setTop, setUseParentStyles, setVisible, setWidth, UpdateReportControl

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, clone, clone, ContainerToPage, ContainerToPage, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, GetBorder, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponentPlacementForChildren, getComponents, GetComponents, GetComponentsCount, GetComponentsList, getComponentsSelectedRectangle, getComponentType, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getGuid, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, GetMaxSize, getName, getPriority, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, getTagValue, GetTextBrush, GetTextFormat, GetTextHorAlignment, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, OnComponentAdded, OnComponentRemoved, PageToContainer, PageToContainer, RemoveAllSelected, ResetSelection, RestoreState, saveState, SelectAll, SelectComponent, SelectInRectangle, SelectInRectangleCheckBands, SendToBack, setBlocked, SetBorder, SetBrush, setCanBreak, SetCenterHorizontally, SetCenterVertically, setCollapsedValue, setCollapsingIndex, setCollapsingTreePath, setComponents, setComponentsFont, setComponentsFont, setComponentsWithSetParent, setComponentsWordWrap, SetConditions, setContainerInfoV2, SetDockStyle, setForceSerializeToReport, SetHorAlign, SetLink, setParentComponentIsBand, setParentComponentIsCrossBand, SetParentStylesToChilds, SetParentStylesToChilds, SetTextBrush, SetTextFormat, SetTextHorAlign, SetVertAlign, ShrinkFont, SortByPriority

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

addSize, AllowPrintOn, applyConditions, CheckForParentComponent, clearAllStates, ClearContents, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getAlias, getAllowDelete, getAnchor, getBookmarkValue, getBottom, getBuilder, getComponentPlacement, GetComponentStyle, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDrillDownParameters, getExpressions, getForceRedrawAll, getGroupHeaderBand, GetGroupHeaderBand, getHighlightState, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getLinked, getLocked, getMeasureGraphics, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceType, getShift, getShowQuickButtons, getStates, getTagStrValue, getToolTipValue, 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, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAlias, setAnchor, setBookmarkValue, setClientRectangle, setComponentPlacement, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDrillDownParameters, setExpressions, setGuid, setHeightProp, setHighlightState, setHyperlinkValue, setIgnoreNamingRule, setInherited, setIsRendered, setIsSelected, setLeftProp, setLinked, setLocked, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTagValue, setToolTipValue, setTopProp, 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

Constructor Details

StiTextBoxControl

public StiTextBoxControl()

Creates a new StiTextBoxControl.

StiTextBoxControl

public StiTextBoxControl(StiRectangle rect)

Creates a new StiTextBoxControl.

Parameters:

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

Method Details

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiReportControl

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiReportControl

getTextBinding

public final String getTextBinding()

Gets the data bindings for the text.

Specified by:

getTextBinding in interface IStiTextBoxControl

setTextBinding

public final void setTextBinding(String value)

Specified by:

setTextBinding in interface IStiTextBoxControl

getHeight

public double getHeight()

Gets or sets the height of the control.

Overrides:

getHeight in class StiReportControl

setHeight

public void setHeight(double value)

Overrides:

setHeight in class StiReportControl

getMultiline

public boolean getMultiline()

Gets or sets a value indicating whether this is a multiline text box control.

setMultiline

public void setMultiline(boolean value)

getWordWrap

public boolean getWordWrap()

Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.

setWordWrap

public void setWordWrap(boolean value)

getAcceptsTab

public boolean getAcceptsTab()

Gets or sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.

setAcceptsTab

public void setAcceptsTab(boolean value)

getAcceptsReturn

public boolean getAcceptsReturn()

Gets or sets a value indicating whether pressing ENTER in a multiline TextBox control creates a new line of text in the control or activates the default button for the form.

setAcceptsReturn

public void setAcceptsReturn(boolean value)

getMaxLength

public final int getMaxLength()

Gets or sets the maximum number of characters the user can type into the text box control.

setMaxLength

public final void setMaxLength(int value)

getPasswordChar

public final char getPasswordChar()

Gets or sets the character used to mask characters of a password in a single-line TextBox control.

setPasswordChar

public final void setPasswordChar(char value)

getText

public final String getText()

Gets or sets the current text in the text box.

Specified by:

getText in interface IStiTextBoxControl

setText

public final void setText(String value)

Specified by:

setText in interface IStiTextBoxControl

GetDefaultEvent

public StiEvent GetDefaultEvent()

Gets default event for this report control.

Specified by:

GetDefaultEvent in interface IStiReportControl

Overrides:

GetDefaultEvent in class StiReportControl

Returns:

Default event.

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiReportControl

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiReportControl

Throws:

JSONException