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. Note that filtering out private members also filters the API class navigation tree.

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 Web Application Manager 6.0.0

Guides
API
top

Secure Local Storage

This guide describes the Sencha Web Application Client secure local storage API and how to code your application to use this storage.

Secure local storage encrypts data before storing in a mobile device's local memory. This feature lets applications store organizational data securely. Sencha Web Application Client uses the Ext.space.Promise API to asynchronously process reads, writes, and deletes through its quick encryption and decryption mechanism.

Data in the local storage is represented as a collection of JSON key-value pairs.

Sencha Web Application Client secure local storage improves on the localstorage feature of HTML5:

  • All data is encrypted before being persisted to local storage
  • Much higher storage limits than the 2-3 MB allocated for localstorage
  • Multiple key collections per application
  • Asynchronous using Ext.space.Promise

Secure local storage uses these APIs:

Ext.space.Promise

A promise registers callbacks to receive after the operation completes. This provides the eventual result of an asynchronlus operation.

For more information, see Promises/A+.

Ext.space.SecureLocalStorage

Encrypted key-value store modeled on HTML5 localstorage.

Ext.space.SecureSQL

Provides the backend storage mechanism for Sencha Web Application Client.

Using Secure Local Storage

The following storage function points to a storage area using a key value. If the caller provides data, the function stores the data. If no data is present, the function reads data from the key location.

Sample Code
store: function (key, data) {                         
    var mystore = Ext.space.SecureLocalStorage.get(key);
    if(data){
            return mystore.set('items', data);
    } else {
            return mystore.get('items');
    }
}

Deleting Secure Local Storage

You can delete a key-value pair from memory using:

Sample Code
delete: function (key) {
    var mystore = Ext.space.SecureLocalStorage.get(key);
    return mystore.delete('items');
}

You can call this function with:

Sample Code
mystore.delete('items').then(function(isDeleted){ ... })

Searching for Stored Data

The following API lets you find data:

Sample Code
find: function (key) {
    var mystore = Ext.space.SecureLocalStorage.get(key);
    return mystore.get('items', data);
}

You could then search using:

Sample Code
find('key').then(function(WhatToDoWhenFound){
    // Code for when key is found
});

Sencha Web Application Manager 6.0.0

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

Sencha Test

2.0.0 EA 1.0.3

Cmd

Cmd

Sencha Themer

Sencha Themer

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle