To be applied to a class instance if not overridden (i.e.
Default ( not shown in the example) - Configs often show the default config value. The example) just after the member description Product the member was first introduced (i.e. Since ( not shown in the example) - Some members will show which version of the. Will note the type of class or object returned and a description ( Ext.Component in the Returns - If a class returns a value other than undefined a "Returns" section. The param ( item : Object in the example). Params List - Each param for a class method will be listed using the same nameįound above in parenthesis, the type of class or object expected, and a description of. View the member's source ( view source in the example) Member Source - On the right-hand side below the member origin class is a link to. The sourceĬlass will be displayed as a blue link if the member originates from the current classĪnd gray if it is inherited from an ancestor or mixed-in class. Member was initially described ( in this example). Member Origin - On the right-hand side of the member row is the class where the. This example - see the Flags section below) Flags - Any flags applicable to the member will be displayed next ( PROTECTED in. Successful or false if unsuccessful which would be displayed as a method may return a Component if a get method calls is Separated by a forward slash / signifying that what is returned may depend on the Return anything other than undefined or may display as multiple possible values This may be omitted for methods that do not Return type - The class instance or javascript object returned by the method or. Method Param - Any required or optional params used by a method (or passed to anĮvent handler method) will be listed next to the method name within parenthesis. Member Name - The name of the class member ( lookupComponent in this example). Expand/Collapse - On the left-hand size of the member row is a control used toĮxpand and collapse each member row to show / hide member details. Let's look at each part of the member row: (the lookupComponent method as viewed from the class in this case). Theme Mixin - Functions used by the visual theme engine employed by the frameworkĪnd may use values set in various Theme Variables.īelow is an example class member that we can disect to show the syntax of a class member. Theme Variable - Variables used by the visual theme engine employed by the. DOMĮvents, while handled by the framework event system, are not specifically described Programmatically raise an event to be handled by one or more event handler methods. Event - Events are specific to the framework event system allowing for classes to. That can be called directly from the class itself will have a static label next to the Instance methods and can only be called from a instance of a given class. Method - Actions that can be performed by a class. Property - Set once a class is instantiated. Config - The configuration options for a class. Private classes and members may change orīe omitted from the framework at any time without notice and should not be relied upon in Intended to be used by application developers. Private classes and class members are used internally by the framework and are not Protected members may safely be extended via a subclass. Protected class members are stable public members intended to be used by the Public classes and members may safely be extended via a subclass. Public classes and class members are available for use by any other class orĪpplication code and may be relied upon as a stable and persistent within major product Public, protected, and private are accessĭescriptors used to convey how and when the class or class member should be used. Access Levelsįramework classes or their members may be specified as private or protected. The alias/xtype is listed next to the class name ofĪpplicable classes for quick reference. The shortcut name is referred to as an alias (or xtype if theĬlass extends Ext.Component). Many classes have shortcut names used when creating (instantiating) a class with aĬonfiguration object. 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
0 kommentar(er)
