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