jQuery/JS Common - utils

To avoid defining animations each time you animate an element(s), register different animations in the DevExtreme.animationPresets repository and request them by associated names when required. This repository has a built-in set of animations. Here they are:

• fade
• stagger-fade
• slide
• stagger-slide
• ios7-slide
• overflow
• ios7-toolbar
• stagger-smooth-drop
• stagger-drop
• stagger-3d-drop

To populate the animationPresets repository with your animations, use the registerPreset(name, config) method. To get the required animation from the repository, use the getPreset(name) method.

DevExpress.config({ rtlEnabled: true, forceIsoDateParsing: false, //... });

When building a mobile application, you should initiate processing of the hardware back button click. The following code demonstrates how to do this by calling the processHardwareBackButton() method within the event listener of the PhoneGap backbutton event.

$(function() {
    document.addEventListener("deviceready", onDeviceReady, false);
    function onDeviceReady() {
        //...
        document.addEventListener("backbutton", onBackButton, false);
    }
    function onBackButton() {
        DevExpress.processHardwareBackButton();
    }    
    //...    
}

To handle the back button click, subscribe to the HtmlApplication.navigatingBack() event and use the isHardwareButton event handler parameter within the handling function.

The most common scenario is to switch the entire application/site to a right-to-left representation. In this instance, use the DevExpress.rtlEnabled field. When this option is set to true, applications built using the DevExtreme framework and sites based on DevExtreme widgets will have a right-to-left reading order, mirroring of UI elements and reversed transition animation. If you need to switch the display of each DevExtreme component used within the application/site to a right-to-left representation, use a specifically designed configuration option - rtlEnabled.

While there are scenarios when animating certain elements is required, there can be more complex scenarios when you need to perform a transition - several animations of different elements performed simultaneously. For instance, when you navigate from a view to another view in a mobile application, the content of the new view replaces the content of the old view. Moreover, the header can be animated differently from the rest of the content on both views. Thus, four different animations must be performed simultaneously. To simplify the implementation of such scenarios, the TransitionExecutor is implemented.

To register the set of animations to be performed simultaneously, use the enter(elements, animation) and leave(elements, animation) methods of the TransitionExecutor object. Use the enter(elements, animation) method to specify the elements that should appear ("enter") on the page with a specified animation. The leave(elements, animation) method should be called if there are elements that must disappear ("leave") from the page.

The TransitionExecutor object is also useful when a need arises to perform a staggered animation of elements when elements are animated with a slight delay after animation of each successive element starts resulting in a curtain-like effect. In this instance, each element should be registered with by the enter(elements, animation)/leave(elements, animation) method with the animation configuration where the staggerDelay option is specified.

To start a transition, call the start() method of the TransitionExecutor object. To clear the registered set of animations in the TransitionExecutor object, call the reset() method.