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.

Sencha Test 2.2.0


top

Hierarchy

ST.Version

Summary

A utility class that wraps around a version number string and provides convenient methods to perform comparisons. A version number is expressed in the following general format:

major[.minor[.patch[.build[release]]]]

The Version instance holds various readonly properties that contain the digested form of the version string. The numeric componnets of major, minor, patch and build as well as the textual suffix called release.

Not depicted in the above syntax are three possible prefixes used to control partial matching. These are '^' (the default), '>' and '~'. These are discussed below.

Examples:

var version = new ST.Version('1.0.2beta'); // or maybe "1.0" or "1.2.3.4RC"
console.log("Version is " + version); // Version is 1.0.2beta

console.log(version.getMajor()); // 1
console.log(version.getMinor()); // 0
console.log(version.getPatch()); // 2
console.log(version.getBuild()); // 0
console.log(version.getRelease()); // beta

The understood values of release are assigned numberic equivalents for the sake of comparsion. The order of these from smallest to largest is as follows:

  • "dev"
  • "alpha" or "a"
  • "beta" or "b"
  • "RC" or "rc"
  • "#"
  • "pl" or "p"

Any other (unrecognized) suffix is consider greater than any of these.

Comparisons

There are two forms of comparison that are commonly needed: full and partial. Full comparison is simpler and is also the default.

Example:

var version = new ST.Version('1.0.2beta');

console.log(version.isGreaterThan('1.0.1')); // True
console.log(version.isGreaterThan('1.0.2alpha')); // True
console.log(version.isGreaterThan('1.0.2RC')); // False
console.log(version.isGreaterThan('1.0.2')); // False
console.log(version.isLessThan('1.0.2')); // True

console.log(version.match(1.0)); // True (using a Number)
console.log(version.match('1.0.2')); // True (using a String)

