Ext JS 3.4.0

https://docs.sencha.com/extjs/3.4.0/
Admin
Ext JS is a comprehensive JavaScript framework for building rich, interactive web applications with...
Tokens:5,567
Snippets:33
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Ext.KeyNav

Source: https://docs.sencha.com/extjs/3.4.0/index

Handles navigation using keyboard events.

```APIDOC
## Ext.KeyNav

### Description
Handles navigation within a component or element using keyboard arrow keys and other common navigation keys.

### Methods
- **destroy**(): void - Destroys the KeyNav instance.
- **setDisabled**(disabled: boolean): void - Enables or disables the KeyNav.
```

--------------------------------

### Ext.KeyMap

Source: https://docs.sencha.com/extjs/3.4.0/index

Maps keyboard events to actions.

```APIDOC
## Ext.KeyMap

### Description
Provides a way to map keyboard events to specific actions or functions within an application.

### Methods
- **setDisabled**(disabled: boolean): void - Enables or disables the KeyMap.
```

--------------------------------

### Ext.QuickTip

Source: https://docs.sencha.com/extjs/3.4.0/index

Provides tooltips for elements.

```APIDOC
## Ext.QuickTip

### Description
Manages the display of tooltips for elements on the page, providing contextual information on hover.

### Methods
- **cancelShow**(): void - Cancels the scheduled display of a tooltip.
```

--------------------------------

### Ext.WindowGroup

Source: https://docs.sencha.com/extjs/3.4.0/index

Manages the stacking and behavior of multiple windows.

```APIDOC
## Ext.WindowGroup

### Description
Manages multiple `Ext.Window` instances, ensuring proper stacking order, focus management, and modality.

### Methods
- **register**(win: Ext.Window): void - Registers a window with the group.
- **unregister**(win: Ext.Window): void - Unregisters a window from the group.
```

--------------------------------

### Ext.Window

Source: https://docs.sencha.com/extjs/3.4.0/index

A floating dialog window.

```APIDOC
## Ext.Window

### Description
A floating dialog window that can contain other components. It supports features like dragging, resizing, minimization, and maximization.

### Methods
- **clearAnchor**(): void - Clears any anchoring of the window.
- **hideAnimDuration** (number): Duration of the hide animation in milliseconds.
- **initHidden** (boolean): Whether the window is initially hidden.
- **showAnimDuration** (number): Duration of the show animation in milliseconds.
```

--------------------------------

### Ext.Template

Source: https://docs.sencha.com/extjs/3.4.0/index

A client-side templating system.

```APIDOC
## Ext.Template

### Description
Provides a powerful client-side templating engine for generating HTML dynamically. It supports data binding, formatting, and conditional logic.

### Configuration
- **compiled** (boolean): Whether the template is compiled for performance.
- **disableFormats** (boolean): Disables format expressions within the template.
- **re** (RegExp): Regular expression used for parsing the template.
```

--------------------------------

### Ext.Panel

Source: https://docs.sencha.com/extjs/3.4.0/index

A container component with standard header, footer, and body.

```APIDOC
## Ext.Panel

### Description
A versatile container component that can hold other components and provides standard features like headers, footers, and toolbars.

### Configuration
- **bbarCfg** (object): Configuration object for the bottom toolbar.
- **bodyCssClass** (string): A CSS class to apply to the panel's body element.
- **bwrap** (Element): The body wrapper element.
- **bwrapCfg** (object): Configuration object for the body wrapper.
- **closable** (boolean): Whether the panel has a close button.
- **collapsed** (boolean): Whether the panel is initially collapsed.
- **fbar** (object): Configuration object for the footer toolbar.
- **getFooterToolbar**(): Ext.Toolbar - Returns the footer toolbar.
- **padding** (number or string): Padding for the panel body.
- **preventBodyReset** (boolean): Whether to prevent default body styling.
- **resizeEvent** (string): The event name to fire when the panel is resized.
- **tbarCfg** (object): Configuration object for the top toolbar.
- **unstyled** (boolean): Whether to apply default panel styling.
```

--------------------------------

### Ext.MessageBox

Source: https://docs.sencha.com/extjs/3.4.0/index

Displays standard alert, confirm, and prompt dialogs.

