IFrameControl
IFrameControl Functions
| getHeight | IFrameControl.getHeight( ) | Panel height. |
| setHeight | IFrameControl.setHeight( height ) | Sets the IFrame height, and is equivalent to the CSS height property and any valid value for this CSS property can be used. |
| getName | IFrameControl.getName( ) | |
| setName | IFrameControl.setName( name ) | Set the target name attribute for the IFrame element |
| getReferrerPolicy | IFrameControl.getReferrerPolicy( ) | |
| setReferrerPolicy | IFrameControl.setReferrerPolicy( referrerPolicy ) | Set the referer policy attribute for the IFrame element. |
| isSandbox | IFrameControl.isSandbox( ) | The sandbox attribute enables an extra set of restriction for the content in the frame |
| setSandbox | IFrameControl.setSandbox( sandbox ) | Set the sandbox attribute which enables an extra set of restriction for the content in the frame |
| getSandboxExceptions | IFrameControl.getSandboxExceptions( ) | |
| setSandboxExceptions | IFrameControl.setSandboxExceptions( sandboxExceptions ) | Set space separated list of exceptions for the sandbox mode. |
| getSrc | IFrameControl.getSrc( ) | |
| setSrc | IFrameControl.setSrc( src ) | Set src url of the IFrame |
| getTitle | IFrameControl.getTitle( ) | |
| getWidth | IFrameControl.getWidth( ) | IFrame width This is equivalent to the CSS width property, and any valid value for this CSS property can be used when setting a value. |
| setWidth | IFrameControl.setWidth( width ) | Set width of the IFrame element. |
BorderStyleProperties Functions
| getBorderColor | IFrameControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | IFrameControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | IFrameControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | IFrameControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | IFrameControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | IFrameControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | IFrameControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | IFrameControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | IFrameControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | IFrameControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | IFrameControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | IFrameControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | IFrameControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | IFrameControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | IFrameControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | IFrameControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
Control Functions
| addCssClass | IFrameControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | IFrameControl.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 | IFrameControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | IFrameControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | IFrameControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | IFrameControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | IFrameControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | IFrameControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | IFrameControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | IFrameControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | IFrameControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | IFrameControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | IFrameControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | IFrameControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | IFrameControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | IFrameControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | IFrameControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | IFrameControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | IFrameControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | IFrameControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | IFrameControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | IFrameControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | IFrameControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | IFrameControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | IFrameControl.isNewLine( ) | Returns the new line property. |
| setNewLine | IFrameControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | IFrameControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | IFrameControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | IFrameControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | IFrameControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | IFrameControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | IFrameControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | IFrameControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | IFrameControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | IFrameControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | IFrameControl.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 | IFrameControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | IFrameControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | IFrameControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | IFrameControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | IFrameControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | IFrameControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MarginStyleProperties Functions
| getAllMargin | IFrameControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | IFrameControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | IFrameControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | IFrameControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | IFrameControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | IFrameControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | IFrameControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | IFrameControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | IFrameControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | IFrameControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
MessageProperties Functions
| getErrorMessageStyle | IFrameControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | IFrameControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | IFrameControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
MessageContainer Functions
| addErrorMessage | IFrameControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | IFrameControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | IFrameControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | IFrameControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | IFrameControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | IFrameControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | IFrameControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | IFrameControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | IFrameControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | IFrameControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | IFrameControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | IFrameControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | IFrameControl.getElementName( ) | Returns the element name |
| getElementType | IFrameControl.getElementType( ) | Returns the element type |