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 4.x

Guides
API
modern
classic
Benefits
top

Layout Containers

Each container has its own specific uses, and these uses should be described in that container's documentation. When looking at any container and its layout features, keep in mind how it sizes and positions its children and what layout data it uses to be more specific.

Reference

  • Javadocs - Containers are listed here.

Demo

Requirements

UiBinder

Containers can be used with the UiBinder.

  • Choose the UiBinder xmlns imports needed in the <ui:UiBinder/> tag for the containers below. The containers below have the import tag name which can be matched up with the import needed.

      <!-- these are the imports for the containers below -->
      xmlns:container="urn:import:com.sencha.gxt.widget.core.client.container"
      xmlns:button="urn:import:com.sencha.gxt.widget.core.client.button"
      xmlns:core="urn:import:com.sencha.gxt.widget.core.client"
      xmlns:form="urn:import:com.sencha.gxt.widget.core.client.form"
      xmlns:toolbar="urn:import:com.sencha.gxt.widget.core.client.toolbar"
    
  • UiBinder example using the imports for containers.

      <!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
      <ui:UiBinder 
          xmlns:ui="urn:ui:com.google.gwt.uibinder" 
          xmlns:g="urn:import:com.google.gwt.user.client.ui"
          xmlns:container="urn:import:com.sencha.gxt.widget.core.client.container"
          xmlns:button="urn:import:com.sencha.gxt.widget.core.client.button"
          xmlns:core="urn:import:com.sencha.gxt.widget.core.client"
          xmlns:form="urn:import:com.sencha.gxt.widget.core.client.form"
          xmlns:toolbar="urn:import:com.sencha.gxt.widget.core.client.toolbar">
    
          <container:SimpleContainer addStyleNames="{style.widget}" ui:field="container" />
      </ui:UiBinder> 
    









Container hierarchy

The hierarchy of the GXT containers.

Zoom In

Children sized layout vs document flow layout

Choose the containers best suited for layout.

  • Container sized layout containers are most often used in applications.
  • Document flow layout containers can be used as application layout container children.
  • Container types can be intermixed, although document flow, will break auto sizing children.

Container sized layout

Container sized layout consumes the size of the browser or parent container and does not flow like a page.

  • The containers must be given a size or be sized by its parent.
  • Container sized children can have document flow children, although their children will have to be sized manually.

Document layout

Document layout flows like a document or most often like a long page.

  • Document layout lets the browser size the containers.
  • When using container sized layout containers inside document flow containers, they must be given a size during init and resizing.

Want layout help

Submit a wireframe with colored borders boundaries for the widgets and containers to a support ticket or premium forum and we can provide example mock ups with layout options.

Containers

AbstractHtmlLayoutContainer

A base class for HTML layout containers. Provides behavior common to all HTML layout containers, including the attachment of of the widget element to the container's parent element.

AccordionLayoutContainer

A layout container that manages multiple content panels in an expandable accordion style such that only one panel can be expanded at any given time (by default). Each panel has built-in support for expanding and collapsing. Note: Only ContentPanel's and subclasses may be used in an accordion layout container. Each content panel should be created with AccordionLayoutContainer.AccordionLayoutAppearance to produce the expected accordion panel look and feel.

BorderLayoutContainer

A multi-pane, application-oriented layout container that supports multiple regions, automatic split bars between regions and built-in expanding and collapsing of regions.

Region positions are specified using compass points (e.g. north for top, west for left, east for right, south for bottom) and center. The center region is a privileged position that receives the remaining space not allocated to other regions. Border layout containers should generally specify a center region and one or more other regions.

Region layout parameters are specified using BorderLayoutData which controls the margin between the regions, the size of the region, the minimum and maximum size, whether the region has a split bar, whether the region is collapsible and other details.

Region size may be specified as a percent of the parent container size or a fixed number of pixels. The region size is specified as a single value that describes the orientation associated with the region (height for north and south, width for west and east).

BoxLayoutContainer

A base class for box layout containers. Provides behavior common to all box layout containers, including packing, padding and the action to take on insert and remove.

ButtonBar

A horizontal row of buttons.

ButtonGroup

A group of buttons.

CardLayoutContainer

