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

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.


item :  Object

The config object being added.


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


Windows Phone Sencha Web Application Client Guide

The Sencha application is available from the Windows Phone App Store. This application allows you to quickly move between the company approved applications in the Windows Phone Sencha Web Application Client This guide describes how to use Sencha Web Application Client with Windows Phone devices. For use with Android or iOS, please see their corresponding guides:

Note: This guide assumes you have received an organization name and password from your Sencha Web Application Manager administrator.

Requirements Sencha Web Application Client supports Windows Phone devices

running Windows version 8.0 and later.

Note: Installing the user client requires 4 MB to download to the device. Use of Sencha Web Application Client requires network access.

Installing the Windows Phone Sencha Web Application Client

  1. Tap the App Store icon on your device's home screen.
  2. Tap the magnifying glass at the bottom of the store and search for "sencha".
  3. Tap the Sencha icon to review the application prior to downloading.
  4. Tap the "Install" button found in the bottom left hand corner.
  5. At this point, you will need to give the application permission to access your location.
    Note: Sencha Web Application Client needs to know your location to work correctly. If you do not want to allow the application access to your location, you will need to tap "cancel" and the installation will be canceled.

  6. Upon tapping "Allow", the application will be added to your device and you will be redirected to the "Applications" screen.

  7. Finally, tap the "Sencha" application to launch it.

Logging in to Sencha Web Application Client

  1. Type the name of your organization and tap the "return arrow" key, or the next button on the bottom of the screen.
  2. Supply your username and password, provided by your Sencha Web Application Manager administrator.
  3. If prompted, specify a PIN number of your choosing. This will provide your personalized access to your device's Sencha application.

Note: The minimum length and allowable characters for a PIN are set by your Sencha Web Application Manager administrator.

Adding a New Organization

Sencha Web Application Client for Windows Phone supports the use of multiple applications. To add a new organization, simply click "+" at the bottom of the Sencha Web Application Client login screen. You will then be guided through the same steps listed above.

Upon successful authentication, your new organization will be presented as a tappable option on the login screen.

Accessing Applications

Upon successful login, you will be presented with your company's selected "first view" application.

You can open a new application by tapping the small circle icon found in the upper left hand corner. This presents all of the approved applications for your device.

Simply tap the application name or icon to open it.

Switching Between Tabs

You may switch between application tabs by tapping the folder icon in the upper right-hand corner of the application. This will present all open application tabs for quick and easy navigation.

Note: You may open a new tab by long-pressing a link and selecting "Open in Tab" from the resulting menu.


You may click the device's star button in order to favorite a link within an application. Upon doing so, a dropdown menu will appear next to the application's icon. This will display all favorited links within said application. This allows easy navigation to a favorite or oft used section/link within an application.

Refreshing Applications

To get the latest versions of the applications on your device, simply tap the Windows Phone device "Refresh" button found in the middle of the device toolbar.

Application Menu

You can find a list of available tasks you may perform by pressing the menu button in the bottom right corner of the application.

Note: This button looks like a small ellipses.

Available tasks are:

  • Notification Settings
  • Switching Organizations
  • Changing PIN
  • Removing Organizations
  • About Sencha Web Application Client

Notification Settings

You may customize the way Sencha Web Application Client alerts you of application events by opening the "Notification Settings".

To open this menu item, simply tap "Notification Settings" in the application menu discussed above. After that, you may modify "Alerts" and "Badges" for each individual application that your company has approved.

Switch Organization

Sencha Web Application CLient for Windows Phone supports multiple organizations. To switch between organizations, simply click the "Switch Organization" button. You will then be presented with all authenticated organizations. Select your organization and the Windows Phone Client will load your newly selected organization's view.

Changing PIN

You may modify your application PIN number by clicking the "Change Pin" selection under your application menu. You will then be presented with a screen that will ask for your current PIN and desired PIN. Enter these values and click "Next" and your application PIN number will be changed for future verification.

Removing Organizations

Clicking the "Removing Organizations" option will give you the opportunity to remove the active organization.

It's important to note that removing an organization will permanently remove all local data associated with the organization. This includes secured files, favorites, and preferences. This information is not recoverable after deletion.

Note: You may also remove organizations by tapping the organization name on the homescreen, and then tapping the resulting Trash Can icon.

About Sencha Web Application Client

Tapping "About Sencha Web Application Client" presents you with information regarding the application installed on your Windows Phone device. This section provides the following information:


The first screen offers version information about the Windows Phone Client. This information includes:

Client Version

The version number of the installed Windows Phone Client


The second screen contains information about 3rd party projects utilized in Sencha Web Application Client.

Terms of Service

The last screen contains the terms of service agreed to upon installation of Sencha Web Application Client for Windows Phone.

Sencha Web Application Manager 6.0.0

Ext JS
Sencha Test
Sencha Themer
IDE Plugins
Sencha Inspector
Sencha Fiddle

Sencha Test

2.0.0 EA 1.0.3



Sencha Themer

Sencha Themer


5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle