docs.sencha.comDocs | Sencha Documentation

’); } if (DocsApp.meta.hasGuides) { document.write(’’); } if (DocsApp.meta.hasApi) { document.write(’’); } Docs Help Contents Terms, Icons, and Labels Access Levels Member Types Member Syntax Member Flags Class Icons Member Icons Navigation and Features Class Member Quick-Nav Menu Getter and Setter Methods History Bar Search and Filters API Doc Class Metadata Expanding and Collapsing Examples and Class Members Desktop -vs- Mobile View Viewing the Class Source 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. 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. Member Types Config - The configuration options for a class. Property - Set once a class is instantiated. *See Read Only below. Method - Actions that can be performed by a class. Methods should be read as instance methods and can only be called from a instance of a given class. Static methods that can be called directly from the class itself will have a static label next to the method name. *See Static below. Event - Events are specific to the framework event system allowing for classes to programmatically raise an event to be handled by one or more event handler methods. DOM events, while handled by the framework event system, are not specifically described within the API documentation. *For DOM events refer to the event reference page from MDN. Theme Variable - Variables used by the visual theme engine employed by the framework. Theme Mixin - Functions used by the visual theme engine employed by the framework and may use values set in various Theme Variables. 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). Ext.container.Container view source lookup Component ( 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: Expand/Collapse - On the left-hand size of the member row is a control used to expand and collapse each member row to show / hide member details. Member Name - The name of the class member ( lookupComponent in this example) Method Param - Any required or optional params used by a method (or passed to an event handler method) will be listed next to the method name within parenthesis ( ( item ) in this example) Return type - The class instance or javascript object returned by the method or property ( 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 ). Flags - Any flags applicable to the member will be displayed next ( PROTECTED in this example - see the Flags section below) Member Origin - On the right-hand side of the member row is the class where the member was initially described ( 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. Member Source - On the right-hand side below the member origin class is a link to view the member’s source ( view source in the example) Params List - Each param for a class method will be listed using the same name found above in parenthesis, the type of class or object expected, and a description of the param ( item : Object in the example). Returns - If a class returns a value other than undefined a "Returns" section will note the type of class or object returned and a description ( Ext.Component in the example) Since ( not shown in the example ) - Some members will show which version of the product the member was first introduced (i.e. Available since 3.4.0 - not pictured in the example ) just after the member description Default ( not shown in the example ) - Configs often show the default config value to be applied to a class instance if not overridden (i.e. Defaults to: false ) 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. Required - Required config when instantiating a class Bindable - The config has a setter which allows this config to be set via ViewModel binding Read Only - The property may be read, but cannot be used to configure / re-configure a class instance at runtime Singleton - Singleton classes are instantiated immediately once defined and may not be instantiated manually Static - A static method or property is a method or property belonging to the class itself, not an instance of the class Chainable - Refers to methods that return the class instance back when called. This enables chained method calls like: classInstance.method1().method2().etc(); Deprecated - A class or member that is scheduled for removal in a future framework version and is provided in the current version for backwards compatibility. Deprecated classes and members will have a message directing you to the preferred class / method going forward. Removed - A removed class or member that exists in documentation only as a reference for users upgrading between framework versions Template - A method defined within a base class designed to be overridden by subclasses Abstract - A class or member may be be defined as abstract. Abstract classes and members establish a class structure and provide limited, if any, code. Class-specific code will be furnished via overrides in subclasses. Preventable - Events marked preventable will not fire if false is returned from an event handler 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...