```APIDOC
## Ext.MessageBox

### Description
Provides a convenient way to display standard browser alert, confirm, and prompt dialog boxes, along with custom message boxes.

### Configuration
- **minPromptWidth** (number): The minimum width in pixels for prompt dialogs.
```

--------------------------------

### Ext.Fx

Source: https://docs.sencha.com/extjs/3.4.0/index

Provides animation and effects utilities.

```APIDOC
## Ext.Fx

### Description
Provides animation and effects utilities for Ext JS components.

### Methods
- **endOpacity**(): void - Sets the opacity of an element to 0.
```

--------------------------------

### Ext.Resizable

Source: https://docs.sencha.com/extjs/3.4.0/index

Enables resizing of elements.

```APIDOC
## Ext.Resizable

### Description
Adds resizing functionality to an element, allowing users to change its dimensions interactively.

### Configuration
- **enabled** (boolean): Whether resizing is enabled.
- **handleCls** (string): CSS class to apply to the resize handles.
```

--------------------------------

### Ext.Toolbar

Source: https://docs.sencha.com/extjs/3.4.0/index

A container for toolbar items like buttons and menus.

```APIDOC
## Ext.Toolbar

### Description
A container component used to arrange buttons, menus, and other controls in a horizontal or vertical bar.

### Configuration
- **buttonAlign** (string): Alignment of buttons within the toolbar ('left', 'center', 'right').
- **enableOverflow** (boolean): Whether to enable overflow handling for items.
- **layout** (string): The layout type for the toolbar items.
- **overflowchange**: Event fired when the toolbar's overflow state changes.
```

--------------------------------

### Ext.data.MemoryProxy

Source: https://docs.sencha.com/extjs/3.4.0/index

Loads data from a local JavaScript array.

```APIDOC
## Ext.data.MemoryProxy

### Description
A `DataProxy` that loads data directly from a local JavaScript array in memory. Useful for testing or small datasets.

### Methods
- **doRequest**(action: object, rs: Array, callback: Function, scope: object): void - Simulates the data request.
```

--------------------------------

### Ext.Toolbar.TextItem

Source: https://docs.sencha.com/extjs/3.4.0/index

A text item for Ext.Toolbar.

```APIDOC
## Ext.Toolbar.TextItem

### Description
A component that displays plain text within an `Ext.Toolbar`. Useful for labels or static text.

### Methods
- **setText**(text: string): void - Sets the text content of the item.
- **text** (string): The text content of the item.
```

--------------------------------

### Ext.Toolbar.Item

Source: https://docs.sencha.com/extjs/3.4.0/index

Base class for items within an Ext.Toolbar.

```APIDOC
## Ext.Toolbar.Item

### Description
Base class for all items that can be added to an `Ext.Toolbar`. Provides common functionality for toolbar elements.

### Configuration
- **hideParent** (boolean): Whether to hide the parent toolbar when this item is hidden.
- **overflowText** (string): Text to display for this item in the overflow menu.
```

--------------------------------

### Ext.data.DataProxy

Source: https://docs.sencha.com/extjs/3.4.0/index

Abstract base class for data proxies.

```APIDOC
## Ext.data.DataProxy

### Description
Abstract base class for data proxies, which handle the loading and writing of data from and to a remote source.

### Configuration
- **api** (object): An object containing specific API endpoint URLs for different actions (create, read, update, destroy).
- **beforewrite**: Event fired before a write operation (create, update, destroy).
- **doRequest**(action: object, rs: Array, callback: Function, scope: object): XMLHttpRequest - Performs the data request.
- **exception**: Event fired when a data loading or writing error occurs.
- **isApiAction**(action: string): boolean - Checks if an action is defined in the API configuration.
- **load**(proxy: Ext.data.DataProxy, params: object, reader: Ext.data.DataReader, callback: Function, scope: object): void - Loads data.
- **onRead**(response: object, callback: Function, scope: object): void - Handles the response from a read operation.
- **onWrite**(response: object, callback: Function, scope: object): void - Handles the response from a write operation.
- **request**(action: string, rs: Array, callback: Function, scope: object, params: object): void - Makes a data request.
- **restful** (boolean): Whether to use RESTful conventions for the API.
- **setApi**(api: object): void - Sets the API configuration.
- **write**(proxy: Ext.data.DataProxy, action: string, rs: Array, params: object, reader: Ext.data.DataReader, callback: Function, scope: object): void - Writes data.
```

