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

Examples

Miscellaneous examples of how the GWT and GXT driver can be used.

Example 1

@Test
public void testContainerScrollCausesNoHeightGrowth() {
  gotoEntryPoint(TestAccordionLayoutContainer.class);

  // Given we have ALC with tree inside panel
  WebElement alcElement = driver.findElement(new FasterByChained(By.xpath(".//*"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.container.AccordionLayoutContainer.class)));
  WebElement contentPanelElement = alcElement.findElement(new FasterByChained(By.xpath(".//*"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.ContentPanel.class)));

  // When we get the original size of the content panel with tree
  Dimension originalSize = contentPanelElement.getSize();

  // And we mouse over the tree elements
  for (int i = 0; i < NUMBER_OF_MOVEMENTS; i++) {
    new Actions(driver).moveToElement(contentPanelElement).moveByOffset(0, SPACING * i).click().build().perform();
    Dimension newSize = contentPanelElement.getSize();
    // Then the content panel should be the same size while mousing over
    Assert.assertEquals(originalSize, newSize);
  }

  for (int i = NUMBER_OF_MOVEMENTS; i > 0; i--) {
    new Actions(driver).moveToElement(contentPanelElement).moveByOffset(0, SPACING * i).click().build().perform();
    Dimension newSize = contentPanelElement.getSize();
    // Then the content panel should be the same size while mousing over
    Assert.assertEquals(originalSize, newSize);
  }

Example 2

@Test
public void testCheckBoxCellAlignment() throws InterruptedException {
  gotoEntryPoint(CheckBoxCellTest.class);

  // Given a list view a list of checkboxes with labels
  WebElement listViewElement = driver.findElement(new FasterByChained(By.xpath(".//*"), 
      new ByWidget(driver, ListView.class)));

  // When the label locations are retrieved from each item in the vertical row of checkboxes
  List<WebElement> elements = listViewElement.findElements(By.xpath(".//div/div/label"));
  Point cb1 = elements.get(0).getLocation();
  Point cb2 = elements.get(1).getLocation();
  Point cb3 = elements.get(2).getLocation();
  Point cb4 = elements.get(3).getLocation();

  // Then the labels will be in a straight line
  Assert.assertEquals(cb1.getX(), cb2.getX());
  Assert.assertEquals(cb1.getX(), cb3.getX());
  Assert.assertEquals(cb1.getX(), cb4.getX());
}

Example 3

@Test
public void testDialogInnerContainerHeightFillsContainer() {
  gotoEntryPoint(TestDialog.class);

  // Given a button opens a window
  Button button = GwtWidget.find(Button.class, driver).withText("Show Dialog").done();
  button.click();

  // When that window is visible
  Window window = getWindow();

  // And get the HTML element size
  Dimension sizeOnFistTime = getHtmlElement(window).getSize();

  // And close the window
  Button closeButton = GwtWidget.find(Button.class, driver).withText("Close").withElement(window.getElement()).done();
  closeButton.click();

  // And open the window back up
  button.click();

  // Then the HTML element will be the same size as the first time
  Dimension sizeOnSecondTime = getHtmlElement(getWindow()).getSize();
  Assert.assertEquals(sizeOnFistTime, sizeOnSecondTime);
}

public WebElement getHtmlElement(Window window) {
  WebElement htmlElement = window.getElement().findElement(
      new FasterByChained(By.xpath(".//*"), new ByWidget(driver, HTML.class)));
  return htmlElement;
}

public Window getWindow() {
  Window window = GwtWidget.find(Window.class, driver).withHeading("").done();
  return window;
}

Example 4

@Test
public void testHorizontalScroll() throws InterruptedException {
  gotoEntryPoint(FxScrollTest.class);

  // Given a div that can scroll
  WebElement outerScrollContainerElement = driver.findElement(new FasterByChained(By.xpath(".//*"), new ByWidget(
      driver, com.sencha.gxt.widget.core.client.container.FlowLayoutContainer.class)));
  WebElement innerScrollContainerElement = outerScrollContainerElement.findElement(new FasterByChained(
      By.xpath(".//*"), new ByWidget(driver, com.sencha.gxt.widget.core.client.container.FlowLayoutContainer.class)));

  // And the the div has not scrolled yet
  long scrollTop = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollTop;",
      innerScrollContainerElement);
  long scrollLeft = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollLeft;",
      innerScrollContainerElement);
  Assert.assertEquals(0, scrollTop);
  Assert.assertEquals(0, scrollLeft);

  // When the Scroll Horizontal is clicked
  Button button = GwtWidget.find(Button.class, driver).withText("Scroll Horizontal").done();
  button.click();

  // And scroll element scrolls to the right
  Thread.sleep(500);

  // Then the element scrolls 75px to Right
  scrollTop = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollTop;",
      innerScrollContainerElement);
  scrollLeft = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollLeft;",
      innerScrollContainerElement);
  Assert.assertEquals(0L, scrollTop);
  Assert.assertEquals(75L, scrollLeft);

  // When the Scroll Horizontal is clicked again
  button = GwtWidget.find(Button.class, driver).withText("Scroll Horizontal").done();
  button.click();

  // And scroll element scrolls back to it's home 0px
  Thread.sleep(500);

  // Then the element scrolls to 0px
  scrollTop = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollTop;",
      innerScrollContainerElement);
  scrollLeft = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollLeft;",
      innerScrollContainerElement);
  Assert.assertEquals(0L, scrollTop);
  Assert.assertEquals(0L, scrollLeft);
}

