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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public
members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static
label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent
in this example)( item )
in this example)Ext.Component
in this case). This may be omitted for methods that do not
return anything other than undefined
or may display as multiple possible values
separated by a forward slash /
signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false
if unsuccessful which would be displayed as
Ext.Component/Boolean
).PROTECTED
in
this example - see the Flags section below)Ext.container.Container
in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source
in the example)item : Object
in the example).undefined
a "Returns" section
will note the type of class or object returned and a description (Ext.Component
in the
example)Available since 3.4.0
- not pictured in
the example) just after the member descriptionDefaults to: false
)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.
classInstance.method1().method2().etc();
false
is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button
class has an alternate class name of Ext.Button
). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
The Combobox choices in GXT.
Investigate the source in the examples links here.
The simple String combo box is ready to go for String lists.
StringComboBox
example.
StringComboBox combo = new StringComboBox();
combo.add("Item 1");
combo.add("Item 2");
combo.add("Item 3");
combo.add("Item 4");
The any model ComboBox fits any kind models list.
Any model ComboBox<M>
example.
ListStore<Company> store = new ListStore<Company>(new ModelKeyProvider<Company>() {
@Override
public String getKey(Company item) {
return item.getId().toString();
}
});
store.add(new Company("0", "Company 1"));
store.add(new Company("1", "Company 2"));
store.add(new Company("2", "Company 3"));
store.add(new Company("3", "Company 4"));
LabelProvider<Company> labelProvider = new LabelProvider<Company>() {
@Override
public String getLabel(Company item) {
if (item.getName() == null) {
return "";
}
return item.getName();
}
};
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
Model used in the ComboBox<M>
example.
public class Company {
private String id;
private String name;
public Company(String id, String name) {
this.id = id;
this.name = name;
}
public String getId() {
return id;
}
public String getName() {
return name;
}
}
Some common ComboBox configuration options.
Hide the cursor from blinking in the input.
Example
combo.setEditable(false);
The trigger is what causes the combo to expand the list selection.
Action | Result |
---|---|
TriggerAction.ALL | Expands the entire list. |
TriggerAction.QUERY | Expands a filtered list using the input for the query. |
Example of TriggerAction.ALL
.
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setTriggerAction(TriggerAction.ALL);
Example of the TriggerAction.QUERY
.
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setTriggerAction(TriggerAction.QUERY);
Setting the minimum charters before autocompletion expands the list.
Example setMinChars(4)
.
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setMinChars(4);
Type ahead or autofill in the characters.
setTypeAhead(true)
.ComboBox
Setting a loader to load data from a server or other location. The only thing different in the two examples below is the Proxy wiring and there are many other possible configurations. The Advanced Combo Example has a more intricate loader example which also uses a remote query.
Example using the setLoader(loader)
using a DataProxy.
// The Store
ListStore<Company> store = new ListStore<Company>(new ModelKeyProvider<Company>() {
@Override
public String getKey(Company item) {
return item.getId().toString();
}
});
// The Data proxy tells how to fetch the data
DataProxy<ListLoadConfig, ListLoadResult<Company>> proxy = new DataProxy<ListLoadConfig, ListLoadResult<Company>>() {
@Override
public void load(ListLoadConfig loadConfig, Callback<ListLoadResult<Company>, Throwable> callback) {
// A client example to show data fetching in a proxy
final List<Company> companies = new ArrayList<Company>();
for (int i = 0; i < 5; i++) {
Company company = getCompany(i);
companies.add(company);
}
ListLoadResult<Company> result = new ListLoadResultBean<Company>(companies);
callback.onSuccess(result);
}
};
// The Loader wiring
final ListLoader<ListLoadConfig, ListLoadResult<Company>> loader = new ListLoader<ListLoadConfig, ListLoadResult<Company>>(proxy);
loader.addLoadHandler(new LoadResultListStoreBinding<ListLoadConfig, Company, ListLoadResult<Company>>(store));
LabelProvider<Company> labelProvider = new LabelProvider<ComboboxExampleTest.Company>() {
@Override
public String getLabel(Company item) {
if (item.getName() == null) {
return "";
}
return item.getName();
}
};
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setLoader(loader);
Example using setLoader(loader)
using a RpcProxy.
// The Store
ListStore<Company> store = new ListStore<Company>(new ModelKeyProvider<Company>() {
@Override
public String getKey(Company item) {
return item.getId().toString();
}
});
// The Proxy
RpcProxy<ListLoadConfig, ListLoadResult<Company>> proxy = new RpcProxy<ListLoadConfig, ListLoadResult<Company>>() {
@Override
public void load(ListLoadConfig loadConfig, final AsyncCallback<ListLoadResult<Company>> asyncCallback) {
//rpcService.fetchData(loadConfig, asyncCallback);
}
};
// The Loader wiring
final ListLoader<ListLoadConfig, ListLoadResult<Company>> loader = new ListLoader<ListLoadConfig, ListLoadResult<Company>>(proxy);
loader.addLoadHandler(new LoadResultListStoreBinding<ListLoadConfig, Company, ListLoadResult<Company>>(store));
LabelProvider<Company> labelProvider = new LabelProvider<ComboboxExampleTest.Company>() {
@Override
public String getLabel(Company item) {
if (item.getName() == null) {
return "";
}
return item.getName();
}
};
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setLoader(loader);
Display loading HTML or text while the server is fetching the data. For html a image that spins could be used to display as loading.
Example using setLoadingText(text)
.
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setLoader(loader);
combo.setLoadingText("Loading...");
Example using setLoadingHtml(html)
.
ComboBox<Company> combo = new ComboBox<Company>(store, labelProvider);
combo.setLoader(loader);
combo.setLoadingHtml(SafeHtmlUtils.fromSafeConstant("<span style=\"color:red;\">Loading...</span>"));
Run validation and commit values on selection from the expanded list view by calling finishEditing on the list view collapse.
Example of finish editing on selection.
combo.addCollapseHandler(new CollapseHandler() {
@Override
public void onCollapse(CollapseEvent event) {
combo.finishEditing();
}
});