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, inheritance, and read only. 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.

Themer 1.3.5


top

Installation and Setup

In this guide, we will walk through the installation and setup process for Sencha Themer. Before getting started, be sure you meet the following requirements.

Requirements

Operating Systems

  • Windows (Win 7+)

  • Mac OS X

  • Linux 32-bit / 64-bit

Themer

Make sure that you have the installation files for Sencha Themer. These files should be located in your Sencha Premium download folder.

You will also need to have your activation code handy. This can be found in your initial purchase email. You can also obtain your code from the support portal.

Note: You can download a full featured 30-day trial version of Sencha Themer here.

Cmd

Sencha Themer requires Sencha Cmd 6.5.1 or greater. Sencha Cmd can be downloaded here.

If you already have Cmd installed on your machine, you can also upgrade Cmd by issuing the following command from your CLI:

sencha upgrade

Ext JS

Sencha Themer is compatible with with Ext JS 6.0.1 and greater for the Classic toolkit and Ext JS 6.2 and greater for the Modern toolkit.

Your Ext JS framework should be located within your Sencha Premium download folder. The framework can be unzipped to any location on your machine.

Installation

Once you have ensured that your environment meets all of the above requirements, double click on the Sencha Themer installer. Once executed, the installer will walk through the following installation process.

  1. Accept the License Agreement and click "Next >".

  2. Designate User Scope for either "All Users" or "Current User" and click "Next >".

  3. Select a location for Themer to be installed and click "Next >".

  4. Proceed with Installation.

After Themer has completed installation, click "Launch Themer" and click "Finish".

Start Trial

If you're starting your 30 day trial, simply enter the email address you used to download Sencha Themer and click "Start Trial".

If your environment does not have a network connection, you can request an offline trial license. Click "Offline License" in the bottom right portion of the activation screen. Once clicked, you will be in "offline mode".
Enter the email associated with your Themer download and click "Request Trial".

A dialog will be displayed notifying you that your request has been copied to your clipboard. Paste the request into an email to "[email protected]". When you receive a reply, download and/or move the attached license to your machine.

Open Sencha Themer's preferences and click on "Licenses". Finally, click the "Open License File" button and point your file finder at the license that was attached to your email.

Themer should now be in trial mode and ready to utilize.

Activate Themer

If you have purchased Ext JS Premium, you can go ahead and activate Sencha Themer. Enter the email address associated with your purchase. Then, enter your activation code and click "Activate".

Note: Your activation code is the code associated with your Premium purchase. Please check your email for the general Premium activation code. You can also obtain your activation code from the support portal.

Once you have activated Sencha Themer, click "Continue". You will be asked about sharing usage metrics with Sencha.
Choose an option and continue on.

Sencha Themer is now successfully installed.

Offline Licenses

If your environment does not have a network connection, you can request an offline license. Click "Offline License" in the bottom right portion of the activation screen. Once clicked, you will be in "offline mode". Enter the email address associated with your Premium purchase and then enter the Premium activation code.

A dialog will be displayed notifying you that your request has been copied to your clipboard. Paste the request into an email to "[email protected]". When you receive a reply, download and/or move the attached license to your machine.

Open Sencha Themer's preferences and click on "Licenses". Finally, click the "Open License File" button and point your file finder at the license that was attached to your email.

Themer should now be activated and successfully installed.

Troubleshooting

Log Files

In the case of an error or issue, you may be asked to provide a log file. You can find your log file by clicking "Tools > Show Log File". If you have filed a Support Ticket, you should attach "Themer.log" to your ticket submission.

Themer 1.3.5