Example 5

@Test
public void testFirstVlcMarginTest() {
  gotoEntryPoint(LayoutVlcWithMargins.class);

  // Given there are 3 Vertical panels on the sample
  List<WebElement> vlcElements = driver.findElements(new FasterByChained(By.xpath(".//*"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.container.VerticalLayoutContainer.class)));

  // And get the first vlc container to work with
  WebElement vlcElement = vlcElements.get(0);

  // And get the simple containers inside the vlc containers
  List<WebElement> simplecontainers = vlcElement.findElements(new FasterByChained(By.xpath(".//*"), new ByWidget(driver,
      SimpleContainer.class)));

  // When measuring the first outer simple container
  WebElement sc0 = simplecontainers.get(0);
  Point locaiton0 = sc0.getLocation();
  Dimension size0 = sc0.getSize();
  // Then the first outer simple container is
  Assert.assertEquals(1, locaiton0.getY());
  Assert.assertEquals(50, size0.getHeight());

  // When measuring the first inner simple container
  WebElement sc1 = simplecontainers.get(1);
  Point locaiton1 = sc1.getLocation();
  Dimension size1 = sc1.getSize();
  // Then the first inner simple container is
  Assert.assertEquals(11, locaiton1.getY());
  Assert.assertEquals(30, size1.getHeight());

  // When measuring the second simple container in the stack
  WebElement sc2 = simplecontainers.get(2);
  Point locaiton2 = sc2.getLocation();
  Dimension size2 = sc2.getSize();
  // Then the second simple container in the stack is
  Assert.assertEquals(51, locaiton2.getY());
  Assert.assertEquals(148, size2.getHeight());
}

Example 6

private void selectItemTestMenu1(Integer index) {
  // Given focus is diverted to another element (TODO as a workaround, for focus behavior issue)
  Button button = GwtWidget.find(Button.class, driver).withText("Test Menu 2").done();
  button.click(); // open menu
  button = GwtWidget.find(Button.class, driver).withText("Test Menu 2").done();
  button.click(); // close menu (end workaround)

  // When I click on the button it opens up the menu
  button = GwtWidget.find(Button.class, driver).withText("Test Menu 1").done();
  button.click();

  // And when the first item is selected
  Menu menu = GwtWidget.find(Menu.class, driver).atDepth(0).done();
  menu.click("item " + index.toString());

  // And when the menu is reopened
  button = GwtWidget.find(Button.class, driver).withText("Test Menu 1").done();
  button.click();

  // And get the menu items
  menu = GwtWidget.find(Menu.class, driver).atDepth(0).done();
  List<WebElement> itemElements = menu.getElement().findElements(By.xpath(".//*//div/span"));

  // Then the first item is selected
  if (index == 1) {
    Assert.assertTrue(isItemSelected(itemElements.get(0)));
    Assert.assertFalse(isItemSelected(itemElements.get(1)));
    Assert.assertFalse(isItemSelected(itemElements.get(2)));
  } else if (index == 2) {
    Assert.assertFalse(isItemSelected(itemElements.get(0)));
    Assert.assertTrue(isItemSelected(itemElements.get(1)));
    Assert.assertFalse(isItemSelected(itemElements.get(2)));
  } else if (index == 3) {
    Assert.assertFalse(isItemSelected(itemElements.get(0)));
    Assert.assertFalse(isItemSelected(itemElements.get(1)));
    Assert.assertTrue(isItemSelected(itemElements.get(2)));
  }
}

Example 7

Finding items in a list.

private void given() {
  // Given a content panel
  WebElement contentPanelElement = driver.findElement(new FasterByChained(By.xpath(".//div"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.ContentPanel.class)));

  // And it has two lists to select from
  List<WebElement> listElements = contentPanelElement.findElements(new ByChained(By.xpath(".//div"), new ByWidget(
      driver, com.sencha.gxt.widget.core.client.ListView.class)));
  list1 = new ListView(driver, listElements.get(0));
  list2 = new ListView(driver, listElements.get(1));

  // And there are two size html status elements, containing the size counts of the lists
  htmlSizeElements = contentPanelElement.findElements(new ByChained(By.xpath(".//*[contains(text(), 'size')]"),
      new ByWidget(driver, HTML.class)));
  size1Before = TestUtils.getIntFromText(htmlSizeElements.get(0));
  size2Before = TestUtils.getIntFromText(htmlSizeElements.get(1));

  // And the list1 list1Items are retrieved
  list1Items = list1.getElement().findElements(By.xpath(".//*[contains(text(), *)]"));

  // And what is the default item css classes, used to compare selected
  defaultCssClass = list1Items.get(0).getAttribute("class");
}

