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

Ext.String singleton

Hierarchy

Ext.String

Summary

A collection of useful static methods to deal with strings.

No members found using the current filters

properties

Instance Properties

fromCodePoint

Creates a string created by using the specified sequence of code points.

Defaults to:

String.fromCodePoint || function() {
    var codePoint,
        result = '',
        codeUnits = [],
        index = -1,
        length = arguments.length;
    while (++index < length) {
        codePoint = Number(arguments[index]);
        if (!isFinite(codePoint) || // `NaN`, `+Infinity`, or `-Infinity`
        codePoint < 0 || // not a valid Unicode code point
        codePoint > 1114111 || // not a valid Unicode code point
        Math.floor(codePoint) !== codePoint) // not an integer
        {
            Ext.raise('Invalid code point: ' + codePoint);
        }
        if (codePoint <= 65535) {
            // BMP code point
            codeUnits.push(codePoint);
        } else {
            // Astral code point; split in surrogate halves
            // http://mathiasbynens.be/notes/javascript-encoding#surrogate-formulae
            codePoint -= 65536;
            codeUnits.push((codePoint >> 10) + 55296, (codePoint % 1024) + 56320);
        }
        if (index + 1 === length) {
            result += fromCharCode(codeUnits);
            codeUnits.length = 0;
        }
    }
    return result;
}

Parameters

codePoint :  Number...

Codepoints from which to build the string.

Returns

:String

A string built from the sequence of code points passed.

methods

Instance Methods

addCharacterEntities ( newEntities )

Adds a set of character entity definitions to the set used by Ext.String#htmlEncode and Ext.String#htmlDecode.

This object should be keyed by the entity name sequence, with the value being the textual representation of the entity.

 Ext.String.addCharacterEntities({
     '&amp;Uuml;':'Ü',
     '&amp;ccedil;':'ç',
     '&amp;ntilde;':'ñ',
     '&amp;egrave;':'è'
 });
 var s = Ext.String.htmlEncode("A string with entities: èÜçñ");

Note: the values of the character entities defined on this object are expected to be single character values. As such, the actual values represented by the characters are sensitive to the character encoding of the JavaScript source file when defined in string literal form. Script tags referencing server resources with character entities must ensure that the 'charset' attribute of the script node is consistent with the actual character encoding of the server resource.

The set of character entities may be reset back to the default state by using the Ext.String#resetCharacterEntities method

Parameters

newEntities :  Object

The set of character entities to add to the current definitions.

capitalize ( string ) : String

Capitalize the first letter of the given string.

Parameters

string :  String

Returns

:String

createRegex ( value, [startsWith], [endsWith], [ignoreCase] ) : RegExp

Creates a RegExp given a string value and optional flags. For example, the following two regular expressions are equivalent.

 var regex1 = Ext.String.createRegex('hello');

 var regex2 = /^hello$/i;

The following two regular expressions are also equivalent:

 var regex1 = Ext.String.createRegex('world', false, false, false);

 var regex2 = /world/;

Available since: 5.0.0

Parameters

value :  String/RegExp

The String to convert to a RegExp.

startsWith :  Boolean (optional)

Pass false to allow a match to start anywhere in the string. By default the value will match only at the start of the string.

Defaults to: true

endsWith :  Boolean (optional)

Pass false to allow the match to end before the end of the string. By default the value will match only at the end of the string.

Defaults to: true

ignoreCase :  Boolean (optional)

Pass false to make the RegExp case sensitive (removes the 'i' flag).

Defaults to: true

Returns

:RegExp

createVarName ( s ) : String

Converts a string of characters into a legal, parse-able JavaScript var name as long as the passed string contains at least one alphabetic character. Non alphanumeric characters, and leading non alphabetic characters will be removed.

Parameters

s :  String

A string to be converted into a var name.

Returns

:String

A legal JavaScript var name.

ellipsis ( value, length, [word] ) : String

Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.

Parameters

value :  String

The string to truncate.

length :  Number

The maximum length to allow before truncating.

word :  Boolean (optional)

true to try to find a common word break.

Defaults to: false

Returns

:String

The converted text.

endsWith ( s, end, [ignoreCase] )

Checks if a string ends with a substring

Parameters

s :  String

The original string

end :  String

The substring to check

ignoreCase :  Boolean (optional)

True to ignore the case in the comparison

Defaults to: false

escape ( string ) : String

Escapes the passed string for ' and .

Parameters

string :  String

