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 7.3.0 - Classic Toolkit


top

NPM Package

@sencha/ext-amf

Hierarchy

Ext.direct.AmfRemotingProvider

Summary

The Ext.direct.AmfRemotingProvider allows making RPC calls to a Java object on a BlazeDS or ColdFusion using either the AMFX or the AMF protocols.

The default protocol is AMFX which works on all browsers. If you choose AMF, a flash plugin might be loaded in certain browsers that do not support posting binary data to the server, e.g. Internet Explorer version 9 or less. To choose AMF, set the binary property to true.

For AMFX, the server must be configured to expose the desired services via an HTTPEndpoint. For example, the following configuration snippet adds an HTTPEndpoint (AMFX endpoint) to the BlazeDS services-config.xml file:


<channel-definition id="my-http" class="mx.messaging.channels.HTTPChannel">
 <endpoint url="http://{server.name}:{server.port}/{context.root}/messagebroker/http" class="flex.messaging.endpoints.HTTPEndpoint"/>
</channel-definition>
 

Once the HTTPEndpoint is configured, make sure the service is exposed via the channel by adding the channel (e.g. my-http) to your remoting-services.xml file. For example this allows services to be accessed remotely by both AMF and AMFX:


<default-channels>
 <channel ref="my-amf"/>
 <channel ref="my-http"/>
</default-channels>
 

In order to make a call, you first need to declare the API to Ext direct. The following example defines local methods to the services provided by the sample Products application provided by Adobe as part of the BlazeDS 4.x binary turnkey distribution's testdrive (Sample 5: Updating Data):


    Ext.direct.Manager.addProvider({
        "url":"/samples/messagebroker/http", // URL for the HTTPEndpoint
        "type":"amfremoting",
        "endpoint": "my-http", // the name of the HTTPEndpoint channel as defined in the server's services-config.xml
        "actions":{
        "product":[{ // name of the destination as defined in remoting-config.xml on the server
            "name":"getProducts", // method name of the method to call
            "len":0 // number of parameters
        },{
            "name":"add",
            "len":1
        },{
            "name":"bad",
            "len":0
        }]
        }
    });

 

You can now call the service as follows:


product.getProducts((function(provider, response) {
    // do something with the response
    console.log("Got " + response.data.length + " objects");
});
Note that in case server methods require parameters of a specific class (e.g. flex.samples.product.Product), you should make sure the passed parameter has a field called $flexType set to the class name (in this case flex.Samples.product.Product). This is similar to the remote class alias definition in ActionScript.

The following example shows how to define a binary AMF-based call:


    Ext.direct.Manager.addProvider({
        "url":"/samples/messagebroker/amf", // URL for the AMFEndpoint
        "type":"amfremoting",
        "endpoint": "my-amf", // the name of the AMFEndpoint channel as defined in the server's services-config.xml
        "binary": true, // chooses AMF encoding
        "actions":{
        "product":[{ // name of the destination as defined in remoting-config.xml on the server
            "name":"getProducts", // method name of the method to call
            "len":0 // number of parameters
        },{
            "name":"add",
            "len":1
        },{
            "name":"bad",
            "len":0
        }]
        }
    });

 

Calling the server is done the same way as for the AMFX-based definition.

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:


"actions":{ // each property within the 'actions' object represents a server side Class
    "TestAction":[ // array of methods within each server side Class to be
    {              // stubbed out on client
        "name":"doEcho",
        "len":1
    },{
        "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.
                          // Ensure the server sends back a Number, not a String.
    },{
        "name":"doForm",
        "formHandler":true, // direct the client to use specialized form handling method
        "len":1
    }]
}
 

Note that a Store is not required, a server method can be called at any time. 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(
    2, 4, // pass two arguments to server, so specify len=2
    // callback function after the server is called
    // result: the result returned by the server
    //      e: Ext.direct.RemotingEvent object
    function(result, e) {
        var t = e.getTransaction();
        var action = t.action; // server side Class called
        var method = t.method; // server side method called
        if(e.status) {
            var answer = Ext.encode(result); // 8

    } else {
        var msg = e.message; // failure message
    }
}

);

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 example above.

binary : String

If true, use AMF binary encoding instead of AMFX XML-based encoding. Note that on some browsers, this will load a flash plugin to handle binary communication with the server. Important: If using binary encoding with older browsers, see notes in Ext.data.flash.BinaryXhr regarding packaging the Flash plugin for use in older browsers.

Defaults to:

false

enableUrlEncode : String

Specify which param will hold the arguments for the method. Defaults to 'data'.

endpoint : String

Requred. This is the channel id defined in services-config.xml on the server (e.g. my-amf or my-http).

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 the browser global scope of window). Explicitly specify the namespace Object, or specify a String to have a namespace created implicitly.

timeout : Number

The timeout to use for each request.

Defaults to:

undefined

url : String

Required. The URL to connect to the Flex remoting server (LCDS, BlazeDS, etc). This should include the /messagebroker/amf suffix as defined in the services-config.xml and remoting-config.xml files.

properties

methods

Instance Methods

combineAndSend
private pri

Combine any buffered requests and send them off

configureFormRequest ( action, method, form, [callback], [scope] )
private pri

Configure a form submission request

Parameters

action :  String

The action being executed

method :  Object

The method being executed

form :  HTMLElement

The form being submitted

callback :  Function (optional)

A callback to run after the form submits

scope :  Object (optional)

A scope to execute the callback in

configureRequest ( action, method, args )
private pri

Configure a direct request

Parameters

action :  String

The action being executed

method :  Object

The method being executed

args :  Object

The argument to pass to the request

createEvent ( response ) : Ext.direct.Event

Create an event from an AMFX response object

Parameters

response :  Object

The AMFX response object

Returns

:Ext.direct.Event

The event

createEvents ( response ) : Ext.direct.Event[]
private pri

Creates a set of events based on the XHR response

Parameters

response :  Object

The XHR response

Returns

:Ext.direct.Event[]

An array of Ext.direct.Event

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

getCallData ( transaction ) : Object
private pri

Gets the Flex remoting message info for a transaction

Parameters

transaction :  Ext.direct.Transaction

The transaction

Returns

:Object

The Flex remoting message structure ready to encode in an AMFX RemoteMessage

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 ( data )
private pri

Sends a request to the server

Parameters

data :  Object/Array

The data to send

events

beforecall ( provider, transaction, meta, eOpts )

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

Parameters

provider :  Ext.direct.AmfRemotingProvider

transaction :  Ext.direct.Transaction

meta :  Object

The meta data

eOpts : Object

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

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

transaction :  Ext.direct.Transaction

meta :  Object

The meta data

eOpts : Object

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

Ext JS 7.3.0 - Classic Toolkit