--------------------------------

### Ext.EventManager

Source: https://docs.sencha.com/extjs/3.4.0/index

Provides constants for keyboard events and utility methods for managing event listeners.

```APIDOC
## Ext.EventManager

### Description
Constants for keyboard events and utility methods for event management.

### Properties
- **A** (any) - Represents the 'A' key.
- **ALT** (any) - Represents the 'Alt' key modifier.
- **B** (any) - Represents the 'B' key.
- **BACKSPACE** (any) - Represents the 'Backspace' key.
- **C** (any) - Represents the 'C' key.
- **CAPS_LOCK** (any) - Represents the 'Caps Lock' key.
- **CONTEXT_MENU** (any) - Represents the 'Context Menu' key.
- **CTRL** (any) - Represents the 'Ctrl' key modifier.
- **D** (any) - Represents the 'D' key.
- **DELETE** (any) - Represents the 'Delete' key.
- **DOWN** (any) - Represents the 'Down Arrow' key.
- **E** (any) - Represents the 'E' key.
- **EIGHT** (any) - Represents the '8' key.
- **END** (any) - Represents the 'End' key.
- **ENTER** (any) - Represents the 'Enter' key.
- **ESC** (any) - Represents the 'Escape' key.
- **F** (any) - Represents the 'F' key.
- **F1** (any) - Represents the 'F1' key.
- **F10** (any) - Represents the 'F10' key.
- **F11** (any) - Represents the 'F11' key.
- **F12** (any) - Represents the 'F12' key.
- **F2** (any) - Represents the 'F2' key.
- **F3** (any) - Represents the 'F3' key.
- **F4** (any) - Represents the 'F4' key.
- **F5** (any) - Represents the 'F5' key.
- **F6** (any) - Represents the 'F6' key.
- **F7** (any) - Represents the 'F7' key.
- **F8** (any) - Represents the 'F8' key.
- **F9** (any) - Represents the 'F9' key.
- **FIVE** (any) - Represents the '5' key.
- **FOUR** (any) - Represents the '4' key.
- **G** (any) - Represents the 'G' key.
- **H** (any) - Represents the 'H' key.
- **HOME** (any) - Represents the 'Home' key.
- **I** (any) - Represents the 'I' key.
- **INSERT** (any) - Represents the 'Insert' key.
- **J** (any) - Represents the 'J' key.
- **K** (any) - Represents the 'K' key.
- **L** (any) - Represents the 'L' key.
- **LEFT** (any) - Represents the 'Left Arrow' key.
- **M** (any) - Represents the 'M' key.
- **N** (any) - Represents the 'N' key.
- **NINE** (any) - Represents the '9' key.
- **NUM_CENTER** (any) - Represents the 'Num Center' key.
- **NUM_DIVISION** (any) - Represents the 'Num Division' key.
- **NUM_EIGHT** (any) - Represents the 'Num 8' key.
- **NUM_FIVE** (any) - Represents the 'Num 5' key.
- **NUM_FOUR** (any) - Represents the 'Num 4' key.
- **NUM_MINUS** (any) - Represents the 'Num Minus' key.
- **NUM_MULTIPLY** (any) - Represents the 'Num Multiply' key.
- **NUM_NINE** (any) - Represents the 'Num 9' key.
- **NUM_ONE** (any) - Represents the 'Num 1' key.
- **NUM_PERIOD** (any) - Represents the 'Num Period' key.
- **NUM_PLUS** (any) - Represents the 'Num Plus' key.
- **NUM_SEVEN** (any) - Represents the 'Num 7' key.
- **NUM_SIX** (any) - Represents the 'Num 6' key.
- **NUM_THREE** (any) - Represents the 'Num 3' key.
- **NUM_TWO** (any) - Represents the 'Num 2' key.
- **NUM_ZERO** (any) - Represents the 'Num 0' key.
- **O** (any) - Represents the 'O' key.
- **ONE** (any) - Represents the '1' key.
- **P** (any) - Represents the 'P' key.
- **PAGE_DOWN** (any) - Represents the 'Page Down' key.
- **PAGE_UP** (any) - Represents the 'Page Up' key.
- **PAUSE** (any) - Represents the 'Pause' key.
- **PRINT_SCREEN** (any) - Represents the 'Print Screen' key.
- **Q** (any) - Represents the 'Q' key.
- **R** (any) - Represents the 'R' key.
- **RETURN** (any) - Represents the 'Return' key (alias for Enter).
- **RIGHT** (any) - Represents the 'Right Arrow' key.
- **S** (any) - Represents the 'S' key.
- **SEVEN** (any) - Represents the '7' key.
- **SHIFT** (any) - Represents the 'Shift' key modifier.
- **SIX** (any) - Represents the '6' key.
- **SPACE** (any) - Represents the 'Space' key.
- **T** (any) - Represents the 'T' key.
- **TAB** (any) - Represents the 'Tab' key.
- **THREE** (any) - Represents the '3' key.
- **TWO** (any) - Represents the '2' key.
- **U** (any) - Represents the 'U' key.
- **UP** (any) - Represents the 'Up Arrow' key.
- **V** (any) - Represents the 'V' key.
- **W** (any) - Represents the 'W' key.
- **X** (any) - Represents the 'X' key.
- **Y** (any) - Represents the 'Y' key.
- **Z** (any) - Represents the 'Z' key.
- **ZERO** (any) - Represents the '0' key.

### Methods
- **checkReadyState**(): boolean - Checks if the document's ready state is complete.
- **fireDocReady**(): void - Fires the document ready event.
- **hasModifier**(e: Event): boolean - Checks if the event has any modifier keys pressed (Ctrl, Alt, Shift, Meta).
```

