Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level and inheritance. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Sencha Touch 2.4

Guides
API
top

Using Device Features in Your Touch App

In this guide, we will walk through the process of creating a simple native Sencha Touch application that can access an Android device's photo library and camera. Within the application, you may:

  • Select an image from the photo library
  • Take a new picture using the camera.

The resulting image will then appear in the application's main panel.

Note: This guide only applies to Androids using Cordova.

Prerequisites

The following tools must be installed before proceeding:

Generate Your Touch application

Open your CLI and generate a starter application with Sencha Cmd by issuing the following:

sencha -sdk /path/to/sdk generate app touchCamera /target/app/directory

Note: Please utilize 'touchCamera' as your application name or be prepared to modify the provided code as needed.

Update Application with Example Code

Using your editor of choice, replace the contents of the "app/view/Main.js" file in your application's view directory. Your new code should look like this:

Ext.define('touchCamera.view.Main', {
    extend: 'Ext.Panel',
    xtype: 'main',
    requires: [
        'Ext.Button',
        'Ext.Img'
    ],
    config: {
        layout: {
            type:"vbox",
            pack:"center",
            align:"center"
        },
        items: [{
            xtype: 'titlebar',
            docked: 'top',
            title: 'Native API Examples'
        }, {
            xtype: "image",
            src: "http://placehold.it/200x200",
            width: '100%',
            height: '100%'
        }, {
            xtype: 'toolbar',
            docked: 'bottom',
            items: [{
                xtype: "button",
                text: "Photo Library",
                handler: function(btn) {
                    var panel = btn.up('panel');

                    panel.getPhoto(navigator.camera.PictureSourceType.PHOTOLIBRARY);
                }
            }, {
                xtype: "button",
                text: "Take Photo",
                handler: function(btn) {
                    var panel = btn.up('panel');

                    panel.getPhoto(navigator.camera.PictureSourceType.CAMERA);
                }
            }]
        }]
    },

    getPhoto: function(source) {
        var me = this;

        navigator.camera.getPicture(me.success, me.failure, {
            quality: 50,
            destinationType: navigator.camera.DestinationType.FILE_URI,
            sourceType: source 
        });

    },

    success: function(image_uri) {
        var img = Ext.ComponentQuery.query("image")[0];
        img.setSrc(image_uri);
    },

    failure: function(message) {
        alert("Failed" + message);
    }
});

Create & Set Up the Cordova Environment

The next step is to create a Cordova project in the application folder. Cordova can access the native Android APIs so that the application can interact with the device photo library and camera.

  1. Change to the directory in which the application was generated by ‘sencha generate app’.

     cd /target/app/directory
    
  2. Create a Cordova project in your application directory.

     sencha cordova init
    

    You should now see that a Cordova directory has been created in your application's directory. The default configuration files created for the project will be need to be updated as per the device APIs your application needs to access. You must also include the device permissions needed for your application to function properly.

    This process also updates the app.json file in your application to include a "builds" configuration block. This block needs to be updated to reflect the build type your application is creating.

  3. Edit app.json file and update the "builds" block to look like the following example.

    Note: In the case below, we are specifying a new build target of ‘android’ that will use the Cordova packager and run on an android platform:

         "builds": {
            "web": {"default": true},
            "android": { // This can be any build target name you desire (eg myApp, apple, etc)
                 "packager": "cordova", // Specify that we are using cordova to package the app
                 "cordova" : { // configuration for cordova build
                     "config": {
                          "id": "com.domain.touchCamera",  // namespace of application (required)
                          "name": "touchCamera",  // app name which appears under the icon on device
                          "platforms": "android" // add platform(s) here
                     }
                }
             }
         },
    
  4. CD into the "cordova" directory

     cd cordova
    
  5. Each API that is used in the application requires its corresponding plugin is added to the project. In this example, the camera is used. To add the camera plugin, issue the following command in the "cordova" directory :

     cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git 
    
  6. Verify that the plugin has been added to the "cordova" project:

     cordova plugin list 
     //org.apache.cordova.camera 0.3.4-dev "Camera"
    
  7. Next, let's tell Cordova that the application will be using the camera plugin by adding the following information to the config.xml file:

     <feature name="Camera"> 
         <param name="android-package" value="org.apache.cordova.camera.CameraLauncher" /> 
     </feature> 
    
  8. Add write permissions to the AndroidManifest.xml file found in "cordova/platforms/android" so the camera can save pictures to the device. The following line will need to be added to the file directly after line regarding android.permission.INTERNET.

     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> 
    

Build your Android Package

Once the configuration files have been updated with the appropriate permissions and feature information, change back to the primary application directory and build the application:

cd ..
sencha app build android

A successful build will result in the creation of an Android Package (APK) found here:

cordova/platforms/android/ant-build

You can verify its existence with the following command:

find . name -name *.apk
//./cordova/platforms/android/ant-build/touchCamera-debug-unaligned.apk
//./cordova/platforms/android/ant-build/touchCamera-debug.apk

Connecting the Device

Prior to installation, please make sure that the:

  • Android device is connected
  • Android debugging has been enabled
  • Android device has been authorized for the computer to which it is connected.

Next, ensure that the development computer can see the attached Android device by issuing the following command:

adb devices
//* daemon not running. starting it now on port 5037 *
//* daemon started successfully *
//List of devices attached 
//015d262e99100202    device

The above output shows one Android device connected to a computer.

Note: Your device number will be different than the one found above.

If you do not see a device listed, please check your connection, device permissions, and debugging status. Installing the Application

Move the package to the Android device by issuing the following command:

$ adb install -r cordova/platforms/android/ant-build/touchCamera-debug.apk 
//1284 KB/s (2446896 bytes in 1.860s)
//pkg: /data/local/tmp/touchCamera-debug.apk
//Success

Launch the Touch Application

If the previous adb install command executed successfully, the Touch application will appear in the apps section of the Android device. The standard Cordova icon will appear and the name under the icon will be touchCamera. Tap the icon to launch the Touch application.

The application will have two buttons at the bottom of the screen. The first opens the photo library and second launches the camera.

Touch either button to see the app in action. After returning from either the photo library or camera, the selected picture will appear in the image block in the middle of the application.

Sencha Touch 2.4

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.0 EA 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation