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.

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.

Sencha GXT 3.x

Guides
API
modern
classic
Benefits
top

Theme Builder Syntax

Theme configuration syntax reference.

Reference

Building themes

Sencha professional services

Sencha professional services can build the theme for you. Inquire about the professional service options here.

Overview

The theme config file structure is a set of namespaced key/value pairs. Values are namespaced to group them more easily, either by using dot notation, or grouping data in {}s. The root namespace of the file is theme.

In order to know what to call the theme and where to build it, theme.name and theme.basePackage must be specified. For a theme called "red" in package "com.example", this file could start looking like this:

theme {
  name = "red"
  basePackage = "com.example"
}

This could also be written like this:

theme.name = "red"
theme.basePackage = "com.example"

Specific details of the theme are expected to be found in theme.details, based on which widget they are for, and what property they set. As content is nested more deeply, the {} notation becomes more and more useful to keep the file readable.

Editing

Edit the theme configuration files with any basic text editor.

Naming

Some properties are required, such as theme.name and theme.basePackage, as well as the properties required to actually generate a theme. If they are missing, you will get an error message when you attempt to generate a theme. You can also create your own properties, letting them be any type you choose. These will not have any impact on compiling the appearance, but can be helpful to enabled you to define constants once in a file, and reference them elsewhere.

Comments

Comments can be added to the file in either variety accepted in Java and Javascript, either // to comment out the rest of a line, or /* and */ to comment out all contents between the two.

Property values

Each property can be set to either a constant value, an expression, or a reference to another property. This lets you write a few starting properties in one place, then reference them throughout the file doing basic math on them, or reusing them as appropriate. Properties can be of several types, strings, ints, doubles, and objects. Objects are really just another layer of nested namespaces, but they can function as objects when you reference them from other properties.

For example, you may define the default set of test details early on in the theme, and use them later:

theme {
  name = "red"
  basePackage = "com.example"

  // standard font settings, to be used throughout this file
  defaultFont {
    color = "#ffffff"
    family = "Tahoma, Arial, Verdana, sans-serif"
    size = "14px"
    weight = "bold"
  }

  details {
    info {
      messageText = defaultFont
      //note that this could also be written as
      //messageText = theme.defaultFont
    }
  }
}

Gradients

Gradient Syntax

Configuration functions

Configuration Functions Syntax

Sencha GXT 3.x

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

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation