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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public
members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static
label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent
in this example)( item )
in this example)Ext.Component
in this case). This may be omitted for methods that do not
return anything other than undefined
or may display as multiple possible values
separated by a forward slash /
signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false
if unsuccessful which would be displayed as
Ext.Component/Boolean
).PROTECTED
in
this example - see the Flags section below)Ext.container.Container
in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source
in the example)item : Object
in the example).undefined
a "Returns" section
will note the type of class or object returned and a description (Ext.Component
in the
example)Available since 3.4.0
- not pictured in
the example) just after the member descriptionDefaults to: false
)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.
classInstance.method1().method2().etc();
false
is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button
class has an alternate class name of Ext.Button
). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
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.
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.
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.
Upon tapping "Allow", the application will be added to your device and you will be redirected to the "Applications" screen.
Finally, tap the "Sencha" application to launch it.
Note: The minimum length and allowable characters for a PIN are set by your Sencha Web Application Manager administrator.
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.
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.
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.
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.
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:
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.
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.
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.
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.
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.
The last screen contains the terms of service agreed to upon installation of Sencha Web Application Client for Windows Phone.