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