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, 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.

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.

Ext JS 6.0.1 - Modern Toolkit


top

Ext.direct.RemotingProvider alias: direct.remotingprovider

Summary

The Ext.direct.RemotingProvider exposes access to server side methods on the client (a remote procedure call (RPC) type of connection where the client can initiate a procedure on the server).

This allows for code to be organized in a fashion that is maintainable, while providing a clear path between client and server, something that is not always apparent when using URLs.

To accomplish this the server-side needs to describe what classes and methods are available on the client-side. This configuration will typically be outputted by the server-side Ext Direct stack when the API description is built.

No members found using the current filters

configs

Optional Configs

actions : Object

Object literal defining the server side actions and methods. For example, if the Provider is configured with:

 // each property within the 'actions' object represents a server side Class
 actions: {
     // array of methods in each server side Class to be stubbed out on client
     TestAction: [{
         name: 'doEcho',   // stub method will be TestAction.doEcho
         len:  1,
         batched: false    // always send requests immediately for this method
     }, {
         name: 'multiply', // name of method
         len:  2           // The number of parameters that will be used to create an
                           // array of data to send to the server side function.
     }, {
         name: 'doForm',
         formHandler: true // tells the client that this method handles form calls
     }],

     // These methods will be created in nested namespace TestAction.Foo
     'TestAction.Foo': [{
         name: 'ordered',  // stub method will be TestAction.Foo.ordered
         len:  1
     }, {
         name: 'noParams', // this method does not accept any parameters
         len:  0
     }, {
         name: 'named',    // stub method will be TestAction.Foo.named
         params: ['foo', 'bar']    // parameters are passed by name
     }, {
         name: 'namedNoStrict',
         params: [],       // this method accepts parameters by name
         strict: false     // but does not check if they are required
                           // and will pass any to the server side
     }]
 }

Note that starting with 4.2, dotted Action names will generate nested objects. If you wish to reverse to previous behavior, set cfg-disableNestedActions to true.

In the following example a client side handler is used to call the server side method "multiply" in the server-side "TestAction" Class:

 TestAction.multiply(
     // pass two arguments to server, so specify len=2
     2, 4,

     // callback function after the server is called
     //  result: the result returned by the server
     //       e: Ext.direct.RemotingEvent object
     // success: true or false
     // options: options to be applied to method call and passed to callback
     function (result, e, success, options) {
         var t, action, method;

         t = e.getTransaction();
         action = t.action; // server side Class called
         method = t.method; // server side method called

         if (e.status) {
             var answer = Ext.encode(result); // 8
         }
         else {
             var msg = e.message; // failure message
         }
     },

     // Scope to call the callback in (optional)
     window,

     // Options to apply to this method call. This can include
     // Ajax.request() options; only timeout is supported at this time.
     // When timeout is set for a method call, it will be executed immediately
     // without buffering.
     // The same options object is passed to the callback so it's possible
     // to "forward" some data when needed.
     {
         timeout: 60000, // milliseconds
         foo: 'bar'
     }
 );

In the example above, the server side "multiply" function will be passed two arguments (2 and 4). The "multiply" method should return the value 8 which will be available as the result in the callback example above.

bufferLimit : Number

The maximum number of requests to batch together. By default, an unlimited number of requests will be batched. This option will allow to wait only for a certain number of Direct method calls before dispatching a request to the server, even if enableBuffer timeout has not yet expired.

Note that this option does nothing if enableBuffer is set to false.

Defaults to:

Number.MAX_VALUE

disableNestedActions : Boolean

In versions prior to 4.2, using dotted Action names was not really meaningful, because it generated flat cfg-namespace object with dotted property names. For example, take this API declaration:

 {
     actions: {
         TestAction: [{
             name: 'foo',
             len:  1
         }],
         'TestAction.Foo' [{
             name: 'bar',
             len: 1
         }]
     },
     namespace: 'MyApp'
 }

Before 4.2, that would generate the following API object:

 window.MyApp = {
     TestAction: {
         foo: function() { ... }
     },
     'TestAction.Foo': {
         bar: function() { ... }
     }
 }

In Ext JS 4.2, we introduced new namespace handling behavior. Now the same API object will be like this:

 window.MyApp = {
     TestAction: {
         foo: function() { ... },

         Foo: {
             bar: function() { ... }
         }
     }
 }

Instead of addressing Action methods array-style MyApp['TestAction.Foo'].bar(), now it is possible to use object addressing: MyApp.TestAction.Foo.bar().

