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


Sencha Web Application Manager Desktop Client

Welcome to Sencha Web Application Manager Client for Desktop! The Desktop Client provides a manner in which your organization may securely run web applications from desktop machines. From within the Desktop Client, users have the ability to launch approved applications that make their business experience secure and productive.


Let's begin by downloading Sencha Web Application Client for Desktop. You may download the Windows desktop client below:

Sencha Web Application Manager Client for Windows Desktop

Note: Sencha Web Application Client for Desktop is compatible with Windows Vista+.

Windows Installation

To install the Desktop Client, simply launch the Sencha Web Application Client Installer Package. You will then walk through the following steps.

  1. Launch Screen
  2. End User License Agreement
  3. Destination Folder (Windows Only)
  4. Finalization Screen

At this point you can press "Install" and finally, "Finish". Upon completion, you can launch the application via the resulting desktop icon.

Adding your organization

The first time you launch the Desktop Client, you will be asked to enter an organization code.

Simply fill in your provided code and progress to the next screen.

You will then be asked to enter your organization username and password.

Upon your credentials being certified, and if your organization administrator has required it, you will be asked to create a personal PIN or passcode. This number will allow you to bypass the previous steps for future logins. The PIN may have length requirements set by the organization adminstor. This is a personal entry number only and is only used to gain access to Sencha Web Application Client on this device. It is not shared with the Sencha Web Application Manager servers and is never stored on the device when Sencha Web Application Client is not in use. If you have multiple devices that you use to access Sencha Web Application Client the PIN on those devices is independent on each device.

New Organizations

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

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

Sencha Web Application Client for Desktop

Upon successful login, you will be presented with the client for desktop, which contains all of your organization approved applications.

You can launch any of these applications by clicking the application name. Upon launch, a Sencha Web Application Client browser will open. This browser will contain the application contents.

VPN Encryption

You may notice that some of the applications in the Desktop Client are paired with a small lock icon. This indicates that the application in question requires a VPN connection to utilize.

This VPN connection will be provided to you by your organization.

Options Menu

You will notice a small icon in the upper right hand corner of the Desktop Client. This icon opens an Options menu that allows you to make modifications to your Sencha Web Application Client organizations.

Change Pin

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

Switch Organization

As mentioned above, Sencha Web Application Client for Desktop 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 Desktop Client will load your new view.

About Sencha Web Application Client

Another selection available in the options menu is "About Sencha Web Application Client". This menu item gives you three tabs that contain information about the Desktop Client.


The first tab offers version information about the Desktop Client. This information includes:

  • Client Version - The version number of the installed Desktop Client
  • Build Number - The build number of the installed Desktop Client
  • Build Date - The date of the Desktop Client build


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

Terms of Service

The last tab contains the terms of service agreed to upon installation of Sencha Web Application Client for Desktop.

Remove Organization

The last selection is "Remove Organization". Clicking this 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 deleted.

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