--------------------------------

### Ext.TabPanel

Source: https://docs.sencha.com/extjs/3.4.0/index

A container with a tabbed interface.

```APIDOC
## Ext.TabPanel

### Description
A container component that displays content in separate tabs, allowing users to switch between different views or sections.

### Methods
- **getTemplateArgs**(): object - Returns arguments for the template.
- **headerAsText** (boolean): Renders the header text directly.
- **itemTpl** (string or Ext.Template): Template for individual tab items.
- **layoutConfig** (object): Configuration for the tab layout.
```

--------------------------------

### Ext.data.HttpProxy

Source: https://docs.sencha.com/extjs/3.4.0/index

Loads data from a URL using HTTP requests.

```APIDOC
## Ext.data.HttpProxy

### Description
A `DataProxy` implementation that loads data from a specified URL using asynchronous HTTP requests (e.g., AJAX).

### Methods
- **doRequest**(action: object, rs: Array, callback: Function, scope: object): XMLHttpRequest - Performs the HTTP request.
- **onRead**(response: object, callback: Function, scope: object): void - Handles the response from an HTTP read request.
- **onWrite**(response: object, callback: Function, scope: object): void - Handles the response from an HTTP write request.
- **setUrl**(url: string): void - Sets the URL for the proxy.
```

--------------------------------

### Ext.data.ScriptTagProxy

Source: https://docs.sencha.com/extjs/3.4.0/index

Loads data using script tags (JSONP).

```APIDOC
## Ext.data.ScriptTagProxy

### Description
A `DataProxy` that loads data from a remote server by dynamically creating `<script>` tags. This is commonly used for JSONP requests.

### Methods
- **doRequest**(action: object, rs: Array, callback: Function, scope: object): void - Initiates the script tag request.
- **onRead**(response: object, callback: Function, scope: object): void - Handles the response from a script tag request.
- **onWrite**(response: object, callback: Function, scope: object): void - Handles the response from a script tag write request.
```

--------------------------------

### Ext.Toolbar.Spacer

Source: https://docs.sencha.com/extjs/3.4.0/index

An empty space item for Ext.Toolbar.

```APIDOC
## Ext.Toolbar.Spacer

### Description
A simple component that acts as a spacer within an `Ext.Toolbar`, providing horizontal or vertical spacing between other items.

### Configuration
- **width** (number): The width of the spacer (if horizontal).
```

--------------------------------

### Ext.PagingToolbar

