Adobe Experience Viewers HTML5 SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.event

Class s7sdk.event.CapabilityStateEvent

Dispatched whenever the component capability is changed. It is typically used to toggle between the enabled/disabled states of buttons to indicate availability of certain actions, like zooming for images or play/pause for video.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.event.CapabilityStateEvent(type, state, bubbles)
Field Summary
Field Attributes Field Name and Description
 
Specifies whether the event should bubble.
<static> <constant>  
s7sdk.event.CapabilityStateEvent.NOTF_CAROUSELVIEW_CAPABILITY_STATE
Defines the value of the type property of a notfCarouselViewCapabilityState event object.
<static> <constant>  
s7sdk.event.CapabilityStateEvent.NOTF_SPIN_CAPABILITY_STATE
Defines the value of the type property of a notfSpinCapabilityState event object.
<static> <constant>  
s7sdk.event.CapabilityStateEvent.NOTF_VIDEO_CAPABILITY_STATE
Defines the value of the type property of a notfVideoCapabilityState event object.
<static> <constant>  
s7sdk.event.CapabilityStateEvent.NOTF_ZOOM_CAPABILITY_STATE
Defines the value of the type property of a notfZoomCapabilityState event object.
 
The CapabilityState of the component.
 
The type of the particular event object.
Class Detail
s7sdk.event.CapabilityStateEvent(type, state, bubbles)
Parameters:
{String} type
Defines the value of the type property.
{s7sdk.CapabilityState} state
The capability state associated with this event.
{Boolean} bubbles
Defines whether the event bubbles.
See:
s7sdk.image.ZoomView
s7sdk.set.SpinView
s7sdk.video.VideoPlayer
Field Detail
{Boolean} bubbles
Specifies whether the event should bubble.

<static> <constant> {String} s7sdk.event.CapabilityStateEvent.NOTF_CAROUSELVIEW_CAPABILITY_STATE
Defines the value of the type property of a notfCarouselViewCapabilityState event object. This type is dispatched when the CarouselView capability state has changed. In this case the event state will be an instance of the CarouselViewCapabilityState.
See:
s7sdk.CarouselViewCapabilityState
Default Value:
notfCarouselViewCapabilityState

<static> <constant> {String} s7sdk.event.CapabilityStateEvent.NOTF_SPIN_CAPABILITY_STATE
Defines the value of the type property of a notfSpinCapabilityState event object. This type is dispatched when the SpinView capability state has changed. In this case the event state will be an instance of the SpinCapabilityState.
See:
s7sdk.SpinCapabilityState
Default Value:
notfSpinCapabilityState

<static> <constant> {String} s7sdk.event.CapabilityStateEvent.NOTF_VIDEO_CAPABILITY_STATE
Defines the value of the type property of a notfVideoCapabilityState event object. This type is dispatched when the VideoPlayer capability state has changed. In this case the event state will be an instance of the VideoCapabilityState.
See:
s7sdk.VideoCapabilityState
Default Value:
notfVideoCapabilityState

<static> <constant> {String} s7sdk.event.CapabilityStateEvent.NOTF_ZOOM_CAPABILITY_STATE
Defines the value of the type property of a notfZoomCapabilityState event object. This type is dispatched when the ZoomView capability state has changed. In this case the event state will be an instance of the ZoomCapabilityState.
See:
s7sdk.ZoomCapabilityState
Default Value:
notfZoomCapabilityState

{s7sdk.CapabilityState} state
The CapabilityState of the component. The actual type will differ based on the event type. For example, if the event type is NOTF_SPIN_CAPABILITY_STATE the state will be in instance of the SpinCapabilityState.
See:
s7sdk.ZoomCapabilityState
s7sdk.SpinCapabilityState

{String} type
The type of the particular event object.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed May 15 2024 09:55:07 GMT-0000 (UTC)