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, 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.



Structuring your Page Objects

“If you have WebDriver APIs in your test methods, You’re Doing It Wrong.” - Simon Stewart

Simon Stewart, the lead committer of the Selenium Project, shared in his initial vision of Selenium that Page Objects are the mandatory layer on top of the WebDriver. Both of them belong together, Sencha WebTestIt was created with this fact in mind.

To use Sencha WebTestIt efficiently, you have to understand the Page Object Pattern.

What is a Page Object?

The Page Object pattern is a classic example of encapsulation. It wraps the mechanics required to find and manipulate the data in the GUI with an application-specific API. The basic rule of thumb for a Page Object is that it should allow a software client to do and see anything that a human can.

Despite the name, do not create a Page Object for each page. Create them rather for the significant components on a page, such as headers, menus, or content regions.


We use our demo shop as an example of how to derive Page Objects.

We can divide the initial start page into at least three Page Objects:

  1. HeaderPo: It can be found on every page, so it makes sense to extract this as a Page Object.
  2. ItemsOverviewPo: This component contains all the items available for sale.
  3. ShoppingCartPo: This shopping cart summary expands out of the header, but it contains enough functionality and elements to make it its own Page Object.

Page Object actions

Now that we have our page divided into Page Objects, let’s find out how we can use them in tests.

The Page Object pattern’s intention is to separate the Application and Assertion APIs from the WebDriver API. This means, that tests should never use HTML elements or WebDriver directly, but only consume exposed (public) methods, referred as Actions.

These actions encapsulate units of user interaction, such as “Click on a button”, “Log in” or “Submit a form”, internally using the WebDriver API and the elements associated with the Page Object.

Therefore, when creating an action method, keep the following best practices in mind:

  1. Never return an element directly, instead:
    • Return values of basic types (strings, integers, dates, …) if you want to work with them.
    • Return the Page Object instance itself (this) when you’re just acting upon elements.
    • Return another Page Object to indicate a context switch, e.g. after clicking on a link, or submitting a form.
    • This allows you to chain Page Object actions together, leading up to a final returned value, that you can then use in your assertion.
  2. Do not use assertions in Page Objects, instead:
    • Return the relevant properties of an element, e.g. its text.
    • Alternatively, pass the comparison values as arguments, and return a boolean.
    • Use these results for assertions in your test files.
  3. Good Page Object actions are reusable, imagine them as the building blocks for your tests.


Using the Page Objects from above, let’s build a simple test, with the rules we have just learned. The test should: 1. Add one item to the cart, 2. Go to the cart, and 3. Assert, that the total price is correct.


This example uses Java, but the same principles apply to TypeScript projects.*

  1. This action takes place in the ItemsOverviewPo, and adds an item to the cart. Just adding an item to the cart should not navigate us anywhere, and you may want to do more in the ItemsOverviewPo in other tests, so we return this:

    public ItemsOverviewPo addItemToCart() {
        return this;
  2. In the same Page Object, when you click the View cart button, you expect to land on the Cart page, so you return a new instance of the corresponding Page Object class, CartPo:

    public CartPo viewCart() {
        return new CartPo(this.driver);
  3. Finally, you are ready to verify that the price is displayed correctly. Do not put assertions into the Page Object action. Instead, create a method that returns the text of the element holding the total price:

    public String getTotalPrice() {
        String totalPriceText = this.wait.until(ExpectedConditions.visibilityOfElementLocated(this.totalPrice)).getText();
        return totalPriceText;

    Now you can use these actions in a test. Note, how thanks to returning Page Object instances in our actions, you can chain the action methods like this, improving readability of the test:

    public void checkTotalPrice() {
        // 1. Arrange
        WebDriver driver = getDriver();
        ItemsOverviewPo itemsOverviewPo = new ItemsOverviewPo(driver)
        // 2. Act
        String totalPrice = itemsOverviewPo
        // 3. Assert
        Assert.assertEquals(totalPrice, "€1,500.00");


After reading this article, you have learned about the Page Object pattern, how to divide a complex website into individual Page Objects, and how to structure your Page Object actions using best practices.

If you want to know more about Page Objects, be sure to read Martin Fowler’s article about PageObjects.