Example 8

Finding nodes in a tree.

private void given() {
  // Given a content panel
  WebElement contentPanelElement = driver.findElement(new FasterByChained(By.xpath(".//div"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.ContentPanel.class)));

  // And it has two lists to select from
  List<WebElement> treeElements = contentPanelElement.findElements(new ByChained(By.xpath(".//div"), new ByWidget(
      driver, com.sencha.gxt.widget.core.client.tree.Tree.class)));
  tree1 = new Tree(driver, treeElements.get(0));
  tree2 = new Tree(driver, treeElements.get(1));

  // And there are two size html status elements, containing the size counts of the list
  htmlSizeElements = driver.findElements(new ByChained(By.xpath(".//*//div[1][contains(text(), 'size')]"),
      new ByWidget(driver, HTML.class)));
  size1Before = TestUtils.getIntFromText(htmlSizeElements.get(0));
  size2Before = TestUtils.getIntFromText(htmlSizeElements.get(1));

  // And get the root children
  rootchildren = tree1.getRootChildren();

  // And what is the default item css classes, used to compare selected
  defaultCssClass = rootchildren.get(0).getElement().getAttribute("class");
}

Example 9

private void given() {
  // Given a content panel
  WebElement contentPanelElement = driver.findElement(new FasterByChained(By.xpath(".//div"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.ContentPanel.class)));

  // And it has two lists to select from
  List<WebElement> treeElements = contentPanelElement.findElements(new ByChained(By.xpath(".//div"), new ByWidget(
      driver, com.sencha.gxt.widget.core.client.tree.Tree.class)));
  tree1 = new Tree(driver, treeElements.get(0));
  tree2 = new Tree(driver, treeElements.get(1));

  // And there are two size html status elements, containing the size counts of the list
  htmlSizeElements = driver.findElements(new ByChained(By.xpath(".//*//div[1][contains(text(), 'size')]"),
      new ByWidget(driver, HTML.class)));
  size1Before = TestUtils.getIntFromText(htmlSizeElements.get(0));
  size2Before = TestUtils.getIntFromText(htmlSizeElements.get(1));

  // And get the root children
  rootchildren = tree1.getRootChildren();

  // And what is the default item css classes, used to compare selected
  defaultCssClass = rootchildren.get(0).getElement().getAttribute("class");
}

Example 10

private void given() {
  // Given a content panel
  WebElement contentPanelElement = driver.findElement(new FasterByChained(By.xpath(".//div"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.ContentPanel.class)));

  // And it has two lists to select from
  List<WebElement> treeElements = contentPanelElement.findElements(new ByChained(By.xpath(".//div"), new ByWidget(
      driver, com.sencha.gxt.widget.core.client.tree.Tree.class)));
  tree1 = new Tree(driver, treeElements.get(0));
  tree2 = new Tree(driver, treeElements.get(1));

  // And there are two size html status elements, containing the size counts of the list
  htmlSizeElements = driver.findElements(new ByChained(By.xpath(".//*//div[1][contains(text(), 'size')]"),
      new ByWidget(driver, HTML.class)));
  size1Before = TestUtils.getIntFromText(htmlSizeElements.get(0));
  size2Before = TestUtils.getIntFromText(htmlSizeElements.get(1));

  // And get the root children
  rootchildren = tree1.getRootChildren();

  // And what is the default item css classes, used to compare selected
  defaultCssClass = rootchildren.get(0).getElement().getAttribute("class");
}

Example 11

public void testTreeExpandingOnlyExpandsOneNode() throws InterruptedException {
  gotoEntryPoint(TreeExpanding.class);

  // Given we have a tree that has two nodes to expand
  WebElement treeElement = driver.findElement(new ByChained(By.xpath(".//*"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.tree.Tree.class)));
  Tree tree = new Tree(driver, treeElement);

  // When get the root children
  List<Item> rootChildren = tree.getRootChildren();

  // And the first node and its children are expanded
  rootChildren.get(0).toggleExpand();
  rootChildren.get(0).getChildren().get(0).toggleExpand();

  // And the first node is then collapsed
  rootChildren.get(0).toggleExpand();

  // And the second node and children are expanded
  rootChildren.get(1).toggleExpand();
  rootChildren.get(1).getChildren().get(0).toggleExpand();

  // Then only the second node should be expanded
  Assert.assertFalse(rootChildren.get(0).isExpanded());
}

