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.2.1 - Modern Toolkit


top

Hierarchy

Ext.data.amf.XmlEncoder

Summary

This class serializes data in the Action Message Format XML (AMFX) format. It can write simple and complex objects, to be used in conjunction with an AMFX-compliant server. To create an encoded XMl, first construct an Encoder:

var encoder = Ext.create('Ext.data.amf.XmlEncoder');

Then use the writer methods to out data to the :

encoder.writeObject(1);
encoder.writeObject({a: "b"});

And access the data through the #bytes property: encoder.body;

You can also reset the class to start a new body:

encoder.clear();

Current limitations: AMF3 format (format:3)

  • Each object is written out explicitly, not using the reference tables supported by the AMFX format. This means the function does NOT support circular reference objects.
  • Objects that aren't Arrays, Dates, Strings, Document (XML) or primitive values will be written out as anonymous objects with dynamic data.
  • If the object has a $flexType field, that field will be used in signifying the object-type as an attribute, instead of being passed as data.
  • There's no JavaScript equivalent to the ByteArray type in ActionScript, hence data will never be searialized as ByteArrays by the writeObject function. A writeByteArray method is provided for writing out ByteArray objects.

For more information on working with AMF data please refer to the AMF Guide.

No members found using the current filters

properties

Instance Properties

body : String

The output string

Defaults to:

""

methods

Instance Methods

clear

Clears the accumulated data, starting with an empty string

constructor ( config )

Creates new encoder.

Parameters

config :  Object

Configuration options

convertXmlToString ( xml ) : String
private pri

Converts an XML Document object to a string.

Parameters

xml :  Object

XML document to convert (typically Document object)

Returns

:String
A string representing the document

encodeAmfxRemotingPacket ( message )

Encodes an AMFX remoting message with the AMFX envelope.

Parameters

message :  Ext.data.amf.RemotingMessage

the message to pass on to serialize.

encodeArray ( array )

Encodes an array, marking it as an ECMA array if it has associative (non-ordinal) indices

Parameters

array :  Array

the array to encode

encodeBoolean ( val )

Returns an encoded boolean

Parameters

val :  Boolean

a boolean value

encodeByteArray ( array )

Encodes a byte arrat in AMFX format

Parameters

array :  Array

the byte array to encode

encodeDate ( date )

Encode a date

Parameters

date :  Date

the date to encode

encodeDouble ( num )

Returns an encoded double

Parameters

num :  Number

the double to encode

encodeEcmaElement ( key, value ) : String
private pri

Encodes one ECMA array element

Parameters

key :  String

the name of the element

value :  Object

the value of the element

Returns

:String
the encoded key-value pair

encodeGenericObject ( obj ) : String

Encodes a generic object into AMFX format. If a $flexType member is defined, list that as the object type.

Parameters

obj :  Object

the object to encode

Returns

:String
the encoded text

encodeInt ( num )

Returns an encoded int

Parameters

num :  Number

the integer to encode

encodeNull String

Returns the encoding for null

Returns

:String

encodeNumber ( num )

Returns an encoded number. Decides wheter to use int or double encoding.

Parameters

num :  Number

the number to encode

encodeObject ( item ) : String

encode the appropriate data item. Supported types:

  • undefined
  • null
  • boolean
  • integer
  • double
  • UTF-8 string
  • XML Document (identified by being instaneof Document. Can be generated with: new DOMParser()).parseFromString(xml, "text/xml");
  • Date
  • Array
  • Generic object

Parameters

item :  Object

A primitive or object to write to the stream

Returns

:String
the encoded object in AMFX format

encodeString ( str )

Returns an encoded string

Parameters

str :  String

the string to encode

encodeUndefined

Returns the encoding for undefined (which is the same as the encoding for null)

encodeXml ( xml )

Encodes an xml document into a CDATA section

Parameters

xml :  XMLElement/HTMLElement

an XML document or element (Document type in some browsers)

isXmlDocument ( item ) : Boolean

Tries to determine if an object is an XML document

Parameters

item :  Object

to identify

Returns

:Boolean
true if it's an XML document, false otherwise

write ( str )
private pri

Appends a string to the body of the message

Parameters

str :  String

the string to append

writeAmfxRemotingPacket ( message )

Writes an AMFX remoting message with the AMFX envelope to the string.

Parameters

message :  Ext.data.amf.RemotingMessage

the message to pass on to serialize.

writeArray ( array )

Writes an array to the string, marking it as an ECMA array if it has associative (non-ordinal) indices

Parameters

array :  Array

the array to encode

writeBoolean ( val )

Writes a boolean value to the string

Parameters

val :  Boolean

a boolean value

writeByteArray ( array )

Writes an AMFX byte array to the string. This is for convenience only and is not called automatically by writeObject.

Parameters

array :  Array

the byte array to encode

writeDate ( date )

Write a date to the string

Parameters

date :  Date

the date to encode

writeDouble ( num )

Writes a double tag with the content.

Parameters

num :  Number

the double to encode

writeGenericObject ( obj )

Writes a generic object to the string. If a $flexType member is defined, list that as the object type.

Parameters

obj :  Object

the object to encode

writeInt ( num )

Writes a int tag with the content.

Parameters

num :  Number

the integer to encode

writeNull

Writes the null value to the string

writeNumber ( num )

Writes a number, deciding if to use int or double as the tag

Parameters

num :  Number

the number to encode

writeObject ( item )

Writes the appropriate data item to the string. Supported types:

  • undefined
  • null
  • boolean
  • integer
  • double
  • UTF-8 string
  • XML Document (identified by being instaneof Document. Can be generated with: new DOMParser()).parseFromString(xml, "text/xml");
  • Date
  • Array
  • Generic object

Parameters

item :  Object

A primitive or object to write to the stream

writeString ( str )

Writes a string tag with the string content.

Parameters

str :  String

the string to encode

writeUndefined

Writes the undefined value to the string

writeXml ( xml )

Write an XML document to the string

Parameters

xml :  XMLElement/HTMLElement

an XML document or element (Document type in some browsers)
Static Methods

generateFlexUID ( id ) : String
static sta

Utility function to generate a flex-friendly UID

Parameters

id :  Number

used in the first 8 chars of the id. If not provided, a random number will be used.

Returns

:String
a string-encoded opaque UID

Ext JS 6.2.1 - Modern Toolkit