A layout container that contains multiple widgets, each fit to the container, where only a single widget can be visible at any given time. This layout style is most commonly used for wizards, tab implementations, etc.

CenterLayoutContainer

A layout container that centers its single widget.

Component

Base class for all GXT widgets.

Container

Abstract base for components that can contain child widgets.

ContentPanel

ContentPanel is a component container that has specific functionality and structural components that make it the perfect building block for application-oriented user interfaces. A content panel contains separate header, footer and body sections. The header may contain an icon, text and a tool area that can be wired up to provide customized behavior. The footer contains buttons added using addButton(Widget). The body contains a single widget, added using SimpleContainer.add(Widget). The widget is resized to match the size of the container. A content panel provides built-in expandable and collapsible behavior.

CssFloatLayoutContainer

A layout container that uses the CSS float style to enable widgets to float around other widgets.

Dialog

A Window with specialized support for buttons. Defaults to a dialog with an 'ok' button.

FieldLabel

Form field wrapper to add a label and validation error text.

  • FieldLabel > SimpleContainer > ResizeContainer > Container > Component > Widget
  • /FieldLabel Javadoc
  • Demo
  • UiBinder:

       <form:FieldLabel />
    

FieldSet

A simple container that wraps its content in a HTML fieldset.

  • FieldSet > SimpleContainer > ResizeContainer > Container > Component > Widget
  • /FieldSet Javadoc
  • Demo
  • UiBinder:

      <form:FieldSet />
    

FlowLayoutContainer

A flow layout container that supports scrolling and lays out its widgets using the default HTML layout behavior.

FormPanel

A panel that wraps an HTML form. The field names and data on the form can be submitted to an HTTP server. A form panel is a SimpleContainer, which contains only a single widget. Multiple fields can be added to a form panel by adding them first to another container and then adding that container to the form panel.

  • FlowPanel > SimpleContainer > ResizeContainer > Container > Component > Widget
  • /FormPanel Javadoc
  • Demo
  • UiBinder:

      <form:FormPanel />
    

FramedPanel

A ContentPanel that internally uses a @link FramedPanel.FramedPanelAppearance.

HBoxLayoutContainer

A layout container for horizontal rows of widgets. Provides support for automatic overflow.

HorizontalLayoutContainer

A layout container that lays out its children in a single row. The layout properties for each child are specified using HorizontalLayoutContainer.HorizontalLayoutData.

HtmlLayoutContainer

A layout container that lays out its children using an HTML template. The mapping of each child to a corresponding selector is specified using HtmlData.

InsertContainer

A base class for layout containers that can insert widgets.

InsertResizeContainer

A base class for layout containers that can insert widgets and honor the RequiresResize contract.

NorthSouthContainer

A layout container that supports north (top) and south (bottom) regions.

PagingToolBar

A specialized toolbar that is bound to a PagingLoader and provides automatic paging controls.

Popup

A panel that can be displayed over other widgets.

PortalLayoutContainer

A layout container that lays out its children in in multiple columns, each containing zero or more Portlets. Supports drag and drop of child Portlets between columns as well as modifying the order within columns.

Portlet

A framed panel that is managed by a PortalLayoutContainer.

ResizeContainer

A base class for layout containers that require resize support.

SimpleContainer

SimpleContainer takes one child and sizes it to match the container size.

ToolBar

A standard tool bar.

  • ToolBar > HBoxLayoutContainer > BoxLayoutContainer > InsertResizeContainer > ResizeContainer > Container > Component > Widget
  • /ToolBar Javadoc
  • Demo
  • UiBinder:

      <toolbar:ToolBar />
    

VBoxLayoutContainer

A layout container for vertical columns of widgets.

VerticalLayoutContainer

A layout container that lays out its children in a single column. The lay out properties for each child are specified using VerticalLayoutContainer.VerticalLayoutData.

Viewport

A LayoutContainer that fills the browser window and monitors window resizing. Viewports are best used for applications that will fill the browser without window scrolling. Children of the viewport can allow scrolling.

Widget

Refers to the GWT Widget.

Window

A specialized content panel intended for use as an application window.

Sencha GXT 4.x

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

Sencha Test

2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation