ImageControl
AriaControlProperties Functions
| addAriaCustomAttribute | ImageControl.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | ImageControl.getAriaCustomAttributes( ) | Returns a comma separated list of the ARIA custom attributes for the control. |
| setAriaCustomAttributes | ImageControl.setAriaCustomAttributes( ariaCustomAttributes ) | Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value. |
| getAriaDescribedBy | ImageControl.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | ImageControl.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | ImageControl.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the ARIA label text. |
| getAriaRole | ImageControl.getAriaRole( ) | Returns the ARIA role for the control. |
| setAriaRole | ImageControl.setAriaRole( role ) | Sets the ARIA role for the control. |
| removeAriaCustomAttribute | ImageControl.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
Control Functions
| addCssClass | ImageControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | ImageControl.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 | ImageControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | ImageControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | ImageControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | ImageControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | ImageControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | ImageControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | ImageControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | ImageControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | ImageControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | ImageControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | ImageControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | ImageControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | ImageControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | ImageControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | ImageControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | ImageControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | ImageControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | ImageControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | ImageControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | ImageControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | ImageControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | ImageControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | ImageControl.isNewLine( ) | Returns the new line property. |
| setNewLine | ImageControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | ImageControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | ImageControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | ImageControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | ImageControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | ImageControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | ImageControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | ImageControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | ImageControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | ImageControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | ImageControl.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 | ImageControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | ImageControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | ImageControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | ImageControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | ImageControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | ImageControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
ImageControlProperties Functions
| getAlternativeText | ImageControl.getAlternativeText( ) | Returns the com.ebasetech.xi.api.Text object for the image alternate text. |
| isDisplayAsHyperlink | ImageControl.isDisplayAsHyperlink( ) | Returns true if the image should behave as a hyperlink when clicked, otherwise returns false. |
| setDisplayAsHyperlink | ImageControl.setDisplayAsHyperlink( displayAsHyperlink ) | Sets whether or not the image should behave as a hyperlink when clicked,. |
| getHyperlinkTarget | ImageControl.getHyperlinkTarget( ) | Returns the target window id or frame id in which the hyperlink URL is displayed. |
| setHyperlinkTarget | ImageControl.setHyperlinkTarget( hyperlinkTarget ) | Sets the target window id or frame id in which the hyperlink URL is displayed. |
| getHyperlinkURL | ImageControl.getHyperlinkURL( ) | Returns the hyperlink URL activated when the displayAsHyperlink property is set to true. |
| setHyperlinkURL | ImageControl.setHyperlinkURL( hyperlinkURL ) | Sets the hyperlink URL activated when the displayAsHyperlink property is set to true. |
| getImageURL | ImageControl.getImageURL( ) | Returns the URL of the image to be displayed. |
| setImageURL | ImageControl.setImageURL( imageURL ) | Sets the URL of the image to be displayed. |
| getMouseOverText | ImageControl.getMouseOverText( ) | Returns the com.ebasetech.xi.api.Text object for the mouse over text. |
| isSkipValidation | ImageControl.isSkipValidation( ) | Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the image's on click event (if configured). |
| setSkipValidation | ImageControl.setSkipValidation( skipValidation ) | Specifies whether or not validation of controls higher on the page is skipped prior to executing the image's on click event (if configured). |
ImageStyleProperties Functions
| getImageHeight | ImageControl.getImageHeight( ) | Image height. |
| setImageHeight | ImageControl.setImageHeight( imageHeight ) | Sets the image height. |
| getImageWidth | ImageControl.getImageWidth( ) | Image width. |
| setImageWidth | ImageControl.setImageWidth( imageWidth ) | Sets the image width. |
MarginStyleProperties Functions
| getAllMargin | ImageControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | ImageControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | ImageControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | ImageControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | ImageControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | ImageControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | ImageControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | ImageControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | ImageControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | ImageControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
MessageProperties Functions
| getErrorMessageStyle | ImageControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | ImageControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | ImageControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
BorderStyleProperties Functions
| getBorderColor | ImageControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | ImageControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | ImageControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | ImageControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | ImageControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | ImageControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | ImageControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | ImageControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | ImageControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | ImageControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | ImageControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | ImageControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | ImageControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | ImageControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | ImageControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | ImageControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
MessageContainer Functions
| addErrorMessage | ImageControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | ImageControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | ImageControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | ImageControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | ImageControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | ImageControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | ImageControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | ImageControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | ImageControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | ImageControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | ImageControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | ImageControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | ImageControl.getElementName( ) | Returns the element name |
| getElementType | ImageControl.getElementType( ) | Returns the element type |
Further documentation.