PageControl
PageControl Functions
| getAlignment | PageControl.getAlignment( ) | Specifies the horizontal alignment for the entire page within the browser window. |
| setAlignment | PageControl.setAlignment( alignment ) | Sets the horizontal alignment for the entire page within the browser window. |
| getContentClass | PageControl.getContentClass( ) | Returns the list of CSS classes applied to the page content. |
| setContentClass | PageControl.setContentClass( contentClass ) | Sets one or more CSS classes to be applied to the page content. |
| getContentsBackgroundProperties | PageControl.getContentsBackgroundProperties( ) | Background properties for the page contents. |
| getContentsBorderProperties | PageControl.getContentsBorderProperties( ) | Border properties for the page contents. |
| getContentsHeight | PageControl.getContentsHeight( ) | The height of the page contents area. |
| setContentsHeight | PageControl.setContentsHeight( contentsHeight ) | Sets the height of the page contents area. |
| getContentsTextProperties | PageControl.getContentsTextProperties( ) | The default text properties for the page. |
| getContentStyle | PageControl.getContentStyle( ) | Returns the inline CSS style applied to the page content. |
| setContentStyle | PageControl.setContentStyle( contentStyle ) | Sets the inline CSS style to be applied to the page content. |
| getFormHeaderProperties | PageControl.getFormHeaderProperties( ) | Form header properties. |
| getFormPanelWidth | PageControl.getFormPanelWidth( ) | Form panel width. |
| setFormPanelWidth | PageControl.setFormPanelWidth( formPanelWidth ) | Sets the form panel width. |
| getJSPBottom | PageControl.getJSPBottom( ) | The URL of the bottom JSP relative to the document root of the Ebase web application. |
| setJSPBottom | PageControl.setJSPBottom( jSPBottom ) | Sets the URL of the bottom JSP relative to the document root of the Ebase web application. |
| getJSPLeft | PageControl.getJSPLeft( ) | The URL of the left JSP relative to the document root of the Ebase web application. |
| setJSPLeft | PageControl.setJSPLeft( jSPLeft ) | Sets the URL of the left JSP relative to the document root of the Ebase web application. |
| getJSPLeftWidth | PageControl.getJSPLeftWidth( ) | Left JSP width. |
| setJSPLeftWidth | PageControl.setJSPLeftWidth( jSPLeftWidth ) | Sets the left JSP width. |
| getJSPRight | PageControl.getJSPRight( ) | The URL of the right JSP relative to the document root of the Ebase web application. |
| setJSPRight | PageControl.setJSPRight( jSPRight ) | Sets the URL of the right JSP relative to the document root of the Ebase web application. |
| getJSPRightWidth | PageControl.getJSPRightWidth( ) | Right JSP width. |
| setJSPRightWidth | PageControl.setJSPRightWidth( jSPRightWidth ) | Sets the right JSP width. |
| getJSPTop | PageControl.getJSPTop( ) | The URL of the top JSP relative to the document root of the Ebase web application. |
| setJSPTop | PageControl.setJSPTop( jSPTop ) | Sets the URL of the top JSP relative to the document root of the Ebase web application. |
| getPdfBorder | PageControl.getPdfBorder( ) | Returns the inline CSS style applied to any configured PDF borders when a page is included in a PDF. |
| setPdfBorder | PageControl.setPdfBorder( pdfBorder ) | Sets the inline CSS style to be applied to any configured PDF borders when a page is included in a PDF. |
| getPdfFooterMarginTextClass | PageControl.getPdfFooterMarginTextClass( ) | Returns the list of CSS classes applied to the PDF footer text when a page is included in a PDF. |
| setPdfFooterMarginTextClass | PageControl.setPdfFooterMarginTextClass( pdfFooterMarginTextClass ) | Sets one or more CSS classes to be applied to the PDF footer text when a page is included in a PDF. |
| getPdfFooterMarginTextStyle | PageControl.getPdfFooterMarginTextStyle( ) | Returns the inline CSS style applied to the PDF footer text when a page is included in a PDF. |
| setPdfFooterMarginTextStyle | PageControl.setPdfFooterMarginTextStyle( pdfFooterMarginTextStyle ) | Sets the inline CSS style to be applied to the PDF footer text when a page is included in a PDF. |
| getPdfFooterText | PageControl.getPdfFooterText( ) | Returns the com.ebasetech.xi.api.Text object for the PDF footer text when a page is included in a PDF. |
| getPdfHeaderMarginTextClass | PageControl.getPdfHeaderMarginTextClass( ) | Returns the list of CSS classes applied to the PDF header text when a page is included in a PDF. |
| setPdfHeaderMarginTextClass | PageControl.setPdfHeaderMarginTextClass( pdfHeaderMarginTextClass ) | Sets one or more CSS classes to be applied to the PDF header text when a page is included in a PDF. |
| getPdfHeaderMarginTextStyle | PageControl.getPdfHeaderMarginTextStyle( ) | Returns the inline CSS style applied to the PDF header text when a page is included in a PDF. |
| setPdfHeaderMarginTextStyle | PageControl.setPdfHeaderMarginTextStyle( pdfHeaderMarginTextStyle ) | Sets the inline CSS style to be applied to the PDF header text when a page is included in a PDF. |
| getPdfHeaderText | PageControl.getPdfHeaderText( ) | Returns the com.ebasetech.xi.api.Text object for the PDF header text when a page is included in a PDF. |
| getPdfMargin | PageControl.getPdfMargin( ) | Returns the inline CSS style applied to any configured PDF margins when a page is included in a PDF. |
| setPdfMargin | PageControl.setPdfMargin( pdfMargin ) | Sets the inline CSS style to be applied to any configured PDF margins when a page is included in a PDF. |
| getPdfOrientation | PageControl.getPdfOrientation( ) | Returns the PDF orientation, portrait or landscape, when a page is included in a PDF. |
| setPdfOrientation | PageControl.setPdfOrientation( pdfOrientation ) | Sets the PDF orientation when a page is included in a PDF. |
| getPdfPageSize | PageControl.getPdfPageSize( ) | Returns the PDF page size when a page is included in a PDF. |
| setPdfPageSize | PageControl.setPdfPageSize( pdfPageSize ) | Sets the PDF page size when a page is included in a PDF. |
| getPDFPageStyleProperties | PageControl.getPDFPageStyleProperties( ) | Styling properties that apply only when the page is printed to a PDF. |
| getWidth | PageControl.getWidth( ) | Page width. |
| setWidth | PageControl.setWidth( width ) | Sets the width for the page including any configured JSPs. |
BackgroundStyleProperties Functions
| getBackgroundColor | PageControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | PageControl.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 | PageControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | PageControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | PageControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | PageControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | PageControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | PageControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BootstrapContainerTypeProperties Functions
| getBootstrapContainerType | PageControl.getBootstrapContainerType( ) | Returns the bootstrap root container type which is applied to the root div on the page when a form is running with the bootstrap framework configured. |
| setBootstrapContainerType | PageControl.setBootstrapContainerType( bootstrapContainerType ) | Sets the bootstrap root container type which is applied to the root div on the page when a form is running with the bootstrap framework configured. |
BorderStyleProperties Functions
| getBorderColor | PageControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | PageControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | PageControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | PageControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | PageControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | PageControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | PageControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | PageControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | PageControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | PageControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | PageControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | PageControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | PageControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | PageControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | PageControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | PageControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
LayoutControl Functions
| getLayout | PageControl.getLayout( ) | Returns the Layout object configured for the container control or null if no layout is configured. |
| getLayoutType | PageControl.getLayoutType( ) | Returns a String representing the layout type for the container. |
ContainerControl Functions
| getChildControls | PageControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MessageProperties Functions
| getErrorMessageStyle | PageControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | PageControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | PageControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
Control Functions
| addCssClass | PageControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | PageControl.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 | PageControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | PageControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | PageControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | PageControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | PageControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | PageControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | PageControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | PageControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | PageControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | PageControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | PageControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | PageControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | PageControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | PageControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | PageControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | PageControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | PageControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | PageControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | PageControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | PageControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | PageControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | PageControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | PageControl.isNewLine( ) | Returns the new line property. |
| setNewLine | PageControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | PageControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | PageControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | PageControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | PageControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | PageControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | PageControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | PageControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | PageControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | PageControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | PageControl.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 | PageControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | PageControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | PageControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | PageControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | PageControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | PageControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | PageControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | PageControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | PageControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | PageControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | PageControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | PageControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | PageControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | PageControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | PageControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | PageControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | PageControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | PageControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | PageControl.getElementName( ) | Returns the element name |
| getElementType | PageControl.getElementType( ) | Returns the element type |
Further documentation.