TitlePanelControl
TitlePanelControl Functions
| getContentHeight | TitlePanelControl.getContentHeight( ) | Height of the content area. |
| setContentHeight | TitlePanelControl.setContentHeight( contentHeight ) | Sets the content area height. |
| getContentPadding | TitlePanelControl.getContentPadding( ) | Padding properties for the content area - the space between the content area and its border. |
| getContentText | TitlePanelControl.getContentText( ) | Text properties for the content area. |
| getImageAltText | TitlePanelControl.getImageAltText( ) | Returns the com.ebasetech.xi.api.Text object for the title bar image alternatetext. |
| getImageClass | TitlePanelControl.getImageClass( ) | Returns the list of CSS classes applied to the title bar image. |
| setImageClass | TitlePanelControl.setImageClass( imageClass ) | Sets one or more CSS classes to be applied to the title bar image. |
| getImageMouseOverText | TitlePanelControl.getImageMouseOverText( ) | Returns the com.ebasetech.xi.api.Text object for the title bar image mouse over text. |
| getImagePosition | TitlePanelControl.getImagePosition( ) | The position of the optional image relative to the text. |
| setImagePosition | TitlePanelControl.setImagePosition( imagePosition ) | Sets the position of the optional image relative to the text. |
| getImageProperties | TitlePanelControl.getImageProperties( ) | Styling properties for the optional image in the title bar. |
| getImageStyle | TitlePanelControl.getImageStyle( ) | Returns the inline CSS style applied to the title bar image. |
| setImageStyle | TitlePanelControl.setImageStyle( imageStyle ) | Sets the inline CSS style to be applied to the title bar image. |
| getImageURL | TitlePanelControl.getImageURL( ) | Returns the URL of the title bar image. |
| setImageURL | TitlePanelControl.setImageURL( imageURL ) | Sets the URL of the title bar image. |
| getPanelClass | TitlePanelControl.getPanelClass( ) | Returns the list of CSS classes applied to the content area. |
| setPanelClass | TitlePanelControl.setPanelClass( panelClass ) | Sets one or more CSS classes to be applied to the content area. |
| getPanelColor | TitlePanelControl.getPanelColor( ) | The background color for the content area. |
| setPanelColor | TitlePanelControl.setPanelColor( panelColor ) | Sets the background color for the content area. |
| getPanelCornerType | TitlePanelControl.getPanelCornerType( ) | The style of corner applied to the bottom left and bottom right corners. |
| setPanelCornerType | TitlePanelControl.setPanelCornerType( panelCornerType ) | Sets the style of corner applied to the bottom left and bottom right corners. |
| getPanelStyle | TitlePanelControl.getPanelStyle( ) | Returns the inline CSS style applied to the content area. |
| setPanelStyle | TitlePanelControl.setPanelStyle( panelStyle ) | Sets the inline CSS style to be applied to the content area. |
| getText | TitlePanelControl.getText( ) | Returns the com.ebasetech.xi.api.Text object for the title bar text. |
| getTextClass | TitlePanelControl.getTextClass( ) | Returns the list of CSS classes applied to the title bar text. |
| setTextClass | TitlePanelControl.setTextClass( textClass ) | Sets one or more CSS classes to be applied to the title bar text. |
| getTextImageGap | TitlePanelControl.getTextImageGap( ) | The gap between the title text and any optional image. |
| setTextImageGap | TitlePanelControl.setTextImageGap( textImageGap ) | Sets the gap between the title text and any optional image. |
| getTextStyle | TitlePanelControl.getTextStyle( ) | Returns the inline CSS style applied to the title bar text. |
| setTextStyle | TitlePanelControl.setTextStyle( textStyle ) | Sets the inline CSS style to be applied to the title bar text. |
| getTitlebarClass | TitlePanelControl.getTitlebarClass( ) | Returns the list of CSS classes applied to the entire title bar. |
| setTitlebarClass | TitlePanelControl.setTitlebarClass( titlebarClass ) | Sets one or more CSS classes to be applied to the entire title bar. |
| getTitlebarColor | TitlePanelControl.getTitlebarColor( ) | The background color for the title bar. |
| setTitlebarColor | TitlePanelControl.setTitlebarColor( titlebarColor ) | Sets the background color for the title bar. |
| getTitlebarCornerType | TitlePanelControl.getTitlebarCornerType( ) | The style of corner applied to the top left and top right corners. |
| setTitlebarCornerType | TitlePanelControl.setTitlebarCornerType( titlebarCornerType ) | Sets the style of corner applied to the top left and top right corners. |
| getTitleBarStyle | TitlePanelControl.getTitleBarStyle( ) | Styling properties for the title bar. |
| getTitlebarStyle | TitlePanelControl.getTitlebarStyle( ) | Returns the inline CSS style applied to the entire title bar. |
| setTitlebarStyle | TitlePanelControl.setTitlebarStyle( titlebarStyle ) | Sets the inline CSS style to be applied to the entire title bar. |
| getTitlePanelBorderColor | TitlePanelControl.getTitlePanelBorderColor( ) | Returns the color applied to the border surrounding the control, including the corners. |
| setTitlePanelBorderColor | TitlePanelControl.setTitlePanelBorderColor( titlePanelBorderColor ) | Sets the color applied to the border surrounding the control, including the corners. |
| getWidth | TitlePanelControl.getWidth( ) | Titled Panel Control width. |
| setWidth | TitlePanelControl.setWidth( width ) | Sets the width of the Titled Panel Control. |
LayoutControl Functions
| getLayout | TitlePanelControl.getLayout( ) | Returns the Layout object configured for the container control or null if no layout is configured. |
| getLayoutType | TitlePanelControl.getLayoutType( ) | Returns a String representing the layout type for the container. |
MarginStyleProperties Functions
| getAllMargin | TitlePanelControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | TitlePanelControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | TitlePanelControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | TitlePanelControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | TitlePanelControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | TitlePanelControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | TitlePanelControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | TitlePanelControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | TitlePanelControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | TitlePanelControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
ContainerControl Functions
| getChildControls | TitlePanelControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MessageProperties Functions
| getErrorMessageStyle | TitlePanelControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | TitlePanelControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | TitlePanelControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
Control Functions
| addCssClass | TitlePanelControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | TitlePanelControl.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 | TitlePanelControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | TitlePanelControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | TitlePanelControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | TitlePanelControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | TitlePanelControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | TitlePanelControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | TitlePanelControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | TitlePanelControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | TitlePanelControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | TitlePanelControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | TitlePanelControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | TitlePanelControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | TitlePanelControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | TitlePanelControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | TitlePanelControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | TitlePanelControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | TitlePanelControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | TitlePanelControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | TitlePanelControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | TitlePanelControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | TitlePanelControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | TitlePanelControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | TitlePanelControl.isNewLine( ) | Returns the new line property. |
| setNewLine | TitlePanelControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | TitlePanelControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | TitlePanelControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | TitlePanelControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | TitlePanelControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | TitlePanelControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | TitlePanelControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | TitlePanelControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | TitlePanelControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | TitlePanelControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | TitlePanelControl.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 | TitlePanelControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | TitlePanelControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | TitlePanelControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | TitlePanelControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | TitlePanelControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | TitlePanelControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | TitlePanelControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | TitlePanelControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | TitlePanelControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | TitlePanelControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | TitlePanelControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | TitlePanelControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | TitlePanelControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | TitlePanelControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | TitlePanelControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | TitlePanelControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | TitlePanelControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | TitlePanelControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | TitlePanelControl.getElementName( ) | Returns the element name |
| getElementType | TitlePanelControl.getElementType( ) | Returns the element type |
Further documentation.