AudioControl
Control Functions
| addCssClass | AudioControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | AudioControl.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 | AudioControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | AudioControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | AudioControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | AudioControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | AudioControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | AudioControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | AudioControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | AudioControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | AudioControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | AudioControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | AudioControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | AudioControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | AudioControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | AudioControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | AudioControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | AudioControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | AudioControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | AudioControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | AudioControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | AudioControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | AudioControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | AudioControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | AudioControl.isNewLine( ) | Returns the new line property. |
| setNewLine | AudioControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | AudioControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | AudioControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | AudioControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | AudioControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | AudioControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | AudioControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | AudioControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | AudioControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | AudioControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | AudioControl.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 | AudioControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | AudioControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | AudioControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | AudioControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | AudioControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | AudioControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MultimediaControlProperties Functions
| isAutoplay | AudioControl.isAutoplay( ) | Returns whether the embedded content will automatically play as soon as it loaded. |
| setAutoplay | AudioControl.setAutoplay( autoplay ) | Sets whether the embedded content will automatically play as soon as it loaded. |
| getHeight | AudioControl.getHeight( ) | multimedia player height. |
| setHeight | AudioControl.setHeight( imageHeight ) | Sets the multimedia player height. |
| isLoop | AudioControl.isLoop( ) | Returns whether the multimedia player will automatically restart upon reaching the end of the content. |
| setLoop | AudioControl.setLoop( loop ) | Sets whether the multimedia player will automatically restart upon reaching the end of the content. |
| isMuted | AudioControl.isMuted( ) | Returns whether the multimedia player will initially be silenced. |
| setMuted | AudioControl.setMuted( loop ) | Sets whether the multimedia player will initially be silenced. |
| isShowControls | AudioControl.isShowControls( ) | Returns whether the browser will offer controls to allow the user to control the multimedia playback. |
| setShowControls | AudioControl.setShowControls( controls ) | Sets whether the browser will offer controls to allow the user to control the multimedia playback. |
| getSrc | AudioControl.getSrc( ) | The URL of the multimedia content to embed. |
| setSrc | AudioControl.setSrc( src ) | Sets the URL of the multimedia content to embed. |
| getText | AudioControl.getText( ) | Returns the com.ebasetech.xi.api.Text object for the multimedia text. |
| getTitle | AudioControl.getTitle( ) | Returns the com.ebasetech.xi.api.Text object for the title text. |
| getWidth | AudioControl.getWidth( ) | multimedia player width. |
| setWidth | AudioControl.setWidth( imageWidth ) | Sets the multimedia player width. |
AriaControlProperties Functions
| addAriaCustomAttribute | AudioControl.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | AudioControl.getAriaCustomAttributes( ) | Returns a comma separated list of the ARIA custom attributes for the control. |
| setAriaCustomAttributes | AudioControl.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 | AudioControl.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | AudioControl.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | AudioControl.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the ARIA label text. |
| getAriaRole | AudioControl.getAriaRole( ) | Returns the ARIA role for the control. |
| setAriaRole | AudioControl.setAriaRole( role ) | Sets the ARIA role for the control. |
| removeAriaCustomAttribute | AudioControl.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
BorderStyleProperties Functions
| getBorderColor | AudioControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | AudioControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | AudioControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | AudioControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | AudioControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | AudioControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | AudioControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | AudioControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | AudioControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | AudioControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | AudioControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | AudioControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | AudioControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | AudioControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | AudioControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | AudioControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
MarginStyleProperties Functions
| getAllMargin | AudioControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | AudioControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | AudioControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | AudioControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | AudioControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | AudioControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | AudioControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | AudioControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | AudioControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | AudioControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
MessageProperties Functions
| getErrorMessageStyle | AudioControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | AudioControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | AudioControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
MessageContainer Functions
| addErrorMessage | AudioControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | AudioControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | AudioControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | AudioControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | AudioControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | AudioControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | AudioControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | AudioControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | AudioControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | AudioControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | AudioControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | AudioControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | AudioControl.getElementName( ) | Returns the element name |
| getElementType | AudioControl.getElementType( ) | Returns the element type |
Further documentation