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