The string to escape.

Returns

:String

The escaped string.

escapeRegex ( string ) : String

Escapes the passed string for use in a regular expression.

Parameters

string :  String

The string to escape.

Returns

:String

The escaped string.

format ( string, values ) : String

Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each token must be unique, and must increment in the format {0}, {1}, etc. Example usage:

var cls = 'my-class',
    text = 'Some text';
var s = Ext.String.format('<div class="{0}">{1}</div>', cls, text);
// s now contains the string: '<div class="my-class">Some text</div>'

Parameters

string :  String

The tokenized string to be formatted.

values :  Mixed...

The values to replace tokens {0}, {1}, etc in order.

Returns

:String

The formatted string.

hasHtmlCharacters ( s ) : Boolean
private pri

Checks if a string has values needing to be html encoded.

Parameters

s :  String

The string to test

Returns

:Boolean

true if the string contains HTML characters

htmlDecode ( value ) : String

Convert certain characters (&, <, >, ', and ") from their HTML character equivalents.

Parameters

value :  String

The string to decode.

Returns

:String

The decoded text.

htmlEncode ( value ) : String

Convert certain characters (&, <, >, ', and ") to their HTML character equivalents for literal display in web pages.

Parameters

value :  String

The string to encode.

Returns

:String

The encoded text.

insert ( s, value, index ) : String

Inserts a substring into a string.

Parameters

s :  String

The original string.

value :  String

The substring to insert.

index :  Number

The index to insert the substring. Negative indexes will insert from the end of the string. Example:

Ext.String.insert("abcdefg", "h", -1); // abcdefhg

Returns

:String

The value with the inserted substring

leftPad ( string, size, [character] ) : String

Pads the left side of a string with a specified character. This is especially useful for normalizing number and date strings. Example usage:

var s = Ext.String.leftPad('123', 5, '0');
// s now contains the string: '00123'

Parameters

string :  String

The original string.

size :  Number

The total length of the output string.

character :  String (optional)

The character with which to pad the original string.

Defaults to: ' '

Returns

:String

The padded string.

repeat ( pattern, count, sep )

Returns a string with a specified number of repetitions a given string pattern. The pattern be separated by a different string.

 var s = Ext.String.repeat('---', 4); // = '------------'
 var t = Ext.String.repeat('--', 3, '/'); // = '--/--/--'

Parameters

pattern :  String

The pattern to repeat.

count :  Number

The number of times to repeat the pattern (may be 0).

sep :  String

An option string to separate each pattern.

resetCharacterEntities

Resets the set of character entity definitions used by Ext.String#htmlEncode and Ext.String#htmlDecode back to the default state.

splitWords ( words )

Splits a string of space separated words into an array, trimming as needed. If the words are already an array, it is returned.

Parameters

words :  String/Array

startsWith ( s, start, [ignoreCase] )

Checks if a string starts with a substring

Parameters

s :  String

The original string

start :  String

The substring to check

ignoreCase :  Boolean (optional)

True to ignore the case in the comparison

Defaults to: false

toggle ( string, value, other ) : String

Utility function that allows you to easily switch a string between two alternating values. The passed value is compared to the current string, and if they are equal, the other value that was passed in is returned. If they are already different, the first value passed in is returned. Note that this method returns the new value but does not change the current string.

// alternate sort directions
sort = Ext.String.toggle(sort, 'ASC', 'DESC');

// instead of conditional logic:
sort = (sort === 'ASC' ? 'DESC' : 'ASC');

Parameters

string :  String

The current string.

value :  String

The value to compare to the current string.

other :  String

The new value to use if the string already equals the first value passed in.

Returns

:String

The new value.

trim ( string ) : String

Trims whitespace from either end of a string, leaving spaces within the string intact. Example:

var s = '  foo bar  ';
alert('-' + s + '-');                   //alerts "- foo bar -"
alert('-' + Ext.String.trim(s) + '-');  //alerts "-foo bar-"

Parameters

string :  String

The string to trim.

Returns

:String

The trimmed string.

uncapitalize ( string ) : String

Uncapitalize the first letter of a given string.

Parameters

string :  String

Returns

:String

urlAppend ( url, string ) : String

Appends content to the query string of a URL, handling logic for whether to place a question mark or ampersand.

Parameters

url :  String

The URL to append to.

string :  String

The content to append to the URL.

Returns

:String

The resulting URL

Ext JS 6.2.1 - Modern Toolkit