The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact.
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.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
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.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
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
Or in the case of an ExtReact component class this
indicates a member of type prop
- 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.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods section
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 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");
});
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.
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.
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
Specify which param will hold the arguments for the method. Defaults to 'data'.
Requred. This is the channel id defined in services-config.xml on the server (e.g. my-amf or my-http).
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.
Configure a form submission request
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
Configure a direct request
action : String
The action being executed
method : Object
The method being executed
args : Object
The argument to pass to the request
Create an event from an AMFX response object
response : Object
The AMFX response object
The event
Creates a set of events based on the XHR response
response : Object
The XHR response
An array of Ext.direct.Event
Create a handler function for a direct call.
action : String
The action the call is for
method : Object
The details of the method
A JS function that will kick off the call
Gets the Flex remoting message info for a transaction
transaction : Ext.direct.Transaction
The transaction
The Flex remoting message structure ready to encode in an AMFX RemoteMessage
Get transaction from XHR options
options : Object
The options sent to the Ajax request
The transaction, null if not found
React to the ajax request being completed
options : Object
success : Object
response : Object
Add a new transaction to the queue
transaction : Ext.direct.Transaction
The transaction
Run any callbacks related to the transaction.
transaction : Ext.direct.Transaction
The transaction
event : Ext.direct.Event
The event
Sends a form request
transaction : Ext.direct.Transaction
The transaction to send
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.
provider : Ext.direct.AmfRemotingProvider
transaction : Ext.direct.Transaction
meta : Object
The meta data
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires immediately after the request to the server-side is sent. This does NOT fire after the response has come back from the call.
provider : Ext.direct.AmfRemotingProvider
transaction : Ext.direct.Transaction
meta : Object
The meta data
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
ExtWebComponents | Terms of Use