Source: https://docs.sencha.com/extjs/3.4.0/index

A toolbar for navigating through pages of data.

```APIDOC
## Ext.PagingToolbar

### Description
A toolbar component designed for paginating through large datasets, typically used in conjunction with a `Store`.

### Configuration
- **afterPageText** (string): Text to display after the page number input.
- **beforePageText** (string): Text to display before the page number input.
- **bindStore**(store: Ext.data.Store): void - Binds the PagingToolbar to a new Store.
- **cursor** (Ext.data.Record): The current record.
- **doRefresh**(): void - Refreshes the current page of data.
- **firstText** (string): Tooltip for the first page button.
- **lastText** (string): Tooltip for the last page button.
- **moveFirst**(): void - Moves to the first page.
- **moveLast**(): void - Moves to the last page.
- **moveNext**(): void - Moves to the next page.
- **movePrevious**(): void - Moves to the previous page.
- **nextText** (string): Tooltip for the next page button.
- **pageSize** (number): The number of records to display per page.
- **prependButtons** (boolean): Whether to prepend the paging buttons to the toolbar.
- **prevText** (string): Tooltip for the previous page button.
- **refreshText** (string): Tooltip for the refresh button.
```

--------------------------------

### Ext.data.Store

Source: https://docs.sencha.com/extjs/3.4.0/index

Manages a client-side data store.

```APIDOC
## Ext.data.Store

### Description
Manages a collection of `Ext.data.Record` objects. It handles data loading, manipulation, and provides events for data changes. It can be linked to a `DataProxy` for remote data operations.

### Configuration
- **autoDestroy** (boolean): Whether to automatically destroy the store when it's no longer needed.
- **autoSave** (boolean): Whether to automatically save changes to the server.
- **batch** (object): Configuration for batching write operations.
- **beforesave**: Event fired before a save operation.
- **beforewrite**: Event fired before any write operation (create, update, destroy).
- **defaultParamNames** (object): Default parameter names for requests.
- **destroy**(): void - Destroys the store.
- **exception**: Event fired when an error occurs during data operations.
- **findExact**(fieldName: string, value: any, fromIndex: number = 0): number - Finds the index of the first record matching the given field value.
- **hasMultiSort** (boolean): Whether multi-sorting is enabled.
- **isDestroyed** (boolean): Indicates if the store has been destroyed.
- **multiSort** (object): Configuration for multi-
```

--------------------------------

### Ext.History

Source: https://docs.sencha.com/extjs/3.4.0/index

Manages browser history via URL fragments.

```APIDOC
## Ext.History

### Description
Manages browser history by utilizing URL fragments (`#`). This allows for bookmarkable states and back/forward navigation within single-page applications.

### Events
- **change**: Fires when the history token changes.
- **ready**: Fires when the history manager is ready to be used.
```

--------------------------------

### Ext.ToolTip

Source: https://docs.sencha.com/extjs/3.4.0/index

Displays a tooltip associated with an element.

```APIDOC
## Ext.ToolTip

### Description
A component that displays a tooltip when the mouse hovers over a target element, providing additional information.

### Configuration
- **anchorOffset** (number): Offset for the tooltip anchor.
- **anchorToTarget** (boolean): Whether the tooltip should anchor to the target element.
- **delegate** (string): A selector to specify which child elements trigger the tooltip.
- **triggerElement** (Element): The element that triggers the tooltip.
```

--------------------------------

### Ext.Layer

Source: https://docs.sencha.com/extjs/3.4.0/index

Manages an absolutely positioned element (layer).

```APIDOC
## Ext.Layer

### Description
Manages an absolutely positioned element, often used for tooltips, menus, and other floating elements. Provides methods for positioning, visibility, and styling.

### Methods
- **useDisplay**(): Ext.Layer - Configures the layer to use `display: none` for hiding instead of `visibility: hidden`.
```

--------------------------------

### Ext.data.GroupingStore

Source: https://docs.sencha.com/extjs/3.4.0/index

A store that supports grouping of records.

```APIDOC
## Ext.data.GroupingStore

### Description
Extends `Ext.data.Store` to provide data grouping capabilities. Records can be grouped based on a specified field.

