TextControl
TextControl Functions
| getText | TextControl.getText( ) | Returns the com.ebasetech.xi.api.Text object for the text. |
BackgroundStyleProperties Functions
| getBackgroundColor | TextControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | TextControl.setBackgroundColor( backgroundColor ) | Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used. |
| getBackgroundImage | TextControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | TextControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | TextControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | TextControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | TextControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | TextControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | TextControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | TextControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | TextControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | TextControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | TextControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | TextControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | TextControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | TextControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | TextControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | TextControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | TextControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | TextControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | TextControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | TextControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | TextControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | TextControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
Control Functions
| addCssClass | TextControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | TextControl.getAll( ) | Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page. |
| isContainer | TextControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | TextControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | TextControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | TextControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | TextControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | TextControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | TextControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | TextControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | TextControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | TextControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | TextControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | TextControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | TextControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | TextControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | TextControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | TextControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | TextControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | TextControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | TextControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | TextControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | TextControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | TextControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | TextControl.isNewLine( ) | Returns the new line property. |
| setNewLine | TextControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | TextControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | TextControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | TextControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | TextControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | TextControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | TextControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | TextControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | TextControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | TextControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | TextControl.isShowing( ) | Returns true if the control will be included in the web page when it's next displayed to the user, otherwise returns false. |
| getStyle | TextControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | TextControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | TextControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | TextControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | TextControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | TextControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MarginStyleProperties Functions
| getAllMargin | TextControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | TextControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | TextControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | TextControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | TextControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | TextControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | TextControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | TextControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | TextControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | TextControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | TextControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | TextControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | TextControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | TextControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | TextControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | TextControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | TextControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | TextControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | TextControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | TextControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | TextControl.getLineHeight( ) | Line height. |
| setLineHeight | TextControl.setLineHeight( lineHeight ) | Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used. |
| getTextBold | TextControl.getTextBold( ) | Text bold setting. |
| setTextBold | TextControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | TextControl.getTextColor( ) | Text color. |
| setTextColor | TextControl.setTextColor( textColor ) | Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used. |
| getTextDecoration | TextControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | TextControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | TextControl.getTextFont( ) | List of text fonts. |
| setTextFont | TextControl.setTextFont( textFont ) | Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used. |
| getTextItalic | TextControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | TextControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | TextControl.getTextSize( ) | Text size. |
| setTextSize | TextControl.setTextSize( textSize ) | Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used. |
MessageContainer Functions
| addErrorMessage | TextControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | TextControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | TextControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | TextControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | TextControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | TextControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | TextControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | TextControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | TextControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | TextControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | TextControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | TextControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | TextControl.getElementName( ) | Returns the element name |
| getElementType | TextControl.getElementType( ) | Returns the element type |
Further documentation.