GroupPanelControl
GroupPanelControl Functions
| getGroupHeaderText | GroupPanelControl.getGroupHeaderText( ) | Returns the com.ebasetech.xi.api.Text object for the header text. |
| getGroupInfoText | GroupPanelControl.getGroupInfoText( ) | Returns the com.ebasetech.xi.api.Text object for the information text. |
| getGroupTrailerText | GroupPanelControl.getGroupTrailerText( ) | Returns the com.ebasetech.xi.api.Text object for the trailer text. |
GroupAndPagePanelProperties Functions
| getContentClass | GroupPanelControl.getContentClass( ) | Returns the list of CSS classes applied to the content area containing child controls. |
| setContentClass | GroupPanelControl.setContentClass( contentClass ) | Sets the inline CSS style to be applied to the content area containing child controls. |
| getContentHeight | GroupPanelControl.getContentHeight( ) | Height of the content area. |
| setContentHeight | GroupPanelControl.setContentHeight( contentHeight ) | Sets the height of the content area. |
| getContentPadding | GroupPanelControl.getContentPadding( ) | Content padding properties - the space between the content and its border. |
| getContentStyle | GroupPanelControl.getContentStyle( ) | Returns the inline CSS style applied to the content area containing child controls. |
| setContentStyle | GroupPanelControl.setContentStyle( contentStyle ) | Sets the inline CSS style to be applied to the content area containing child controls. |
| getContentText | GroupPanelControl.getContentText( ) | Content text properties. |
| getHeaderClass | GroupPanelControl.getHeaderClass( ) | Returns the list of CSS classes applied to the header text. |
| setHeaderClass | GroupPanelControl.setHeaderClass( headerClass ) | Sets one or more CSS classes to be applied to the header text. |
| getHeaderProperties | GroupPanelControl.getHeaderProperties( ) | Header text properties. |
| getHeaderStyle | GroupPanelControl.getHeaderStyle( ) | Returns the inline CSS style applied to the header text. |
| setHeaderStyle | GroupPanelControl.setHeaderStyle( headerStyle ) | Sets the inline CSS style to be applied to the header text. |
| getInfoClass | GroupPanelControl.getInfoClass( ) | Returns the list of CSS classes applied to the information text. |
| setInfoClass | GroupPanelControl.setInfoClass( infoClass ) | Sets one or more CSS classes to be applied to the information text. |
| getInfoProperties | GroupPanelControl.getInfoProperties( ) | Information text properties. |
| getInfoStyle | GroupPanelControl.getInfoStyle( ) | Returns the inline CSS style applied to the information text. |
| setInfoStyle | GroupPanelControl.setInfoStyle( infoStyle ) | Sets the inline CSS style to be applied to the information text. |
| getTrailerClass | GroupPanelControl.getTrailerClass( ) | Returns the list of CSS classes applied to the trailer text. |
| setTrailerClass | GroupPanelControl.setTrailerClass( trailerClass ) | Sets one or more CSS classes to be applied to the trailer text. |
| getTrailerProperties | GroupPanelControl.getTrailerProperties( ) | Trailer text properties. |
| getTrailerStyle | GroupPanelControl.getTrailerStyle( ) | Returns the inline CSS style applied to the trailer text. |
| setTrailerStyle | GroupPanelControl.setTrailerStyle( trailerStyle ) | Sets the inline CSS style to be applied to the trailer text. |
| getWidth | GroupPanelControl.getWidth( ) | Control width. |
| setWidth | GroupPanelControl.setWidth( width ) | Sets the width of the Control. |
BackgroundStyleProperties Functions
| getBackgroundColor | GroupPanelControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | GroupPanelControl.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 | GroupPanelControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | GroupPanelControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | GroupPanelControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | GroupPanelControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | GroupPanelControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | GroupPanelControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | GroupPanelControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | GroupPanelControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | GroupPanelControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | GroupPanelControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | GroupPanelControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | GroupPanelControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | GroupPanelControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | GroupPanelControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | GroupPanelControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | GroupPanelControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | GroupPanelControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | GroupPanelControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | GroupPanelControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | GroupPanelControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | GroupPanelControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | GroupPanelControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
LayoutControl Functions
| getLayout | GroupPanelControl.getLayout( ) | Returns the Layout object configured for the container control or null if no layout is configured. |
| getLayoutType | GroupPanelControl.getLayoutType( ) | Returns a String representing the layout type for the container. |
MarginStyleProperties Functions
| getAllMargin | GroupPanelControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | GroupPanelControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | GroupPanelControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | GroupPanelControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | GroupPanelControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | GroupPanelControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | GroupPanelControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | GroupPanelControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | GroupPanelControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | GroupPanelControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
ContainerControl Functions
| getChildControls | GroupPanelControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MessageProperties Functions
| getErrorMessageStyle | GroupPanelControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | GroupPanelControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | GroupPanelControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
Control Functions
| addCssClass | GroupPanelControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | GroupPanelControl.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 | GroupPanelControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | GroupPanelControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | GroupPanelControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | GroupPanelControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | GroupPanelControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | GroupPanelControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | GroupPanelControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | GroupPanelControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | GroupPanelControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | GroupPanelControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | GroupPanelControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | GroupPanelControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | GroupPanelControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | GroupPanelControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | GroupPanelControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | GroupPanelControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | GroupPanelControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | GroupPanelControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | GroupPanelControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | GroupPanelControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | GroupPanelControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | GroupPanelControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | GroupPanelControl.isNewLine( ) | Returns the new line property. |
| setNewLine | GroupPanelControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | GroupPanelControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | GroupPanelControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | GroupPanelControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | GroupPanelControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | GroupPanelControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | GroupPanelControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | GroupPanelControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | GroupPanelControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | GroupPanelControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | GroupPanelControl.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 | GroupPanelControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | GroupPanelControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | GroupPanelControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | GroupPanelControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | GroupPanelControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | GroupPanelControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | GroupPanelControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | GroupPanelControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | GroupPanelControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | GroupPanelControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | GroupPanelControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | GroupPanelControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | GroupPanelControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | GroupPanelControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | GroupPanelControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | GroupPanelControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | GroupPanelControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | GroupPanelControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | GroupPanelControl.getElementName( ) | Returns the element name |
| getElementType | GroupPanelControl.getElementType( ) | Returns the element type |
Further documentation.