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.
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.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)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).PROTECTED in
this example - see the Flags section below)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.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
If true, animates the proxy element back to the position of the handle element used to trigger the drag.
Defaults to:
true
True to register this container with the Scrollmanager for auto scrolling during drag operations. A Ext.dd.ScrollManager configuration may also be passed.
A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group.
The CSS class returned to the drag source when drop is allowed.
Defaults to:
Ext.baseCSSPrefix + 'dd-drop-ok'
The CSS class returned to the drag source when drop is not allowed.
Defaults to:
Ext.baseCSSPrefix + 'dd-drop-nodrop'
The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to light blue). The color must be a 6 digit hex value, without a preceding '#'.
Defaults to:
'c3daf9'
An element to register with the ScrollManager if containerScroll is set. Defaults to the drag element.
The value true causes config values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config values as properties using their exact name (no prefix).
Defaults to:
true
Available since: 5.0.0
The value true instructs the initConfig method to only honor values for
properties declared in the config block of a class. When false, properties
that are not declared in a config block will be placed on the instance.
Defaults to:
true
Available since: 5.0.0
The available property is false until the linked dom element is accessible.
Defaults to:
false
By default the frame is positioned exactly where the drag element is, so we use the cursor offset provided by Ext.dd.DD. Another option that works only if you do not have constraints on the obj is to have the drag frame centered around the cursor. Set centerFrame to true for this effect.
Defaults to:
false
Provides default constraint padding to "constrainTo" elements.
Defaults to:
{
left: 0,
right: 0,
top: 0,
bottom: 0
}
This property contains the data representing the dragged object. This data is set up by the implementation of the getDragData method. It must contain a ddel property, but can contain any other data according to the application's needs.
The id of the element that will be dragged. By default this is same as the linked element, but could be changed to another element. Ex: Ext.dd.DDProxy
Defaults to:
null
The group defines a logical collection of DragDrop objects that are related. Instances only get events when interacting with other DragDrop object in the same group. This lets us define multiple groups using a single DragDrop subclass if we want.
An object in the format {'group1':true, 'group2':true}
Defaults to:
null
The ID of the element that initiates the drag operation. By default this is the linked element, but could be changed to be a child of this element. This lets us do things like only starting the drag when the header element within the linked html element is clicked.
Defaults to:
null
By default, drags can only be initiated if the mousedown occurs in the region the linked element is. This is done in part to work around a bug in some browsers that mis-report the mousedown if the previous mouseup happened outside of the window. This property is set to true if outer handles are defined. Defaults to false.
Defaults to:
false
The id of the element associated with this object. This is what we refer to as the "linked element" because the size and position of this element is used to determine when the drag and drop objects have interacted.
Defaults to:
null
Set to false to enable a DragDrop object to fire drag events while dragging over its own Element. Defaults to true - DragDrop objects do not by default fire drag events to themselves.
An Array of CSS class names for elements to be considered in valid as drag handles.
Defaults to:
null
An object who's property names identify the IDs of elements to be considered invalid as drag handles. A non-null property value identifies the ID as invalid. For example, to prevent dragging from being initiated on element ID "foo", use:
{
foo: true
}
Defaults to:
null
An object who's property names identify HTML tags to be considered invalid as drag handles.
A non-null property value identifies the tag as invalid. Defaults to the
following value which prevents drag operations from being initiated by <a> elements:
{
A: "A"
}
Defaults to:
null
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
This property is set to true if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
By default, all instances can be a drop target. This can be disabled by setting isTarget to false.
Defaults to:
true
Individual drag/drop instances can be locked. This will prevent onmousedown start drag.
Defaults to:
false
Maintain offsets when we resetconstraints. Set to true when you want the position of the element relative to its parent to stay the same when the page changes
Defaults to:
false
When set to true, other DD objects in cooperating DDGroups do not receive notification events when this DD object is dragged over them.
Defaults to:
false
The padding configured for this drag and drop object for calculating the drop zone intersection with this object. An array containing the 4 padding values: [top, right, bottom, left]
Defaults to:
null
By default the drag and drop instance will only respond to the primary button click (left button for a right-handed mouse). Set to true to allow drag and drop to start with any mouse click that is propogated by the browser
Defaults to:
true
By default we resize the drag frame to be the same size as the element we want to drag (this is to get the frame effect). We can turn it off if we want a different behavior.
Defaults to:
true
When set to true, the utility automatically tries to scroll the browser window when a drag and drop element is dragged near the viewport boundary.
Defaults to:
true
Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics,
this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics
for a detailed comparison
Ext.define('My.Cat', {
statics: {
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
alert(this.self.speciesName); // dependent on 'this'
},
clone: function() {
return new this.self();
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
}
});
var cat = new My.Cat(); // alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
Defaults to:
Base
The linked element's absolute X position at the time the drag was started
Defaults to:
0
The linked element's absolute X position at the time the drag was started
Defaults to:
0
Array of pixel locations the element will snap to if we specified a horizontal graduation/interval. This array is generated automatically when you define a tick interval.
Defaults to:
null
The proxy is automatically resized to the dimensions of the linked element when a drag is initiated, unless resizeFrame is set to false
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
Lets you specify a css class of elements that will not initiate a drag
cssClass : String
the class of the elements you wish to ignore
Lets you to specify an element id for a child of a drag handle that should not initiate a drag
id : String
the element id of the element you wish to ignore
Allows you to specify a tag name that should not start a drag operation when clicked. This is designed to facilitate embedding links within a drag handle that do something other than start the drag.
tagName : String
the type of element to exclude
Adds this instance to a group of related drag/drop objects. All instances belong to at least one group, and can belong to as many groups as needed.
sGroup : String
the name of the group
An empty function by default, but provided so that you can perform a custom action after a valid drag drop has occurred by providing an implementation.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dropped element
An empty function by default, but provided so that you can perform a custom action when the dragged item enters the drop target by providing an implementation.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
An empty function by default, but provided so that you can perform a custom action after the dragged item is dragged out of the target without dropping.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
An empty function by default, but provided so that you can perform a custom action while the dragged item is over the drop target by providing an implementation.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred by providing an implementation.
e : Event
The event object
id : String
The id of the dropped element
An empty function by default, but provided so that you can perform a custom action after a valid drop has occurred by providing an implementation.
target : Object
The target DD
e : Event
The event object
id : String
The id of the dropped element
Sets the element to the location of the mousedown or click event, maintaining the cursor location relative to the location on the element that was clicked. Override this if you want to place the element in a location other than where the cursor is.
el : HTMLElement
the element to move
iPageX : Number
the X coordinate of the mousedown or drag event
iPageY : Number
the Y coordinate of the mousedown or drag event
Sets up config options specific to this class. Overrides Ext.dd.DragDrop, but all versions of this method through the inheritance chain are called
Sets the pointer offset to the distance between the linked element's top left corner and the location the element was clicked.
iPageX : Number
the X coordinate of the click
iPageY : Number
the Y coordinate of the click
Auto-scroll the window if the dragged object has been moved beyond the visible window boundary.
x : Number
the drag element's x position
y : Number
the drag element's y position
h : Number
the height of the drag element
w : Number
the width of the drag element
Event that fires prior to the onDrag event. Overrides Ext.dd.DragDrop.
e : Object
Event that fires prior to the onMouseDown event. Overrides Ext.dd.DragDrop.
e : Object
Code that executes immediately before the startDrag event
x : Object
y : Object
An empty function by default, but provided so that you can perform a custom action before the dragged item is dropped onto the target and optionally cancel the onDragDrop.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
isValid True if the drag drop event is valid, else false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
An empty function by default, but provided so that you can perform a custom action before the dragged item enters the drop target and optionally cancel the onDragEnter.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
isValid True if the drag event is valid, else false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
An empty function by default, but provided so that you can perform a custom action before the dragged item is dragged out of the target without dropping, and optionally cancel the onDragOut.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
isValid True if the drag event is valid, else false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
An empty function by default, but provided so that you can perform a custom action while the dragged item is over the drop target and optionally cancel the onDragOver.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
isValid True if the drag event is valid, else false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred.
target : Ext.dd.DragDrop
The drop target
e : Event
The event object
id : String
The id of the dragged element
isValid True if the invalid drop should proceed, else false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Saves the most recent position so that we can reset the constraints and tick marks on-demand. We need to know this so that we can calculate the number of pixels the element is offset from its original position.
iPageX : Number (optional)
the current x position (this just makes it so we don't have to look it up again)
iPageY : Number (optional)
the current y position (this just makes it so we don't have to look it up again)
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function (x) {
this.x = x;
},
statics: {
method: function (x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function () {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function (x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function () {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function () {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use method-callParent to call the superclass
method since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent would produce "Fixed" then "Bad"
then "Good".
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
Returns the result of calling the superclass method
Clears any constraints applied to this instance. Also clears ticks since they can't exist independent of a constraint at this time.
Initializes the drag drop object's constraints to restrict movement to a certain element.
Usage:
var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
{ dragElId: "existingProxyDiv" });
dd.startDrag = function(){
this.constrainTo("parent-id");
};
Or you can initalize it using the Ext.dom.Element object:
Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
startDrag : function(){
this.constrainTo("parent-id");
}
});
constrainTo : String/HTMLElement/Ext.dom.Element
The element or element ID to constrain to.
pad : Object/Number (optional)
Pad provides a way to specify "padding" of the constraints,
and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
an object containing the sides to pad. For example: {right:10, bottom:10}
inContent : Boolean (optional)
Constrain the draggable in the content box of the element (inside padding and borders)
Creates new DragZone.
el : String/HTMLElement/Ext.dom.Element
The container element or ID of it.
config : Object
Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.
name : String (optional)
The name of the config property to get.
peek : Boolean (optional)
true to peek at the raw value without calling the getter.
Defaults to: false
The config property value.
Called when a mousedown occurs in this container. Looks in Ext.dd.Registry for a valid target to drag based on the mouse down. Override this method to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned object has a "ddel" attribute (with an HTML Element) for other functions to work.
e : Event
The mouse down event
The dragData
Returns a reference to the actual element to drag. By default this is the same as the html element, but it can be assigned to another element. An example of this can be found in Ext.dd.DDProxy
the html element
Returns the initial configuration passed to the constructor when instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
});
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
});
Calling btn.getInitialConfig() would return an object including the config
options passed to the create method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')returns 'Test Button'.
name : String (optional)
Name of the config option to return.
The full config object or a single config value
when name parameter specified.
Returns the drag source's underlying Ext.dd.StatusProxy
proxy The StatusProxy
Called before a repair of an invalid drop to get the XY to animate to. By default returns the XY of this.dragData.ddel
e : Event
The mouse up event
The xy location (e.g. [100, 200])
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Finds the location the element should be placed if we want to move it to where the mouse location less the click offset would place us.
iPageX : Number
the X coordinate of the click
iPageY : Number
the Y coordinate of the click
An object that contains the coordinates (Object.x and Object.y)
Normally the drag element is moved pixel by pixel, but we can specify that it move a number of pixels at a time. This method resolves the location when we have it set up like this.
val : Number
where we want to place the object
tickArray : Number[]
sorted array of valid points
the closest tick
Called when this object is clicked
e : Event
oDD : Ext.dd.DragDrop
the clicked dd object (this dd obj)
Sets up the DragDrop object. Must be called in the constructor of any Ext.dd.DragDrop subclass
id : String
the id of the linked element
sGroup : String
the group of related items
config : Object
configuration attributes
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
instanceConfig : Object
this
Initialization for the drag frame element. Must be called in the constructor of all subclasses
Initializes Targeting functionality only... the object does not get a mousedown handler.
id : String
the id of the linked element
sGroup : String
the group of related items
config : Object
configuration attributes
Returns true if this instance is locked, or the drag drop mgr is locked (meaning that all drag/drop is disabled on the page.)
true if this obj or all drag/drop is locked, else false
Template method called upon mousedown. May be overridden in subclasses, or configured into an instance.
Return true to prevent drag start.
e : Ext.event.Event
The mousedown event.
record : Ext.data.Model
The record mousedowned upon.
item : HTMLElement
The grid row mousedowned upon.
index : Number
The row number mousedowned upon.
Checks the tag exclusion list to see if this click should be ignored
node : HTMLElement
the HTMLElement to evaluate
true if this is a valid tag type, false if not
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
Override the onAvailable method to do what is needed after the initial position was determined.
An empty function by default, but provided so that you can perform a custom action before the initial drag event begins and optionally cancel it.
data : Object
An object containing arbitrary data to be shared with drop targets
e : Event
The event object
isValid True if the drag event is valid, else false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Abstract method called during the onMouseMove event while dragging an object.
e : Event
the mousemove event
Abstract method called when this item is dropped on another DragDrop obj
e : Event
the mouseup event
id : String/Ext.dd.DragDrop[]
In POINT mode, the element id this was dropped on. In INTERSECT mode, an array of dd items this was dropped on.
Abstract method called when this element fist begins hovering over another DragDrop obj
e : Event
the mousemove event
id : String/Ext.dd.DragDrop[]
In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of one or more dragdrop items being hovered over.
Abstract method called when we are no longer hovering over an element
e : Event
the mousemove event
id : String/Ext.dd.DragDrop[]
In POINT mode, the element id this was hovering over. In INTERSECT mode, an array of dd items that the mouse is no longer over.
Abstract method called when this element is hovering over another DragDrop obj
e : Event
the mousemove event
id : String/Ext.dd.DragDrop[]
In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of dd items being hovered over.
Called once drag threshold has been reached to initialize the proxy element. By default, it clones the this.dragData.ddel
x : Number
The x position of the click on the dragged object
y : Number
The y position of the click on the dragged object
true to continue the drag, false to cancel
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Abstract method called when this item is dropped on an area with no drop target
e : Event
the mouseup event
Called when a drag/drop obj gets a mousedown
e : Event
the mousedown event
An empty function by default, but provided so that you can perform a custom action once the initial drag event has begun. The drag cannot be canceled from this function.
x : Number
The x position of the click on the dragged object
y : Number
The y position of the click on the dragged object
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Removes this instance from the supplied interaction group
sGroup : String
The group to drop
Unsets an invalid css class
cssClass : String
the class of the element(s) you wish to re-enable
Unsets an invalid handle id
id : String
the id of the element to re-enable
Unsets an excluded tag name set by addInvalidHandleType
tagName : String
the type of element to unexclude
Must be called if you manually reposition a dd element.
maintainOffset : Boolean
Sets a single/multiple configuration options.
name : String/Object
The name of the property to set, or a set of key value pairs to set.
value : Object (optional)
The value to set for the name parameter.
this
Sets the pointer offset. You can call this directly to force the offset to be in a particular location (e.g., pass in 0,0 to set it to the center of the object)
iDeltaX : Number
the distance from the left
iDeltaY : Number
the distance from the top
Allows you to specify that an element other than the linked element will be moved with the cursor during a drag
id : String
the id of the element that will be used to initiate the drag
Sets the drag element to the location of the mousedown or click event, maintaining the cursor location relative to the location on the element that was clicked. Override this if you want to place the element in a location other than where the cursor is.
iPageX : Number
the X coordinate of the mousedown or drag event
iPageY : Number
the Y coordinate of the mousedown or drag event
Allows you to specify a child of the linked element that should be used to initiate the drag operation. An example of this would be if you have a content div with text and links. Clicking anywhere in the content area would normally start the drag operation. Use this method to specify that an element inside of the content div is the element that starts the drag operation.
id : String
the id of the element that will be used to initiate the drag.
Stores the initial placement of the linked element.
diffX : Number
the X offset, default 0
diffY : Number
the Y offset, default 0
Allows you to set an element outside of the linked element as a drag handle
id : String
the id of the element that will be used to initiate the drag
Configures the padding for the target zone in px. Effectively expands (or reduces) the virtual object size for targeting calculations. Supports css-style shorthand; if only one parameter is passed, all sides will have that padding, and if only two are passed, the top and bottom will have the first param, the left and right the second.
iTop : Number
Top pad
iRight : Number
Right pad
iBot : Number
Bot pad
iLeft : Number
Left pad
Sets the start position of the element. This is set when the obj is initialized, the reset when a drag is started.
pos : Object
current position (from previous lookup)
By default, the element can be dragged any place on the screen. Use this method to limit the horizontal travel of the element. Pass in 0,0 for the parameters if you want to lock the drag to the y axis.
iLeft : Number
the number of pixels the element can move to the left
iRight : Number
the number of pixels the element can move to the right
iTickSize : Number (optional)
parameter for specifying that the element should move iTickSize pixels at a time.
Creates the array of horizontal tick marks if an interval was specified in setXConstraint().
iStartX : Object
iTickSize : Object
By default, the element can be dragged any place on the screen. Set this to limit the vertical travel of the element. Pass in 0,0 for the parameters if you want to lock the drag to the x axis.
iUp : Number
the number of pixels the element can move up
iDown : Number
the number of pixels the element can move down
iTickSize : Number (optional)
parameter for specifying that the element should move iTickSize pixels at a time.
Creates the array of vertical tick marks if an interval was specified in setYConstraint().
iStartY : Object
iTickSize : Object
Resizes the drag frame to the dimensions of the clicked object, positions it over the object, and finally displays it
iPageX : Number
X click position
iPageY : Number
Y click position
Abstract method called after a drag/drop object is clicked and the drag or mousedown time thresholds have beeen met.
x : Number
X click location
y : Number
Y click location
Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self,
this.statics() is scope-independent and it always returns the class from which it was called, regardless of what
this points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.
config : Object
mixinClass : Ext.Class (optional)
The mixin class if the configs are from a mixin.
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members : Object
The members to add to this class.
isStatic : Boolean (optional)
Pass true if the members are static.
Defaults to: false
privacy : Boolean (optional)
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
members : Object
this
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
this
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
the created instance.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
Returns the Ext.Configurator for this class.
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Ext JS | Terms of Use