### Configuration
- **groupDir** (string): The direction of sorting for groups ('ASC' or 'DESC').
- **groupchange**: Event fired when the grouping criteria changes.
```

--------------------------------

### Ext.SplitBar

Source: https://docs.sencha.com/extjs/3.4.0/index

A draggable bar used for adjusting sizes between components.

```APIDOC
## Ext.SplitBar

### Description
A draggable element that allows users to adjust the relative sizes of adjacent components, commonly used in layouts like `BorderLayout`.

### Configuration
- **tickSize** (number): The snap interval for the split bar movement.
```

--------------------------------

### Ext.data.Record

Source: https://docs.sencha.com/extjs/3.4.0/index

Represents a single data record.

```APIDOC
## Ext.data.Record

### Description
Represents a single data record within a `Store`. Each record is composed of fields defined by an `Ext.data.Record.create` configuration.

### Properties
- **id** (string): The unique identifier for the record.
- **isValid**(): boolean - Checks if the record is valid.
- **json** (object): The raw JSON data for the record.
- **markDirty**(dirty: boolean = true): void - Marks the record as dirty or not.
- **node** (Ext.data.Node): The associated tree node, if part of a tree.
- **phantom** (boolean): Whether the record is a new, unsaved record.
- **store** (Ext.data.Store): The store this record belongs to.
```

--------------------------------

### Ext.data.DataReader

Source: https://docs.sencha.com/extjs/3.4.0/index

Abstract base class for data readers.

```APIDOC
## Ext.data.DataReader

### Description
Abstract base class for data readers, responsible for parsing raw data returned from a `DataProxy` into `Record` objects.

### Methods
- **buildExtractors**(force: boolean): object - Builds the data extractor functions.
- **extractValues**(response: object): object - Extracts values from the raw response.
- **fields** (Array): An array of `Field` definitions.
- **getId**(data: object): string - Extracts the ID from a data object.
- **getMessage**(response: object): string - Extracts an error message from the response.
- **getRoot**(response: object): any - Extracts the root data array from the response.
- **getSuccess**(response: object): boolean - Extracts the success status from the response.
- **getTotal**(response: object): number - Extracts the total number of records from the response.
- **isData**(response: object): boolean - Checks if the response contains valid data.
- **messageProperty** (string): The property in the response containing the error message.
- **realize**(data: object): Ext.data.Record - Creates a `Record` instance from raw data.
- **update**(response: object): void - Updates the reader with new response data.
```

--------------------------------

### Ext.data.ArrayReader

Source: https://docs.sencha.com/extjs/3.4.0/index

Reads data from an array.

```APIDOC
## Ext.data.ArrayReader

### Description
A `DataReader` implementation that reads data from a simple JavaScript array.

### Configuration
- **idIndex** (number): The index within each array element that contains the record's ID.
```

--------------------------------

### Ext.data.Node

Source: https://docs.sencha.com/extjs/3.4.0/index

Represents a node in a tree structure.

```APIDOC
## Ext.data.Node

### Description
Represents a single node within a tree data structure. Provides methods for managing parent-child relationships and node attributes.

### Methods
- **destroy**(): void - Destroys the node and its children.
- **removeAll**(): void - Removes all child nodes.
- **setId**(id: string): void - Sets the ID of the node.
```

--------------------------------

### Ext.data.JsonReader

Source: https://docs.sencha.com/extjs/3.4.0/index

Reads data from JSON format.

```APIDOC
## Ext.data.JsonReader

### Description
A `DataReader` implementation that parses data from a JSON response.

### Configuration
- **idProperty** (string): The name of the property in the JSON response that contains the record's ID.
- **readResponse**(response: object): object - Reads and parses the JSON response.
```

--------------------------------

### Ext.data.Field

Source: https://docs.sencha.com/extjs/3.4.0/index

Defines a field for an Ext.data.Record.

```APIDOC
## Ext.data.Field

### Description
Defines a single field within an `Ext.data.Record`. Specifies the name, type, and other properties of a data field.

### Configuration
- **allowBlank** (boolean): Whether the field allows null or empty values.
- **constructor** (object): Configuration object for the field.
- **useNull** (boolean): Whether to use `null` for empty values.
```
Tokens:
Raw