If you find this behavior undesirable, set this config option to true.

Defaults to:

false

enableBuffer : Number / Boolean

true or false to enable or disable combining of method calls. If a number is specified this is the amount of time in milliseconds to wait before sending a batched request.

Calls which are received within the specified timeframe will be concatenated together and sent in a single request, optimizing the application by reducing the amount of round trips that have to be made to the server. To cancel buffering for some particular invocations, pass timeout parameter in options object for that method call.

Defaults to:

10

enableUrlEncode : String

Specify which param will hold the arguments for the method.

Defaults to:

data

maxRetries : Number

Number of times to re-attempt delivery on failure of a call.

Defaults to:

1

namespace : String / Object

Namespace for the Remoting Provider (defaults to Ext.global). Explicitly specify the namespace Object, or specify a String to have a namespace created implicitly.

getNamespace ( root, action )
private pri

Get nested namespace by property.

Parameters

root :  Object

action :  Object

timeout : Number

The timeout to use for each request.

url : String

Required. The url to connect to the Ext.direct.Manager server-side router.

methods

Instance Methods

combineAndSend
private pri

Combine any buffered requests and send them off

configureFormRequest ( action, method, args )
private pri

Configure a form submission request

Parameters

action :  String

The action being executed

method :  Object

The method being executed

args :  Array

Method invocation arguments

configureRequest ( action, method )
private pri

Configure a direct request

Parameters

action :  String

The action being executed

method :  Object

The method being executed

configureTransaction ( action, method, args, isForm ) : Object
private pri

Configure a transaction for a Direct request

Parameters

action :  String

The action being executed

method :  Object

The method being executed

args :  Array

Method invocation arguments

isForm :  Boolean

True for a form submit

Returns

:Object

Transaction object

createHandler ( action, method ) : Function
private pri

Create a handler function for a direct call.

Parameters

action :  String

The action the call is for

method :  Object

The details of the method

Returns

:Function

A JS function that will kick off the call

createNamespaces ( root, action )
private pri

Create nested namespaces. Unlike Ext#ns this method supports nested objects as root of the namespace, not only Ext.global (window).

Parameters

root :  Object

action :  Object

getPayload ( transaction ) : Object
private pri

Gets the Ajax call info for a transaction

Parameters

transaction :  Ext.direct.Transaction

The transaction

Returns

:Object

The call params

getTransaction ( options ) : Ext.direct.Transaction
private pri

Get transaction from XHR options

Parameters

options :  Object

The options sent to the Ajax request

Returns

:Ext.direct.Transaction

The transaction, null if not found

initAPI
private pri

Initialize the API

onData ( options, success, response )
private pri

React to the ajax request being completed

Parameters

options :  Object

success :  Object

response :  Object

queueTransaction ( transaction )
private pri

Add a new transaction to the queue

Parameters

transaction :  Ext.direct.Transaction

The transaction

runCallback ( transaction, event )
private pri

Run any callbacks related to the transaction.

Parameters

transaction :  Ext.direct.Transaction

The transaction

event :  Ext.direct.Event

The event

sendFormRequest ( transaction )
private pri

Sends a form request

Parameters

transaction :  Ext.direct.Transaction

The transaction to send

sendRequest ( transaction )
private pri

Sends a request to the server

Parameters

transaction :  Object/Array

The transaction(s) to send

Static Methods

checkConfig ( config )
static sta private pri

Parameters

config :  Object

events

beforecall ( provider, transaction, meta, eOpts )
preventable prev

Fires immediately before the client-side sends off the RPC call. By returning false from an event handler you can prevent the call from being made.

Parameters

provider :  Ext.direct.RemotingProvider

transaction :  Ext.direct.Transaction

meta :  Object

The meta data

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

beforecallback ( provider, event, transaction, eOpts )
preventable prev

Fires before callback function is executed. By returning false from an event handler you can prevent the callback from executing.

Parameters

provider :  Ext.direct.RemotingProvider

The provider instance

event :  Ext.direct.Event

Event associated with the callback invocation

transaction :  Ext.direct.Transaction

Transaction for which the callback is about to be fired

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

call ( provider, transaction, meta, eOpts )

Fires immediately after the request to the server-side is sent. This does NOT fire after the response has come back from the call.

Parameters

provider :  Ext.direct.RemotingProvider

transaction :  Ext.direct.Transaction

meta :  Object

The meta data

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext JS 6.0.1 - Modern Toolkit