These comparisons are ultimately implemented by compareTo which returns -1, 0 or 1 depending on whether the `Version' instance is less than, equal to, or greater than the given "other" version.

For example:

 var n = version.compareTo('1.0.1');  // == 1  (because 1.0.2beta > 1.0.1)

 n = version.compareTo('1.1');  // == -1
 n = version.compareTo(version); // == 0

Partial Comparisons

By default, unspecified version number fields are filled with 0. In other words, the version number fields are 0-padded on the right or a "lower bound". This produces the most commonly used forms of comparsion:

 var ver = new Version('4.2');

 n = ver.compareTo('4.2.1'); // == -1  (4.2 promotes to 4.2.0 and is less than 4.2.1)

There are two other ways to interpret comparisons of versions of different length. The first of these is to change the padding on the right to be a large number (scuh as Infinity) instead of 0. This has the effect of making the version an upper bound. For example:

 var ver = new Version('^4.2'); // NOTE: the '^' prefix used

 n = ver.compareTo('4.3'); // == -1  (less than 4.3)

 n = ver.compareTo('4.2'); // == 1   (greater than all 4.2's)
 n = ver.compareTo('4.2.1'); // == 1
 n = ver.compareTo('4.2.9'); // == 1

The second way to interpret this comparison is to ignore the extra digits, making the match a prefix match. For example:

 var ver = new Version('~4.2'); // NOTE: the '~' prefix used

 n = ver.compareTo('4.3'); // == -1

 n = ver.compareTo('4.2'); // == 0
 n = ver.compareTo('4.2.1'); // == 0

This final form can be useful when version numbers contain more components than are important for certain comparisons. For example, the full version of Ext JS 4.2.1 is "4.2.1.883" where 883 is the build number.

This is how to create a "partial" Version and compare versions to it:

 var version421ish = new Version('~4.2.1');

 n = version421ish.compareTo('4.2.1.883'); // == 0
 n = version421ish.compareTo('4.2.1.2'); // == 0
 n = version421ish.compareTo('4.2.1'); // == 0

 n = version421ish.compareTo('4.2'); // == 1

In the above example, '4.2.1.2' compares as equal to '4.2.1' because digits beyond the given "4.2.1" are ignored. However, '4.2' is less than the '4.2.1' prefix; its missing digit is filled with 0.

No members found using the current filters

properties

Instance Properties

build : Number
readonly ro

The fourth numeric part of the version number string.

Defaults to:

parts[3] || pad

major : Number
readonly ro

The first numeric part of the version number string.

Defaults to:

parts[0] || pad

minor : Number
readonly ro

The second numeric part of the version number string.

Defaults to:

parts[1] || pad

parts : Number[]
readonly ro private pri

The split array of version number components found in the version string. For example, for "1.2.3", this would be [1, 2, 3].

Defaults to:

parts = ver.split('.')

patch : Number
readonly ro

The third numeric part of the version number string.

Defaults to:

parts[2] || pad

release : String
readonly ro

The release level. The following values are understood:

  • "dev"
  • "alpha" or "a"
  • "beta" or "b"
  • "RC" or "rc"
  • "#"
  • "pl" or "p"

Defaults to:

""

methods

Instance Methods

compareTo ( other ) : Number

Compares this version instance to the specified other version.

Parameters

other :  String/Number/ST.Version

The other version to which to compare.

Returns

:Number

-1 if this version is less than the target version, 1 if this version is greater, and 0 if they are equal.

equals ( target ) : Boolean

Returns whether this version equals to the supplied argument

Parameters

target :  String/Number

The version to compare with

Returns

:Boolean

true if this version equals to the target, false otherwise

getBuild Number

Returns the build component value.

Returns

:Number

getMajor Number

Returns the major component value.

Returns

:Number

getMinor Number

Returns the minor component value.

Returns

:Number

getPatch Number

Returns the patch component value.

Returns

:Number

getRelease String

Returns the release component text (e.g., "beta").

Returns

:String

getReleaseValue Number/String

Returns the release component value for comparison purposes.

Returns

:Number/String

getShortVersion String

Returns shortVersion version without dots and release

Returns

:String

gt ( target ) : Boolean

Convenient alias to isGreaterThan

Parameters

target :  String/Number/ST.Version

Returns

:Boolean

gtEq ( target ) : Boolean

Convenient alias to isGreaterThanOrEqual

Parameters

target :  String/Number/ST.Version

Returns

:Boolean

isGreaterThan ( target ) : Boolean

Returns whether this version if greater than the supplied argument

Parameters

target :  String/Number

The version to compare with

Returns

:Boolean

true if this version if greater than the target, false otherwise

isGreaterThanOrEqual ( target ) : Boolean

Returns whether this version if greater than or equal to the supplied argument

Parameters

target :  String/Number

The version to compare with

Returns

:Boolean

true if this version if greater than or equal to the target, false otherwise

isLessThan ( target ) : Boolean

Returns whether this version if smaller than the supplied argument

Parameters

target :  String/Number

The version to compare with

Returns

:Boolean

true if this version if smaller than the target, false otherwise

isLessThanOrEqual ( target ) : Boolean

Returns whether this version if less than or equal to the supplied argument

Parameters

target :  String/Number

The version to compare with

Returns

:Boolean

true if this version if less than or equal to the target, false otherwise

lt ( target ) : Boolean

Convenient alias to isLessThan

Parameters

target :  String/Number/ST.Version

Returns

:Boolean

ltEq ( target ) : Boolean

Convenient alias to isLessThanOrEqual

Parameters

target :  String/Number/ST.Version

Returns

:Boolean

match ( target ) : Boolean

Returns whether this version matches the supplied argument. Example:

var version = new ST.Version('1.0.2beta');
console.log(version.match(1)); // true
console.log(version.match(1.0)); // true
console.log(version.match('1.0.2')); // true
console.log(version.match('1.0.2RC')); // false

Parameters

target :  String/Number

The version to compare with

Returns

:Boolean

true if this version matches the target, false otherwise

toArray Number[]

Returns this format: [major, minor, patch, build, release]. Useful for comparison.

Returns

:Number[]

toString String
private pri

Override the native toString method

Returns

:String

version

valueOf String
private pri

Override the native valueOf method

Returns

:String

version

Sencha Test 2.2.0