Example 12

@Test
public void testClickingOnCheckBoxWhenEnabled() throws InterruptedException {
  gotoEntryPoint(TreeWithCheckboxes.class);

  // Given we have a tree with checkboxes
  WebElement treeElement = driver.findElement(new ByChained(By.xpath(".//*"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.tree.Tree.class)));
  Tree tree = new Tree(driver, treeElement);

  // When root has children
  List<Item> rootChildren = tree.getRootChildren();

  // And when the checkbox is checked
  rootChildren.get(0).toggleCheck();

  // Then the checkbox is checked
  Assert.assertTrue(rootChildren.get(0).isChecked());
}

Example 13

@Test
public void testTreeNodesHighlight() throws InterruptedException {
  gotoEntryPoint(TreeWithScroll.class);

  // Given a toolbar is collapsed with clickable image to expand menu
  WebElement toolBarWithImageElement = driver.findElement(By.tagName("img"));

  // And the toolbar expands, and Expand All tree nodes is clicked
  new Actions(driver).moveToElement(toolBarWithImageElement).click().moveByOffset(0, 27).clickAndHold().release().build().perform();

  // And wait for tree to expand
  Thread.sleep(700);//TODO replace with waitfor command, this timeout is too long and saucelabs is giving up? intermittent.

  // When the size of the tree is larger than the container
  WebElement treeElement = driver.findElement(new FasterByChained(By.xpath(".//*"), new ByWidget(driver,
      com.sencha.gxt.widget.core.client.tree.Tree.class)));

  // And get the tree scroll size
  Long treeScrollWidth = (Long) ((JavascriptExecutor) driver).executeScript("return arguments[0].scrollWidth;",
      treeElement);

  // And clicking on first leaf causes a selection highlight
  List<WebElement> treeLeafElements = treeElement.findElements(By.xpath(".//div/div/span[3]"));
  WebElement firstLeafElement = treeLeafElements.get(0);
  firstLeafElement.click();

  // Then measure the selection highlight
  WebElement firstLeafParentElement = firstLeafElement.findElement(By.xpath(".."));
  Dimension firstLeafSize = firstLeafParentElement.getSize();

  // And assert that the container scroll size is the same as the highlighted size
  Assert.assertEquals(treeScrollWidth.intValue(), firstLeafSize.getWidth());
}

Example 14

@Test
public void testWindowMaximizedWidthTest() throws InterruptedException {
  gotoEntryPoint(WindowRestoreTest.class);

  // Given a button opens a window
  Button openWindowButton = GwtWidget.find(Button.class, driver).withText("Open Window").done();

  // When the window is opened by click on button
  openWindowButton.click();

  // And maximize window
  setBrowserWindowMaximized();

  // And wait for window width fullsize
  final Matches sizeMatches = new Matches();
  WebDriverWait wait = new WebDriverWait(driver, 10);
  wait.until(new ExpectedCondition<Boolean>() {
    public Boolean apply(WebDriver driver) {
      boolean result = getWindow().getElement().getSize().getWidth() == getBrowserWindowSize().getWidth();
      sizeMatches.matches = result;
      return result;
    }
  });

  // Then the window will be the size of the maximized size
  Assert.assertTrue(sizeMatches.matches);
}

public class Matches {
  public boolean matches;
}

private Window getWindow() {
  return GwtWidget.find(Window.class, driver).atTop().done();
}

private List<WebElement> getButtonElements() {
  List<WebElement> toolbuttonElements = getWindow().getElement().findElements(
      new FasterByChained(By.xpath(".//*"), new ByWidget(driver, ToolButton.class)));
  return toolbuttonElements;
}

Example 15

@Test
public void testComboboxEscapePressDoesntHideWindow() throws InterruptedException {
  gotoEntryPoint(TestWindowWithComboBox.class);

  // Given we have a open window
  Button button = GwtWidget.find(Button.class, driver).withText("Open Window").done();
  button.click();

  // When that window is visible
  Window window = GwtWidget.find(Window.class, driver).atTop().done();

  // And find the combobox
  WebElement comboBoxElement = window.getElement().findElement(
      new FasterByChained(By.xpath(".//*"), new ByWidget(driver, com.sencha.gxt.widget.core.client.form.ComboBox.class)));
  WebElement comboInputElement = comboBoxElement.findElement(By.tagName("input")); 

  // And focus and press the letter 'a' so it expands
  comboInputElement.click();
  comboInputElement.sendKeys("a");

  // And wait for Combobox to expand
  Thread.sleep(1000);

  // Then press escape, should not close window
  comboInputElement.sendKeys(Keys.ESCAPE.toString());

  // And the window is open and visible
  Assert.assertTrue(window.getElement().isDisplayed());
}

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