Provides definition for an animation playback
Constructor for a new AnimationPlayer.
The objects of this class contain necessary information to define how an animation sequence is played
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.vk.AnimationPlayer()
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Method | Description |
---|---|
attachBeforeTimeChanged |
Attaches event handler When called, the context of the event handler (its |
attachStateChanged |
Attaches event handler When called, the context of the event handler (its |
attachTimeChanged |
Attaches event handler When called, the context of the event handler (its |
attachViewActivated |
Attaches event handler When called, the context of the event handler (its |
detachBeforeTimeChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachStateChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTimeChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachViewActivated |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.AnimationPlayer.extend |
Creates a new subclass of class sap.ui.vk.AnimationPlayer with name
|
fireBeforeTimeChanged |
Fires event beforeTimeChanged to attached listeners. |
fireStateChanged |
Fires event stateChanged to attached listeners. |
fireTimeChanged |
Fires event timeChanged to attached listeners. |
fireViewActivated |
Fires event viewActivated to attached listeners. |
getAnimatedProperty |
Get the animated property of a node at the current time, should be called after setTime. |
getCurrentPlayback |
Gets animation playback currently playing. |
getCurrentPlaybackTime |
Gets current animation time position in the current animation playback. |
sap.ui.vk.AnimationPlayer.getMetadata |
Returns a metadata object for class sap.ui.vk.AnimationPlayer. |
getStartTime |
Gets start time for specified animation playback. |
getTime |
Gets current absolute animation time position. |
getTotalDuration |
Gets current total animation duration. |
getViewStateManager |
ID of the element which is the current target of the association viewStateManager, or |
play |
Starts playing animation from the current time position. |
setTime |
Moves animation to a specified time. |
setViewStateManager |
Sets the associated viewStateManager. |
stop |
Stops playing animation. |
Attaches event handler fnFunction
to the beforeTimeChanged event of this sap.ui.vk.AnimationPlayer
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.AnimationPlayer
itself.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the stateChanged event of this sap.ui.vk.AnimationPlayer
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.AnimationPlayer
itself.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the timeChanged event of this sap.ui.vk.AnimationPlayer
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.AnimationPlayer
itself.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the viewActivated event of this sap.ui.vk.AnimationPlayer
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.AnimationPlayer
itself.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the beforeTimeChanged event of this sap.ui.vk.AnimationPlayer
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the stateChanged event of this sap.ui.vk.AnimationPlayer
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the timeChanged event of this sap.ui.vk.AnimationPlayer
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the viewActivated event of this sap.ui.vk.AnimationPlayer
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.vk.AnimationPlayer with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.core.Element.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event beforeTimeChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event stateChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event timeChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event viewActivated to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Get the animated property of a node at the current time, should be called after setTime.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRef | any |
A node reference |
|
property | sap.ui.vk.AnimationTrackType |
A property name |
Returns a metadata object for class sap.ui.vk.AnimationPlayer.
Gets start time for specified animation playback.
Param | Type | DefaultValue | Description |
---|---|---|---|
playback | sap.ui.vk.AnimationPlayback int |
Animation playback or animation playback index in the current view. |
ID of the element which is the current target of the association viewStateManager, or null
.
Moves animation to a specified time.
Param | Type | DefaultValue | Description |
---|---|---|---|
time | float |
Time to set |
|
playbackIndex | int |
Optional, when specified, |
|
blockTimeChangeEvents | boolean |
Optional, block the beforeTimeChanged and timeChanged events |
Sets the associated viewStateManager.
Param | Type | DefaultValue | Description |
---|---|---|---|
oViewStateManager | sap.ui.core.ID sap.ui.vk.ViewStateManagerBase |
ID of an element which becomes the new target of this viewStateManager association; alternatively, an element instance may be given |