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