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. Note that filtering out private members also filters the API class navigation tree.

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 Web Application Manager 6.0.0

Guides
API
top

Ext.space.Window singleton

Filters
Related Classes

Summary

Ext.space.Window is an API that allows you to create child web views and do simple management with them (e.g., open, close, navigate).

To create a child web view:

Sample Code
 var child = window.open("http://example.com/");

 child.open("http://another.example.com/somewhere/somehow.html");
 // ... later:
 child.close();

 // close all open children
 Ext.space.Window.closeAll();
No members found using the current filters

properties

_ready
private pri

Defaults to: null

namedWindows : Object
private pri

Internal collection of child web views, by name

Defaults to: null

windows : Object
private pri

Internal collection of child web views, by ID

Defaults to: null

methods

_featuresToObject ( featuresString ) : Object
private pri

Transform from a window.open()-style comma separated string of features to a regular object hash.

It turns something like "foo=bar,spam=eggs" into {foo: "bar", spam: "eggs"}, but note that it doesn't normalize different styles of boolean values, so, e.g., "true", "TRUE", "on", 1, etc. don't all get turned to a boolean true or anything like that.

Parameters

featuresString :  String / Object

Comma separated features string, or an object hash that will be passed through unmodified.

Returns

:Object

Object hash version of the features specified.

close ( childOrHandle ) : Ext.space.Promise

Close the given child web view.

Parameters

childOrHandle :  String / Ext.space.window.Child

Child web view, or ID thereof

Returns

:Ext.space.Promise

Promise that resolves when the child view is closed

closeAll : Ext.space.Promise

Close all open child web views.

Returns

:Ext.space.Promise

Promise that resolves when the child views are all closed

getChildren : Ext.space.Promise

Fetch an array of child web views currently open.

Returns

:Ext.space.Promise

Promise that resolves with an array of Ext.space.window.Child objects

navigate ( childOrHandle , url ) : Ext.space.Promise

Navigate the provided child web view to the given URL.

Parameters

childOrHandle :  String / Ext.space.window.Child

Child web view, or ID thereof

url :  String

URL to open

Returns

:Ext.space.Promise

Promise that resolves once the navigation operation is dispatched; note that this is not the same thing as the URL being completely loaded. For that, you need to add a listener for the child view's 'loadstop' event.

open ( url , [name] , featuresStringOrObject ) : Ext.space.window.Child

Open a child web view.

In Sencha Web Application Client, window.open() is aliased to this function, so while you can call the explicitly namespaced version here, typically you just do something like:

Sample Code
var child = window.open("http://example.com/");

Parameters

url :  String

URL to open

name :  String (optional)

Application-specific name to give the child web view. Just like in a regular browser context, calling window.open twice with the same name will reuse the same child web view. Similarly, specifying the name as "_blank" will always open a new child web view.

featuresStringOrObject :  String / Object

Comma separated features string of the form normally expected by window.open ("foo=bar,spam=eggs", etc...), or an object hash containing the same information ({foo: "bar", spam: "eggs"}).

Returns

:Ext.space.window.Child

Child web view, or null if the URL was invalid.

Sencha Web Application Manager 6.0.0

Ext JS
Sencha Test
Cmd
GXT
IDE Plugins
Sencha Inspector
Architect
Touch
Web Application Manager

Sencha Test

Sencha Test

Cmd

Cmd

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Web Application Manager

Web Application Manager