Properties

Methods

Events

Config Options

Direct Link

Observable
  Droppable

Class Ext.util.Droppable

Package:	Ext.util
Defined In:	Droppable.js
Class:	Droppable
Extends:	Observable

Config Options

Config Options		Defined By
	activeCls : String The CSS added to a Droppable when a Draggable in the same group is being dragged. Defaults to 'x-drop-active'.	Droppable
	disabled : Boolean	Droppable
	group : String Draggable and Droppable objects can participate in a group which are capable of interacting. Defaults to 'base'	Droppable
	hoverCls : String The CSS class to add to the droppable when hovering over a valid drop. (Defaults to 'x-drop-hover')	Droppable
	invalidCls : String The CSS class to add to the droppable when dragging a draggable that is not in the same group. Defaults to 'x-drop-in... The CSS class to add to the droppable when dragging a draggable that is not in the same group. Defaults to 'x-drop-invalid'.	Droppable
	listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's `click` event passing the node clicked on. To access DOM events directly from a a child element of a Component, we need to specify this explicitly: `new Ext.Panel({ width: 400, height: 200, dockedItems: [{ xtype: 'toolbar' }], listeners: { click: { element: 'el', //bind to the underlying el property on the panel fn: function(){ console.log('click el'); } }, dblclick: { element: 'body', //bind to the underlying body property on the panel fn: function(){ console.log('dblclick body'); } } } });`	Observable
	validDropMode : String Determines when a drop is considered 'valid' whether it simply need to intersect the region or if it needs to be cont... Determines when a drop is considered 'valid' whether it simply need to intersect the region or if it needs to be contained within the region. Valid values are: 'intersects' or 'contains'	Droppable

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	Droppable() Parameters: None. Returns: void	Droppable
	addEvents( `Object\|String o`, `string Optional.` ) : void Adds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters: `o` : Object\|String Either an object with event names as properties with a value of `true` or the first event name string if multiple event names are being passed as separate parameters. `Optional.` : string Event name if multiple event names are being passed as separate parameters. Usage: `this.addEvents('storeloaded', 'storecleared');` Returns: void	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object. Appends an event handler to this object. Parameters: `eventName` : String The name of the event to listen for. `handler` : Function The method the event invokes. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. properties. This may contain any of the following properties: scope : Object The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer : Number Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. target : Observable Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable. element : String The element reference on the component to bind the event to. This is used to bind DOM events to underlying elements on Components. - This option is only valid for listeners bound to Components Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. `myPanel.on('hide', this.onClick, this, { single: true, delay: 100 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. Returns: void	Observable
	addManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope`, `Object opt` ) : void Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed... Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. Parameters: `item` : Observable\|Element The item to which to add a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. `opt` : Object Optional. If the `ename` parameter was an event name, this is the addListener options. Returns: void	Observable
	clearListeners() : void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters: None. Returns: void	Observable
	clearManagedListeners() : void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters: None. Returns: void	Observable
	constructor( `el {Mixed}`, `config {Object}` ) : void Parameters: `{Mixed}` : el String, HtmlElement or Ext.Element representing an element on the page. `{Object}` : config Configuration options for this class. Returns: void	Droppable
	disable() : void Disable the Droppable target. Disable the Droppable target. Parameters: None. Returns: void	Droppable
	enable() : void Enable the Droppable target. This is invoked immediately after constructing a Droppable if the disabled parameter is ... Enable the Droppable target. This is invoked immediately after constructing a Droppable if the disabled parameter is NOT set to true. Parameters: None. Returns: void	Droppable
	enableBubble( `String/Array events` ) : void Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class. This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example: Ext.override(Ext.form.Field, { // Add functionality to Field's initComponent to enable the change event to bubble initComponent : Ext.createSequence(Ext.form.Field.prototype.initComponent, function() { this.enableBubble('change'); }), // We know that we want Field's events to bubble directly to the FormPanel. getBubbleTarget : function() { if (!this.formPanel) { this.formPanel = this.findParentByType('form'); } return this.formPanel; } }); var myForm = new Ext.formPanel({ title: 'User Details', items: [{ ... }], listeners: { change: function() { // Title goes red if form has been modified. myForm.header.setStyle('color', 'red'); } } }); Parameters: `events` : String/Array The event name to bubble, or an Array of event names. Returns: void	Observable
	fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters: `eventName` : String The name of the event to fire. `args` : Object... Variable number of parameters are passed to handlers. Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true.	Observable
	hasListener( `String eventName` ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false	Observable
	isDisabled() : Boolean Method to determine whether this Component is currently disabled. Method to determine whether this Component is currently disabled. Parameters: None. Returns: `Boolean` the disabled state of this Component.	Droppable
	isMonitoring() : Boolean Method to determine whether this Droppable is currently monitoring drag operations of Draggables. Method to determine whether this Droppable is currently monitoring drag operations of Draggables. Parameters: None. Returns: `Boolean` the monitoring state of this Droppable	Droppable
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. Returns: void	Observable
	relayEvents( `Object o`, `Array events` ) : void Relays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by `this`. Parameters: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: void	Observable
	removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler. Removes an event handler. Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable
	removeManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope` ) : void Removes listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters: `item` : Observable\|Element The item from which to remove a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. Returns: void	Observable
	resumeEvents() : void Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event... Resume firing events. (see suspendEvents) If events were suspended using the `queueSuspended` parameter, then all events fired during event suspension will be sent to any listeners now. Parameters: None. Returns: void	Observable
	suspendEvents( `Boolean queueSuspended` ) : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: `queueSuspended` : Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events; Returns: void	Observable
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable

Public Events

Event		Defined By
	drop : ( `Ext.Droppable this`, `Ext.Draggable draggable`, `Ext.EventObject e` ) Listeners will be called with the following arguments: `this` : Ext.Droppable `draggable` : Ext.Draggable `e` : Ext.EventObject	Droppable
	dropactivate : ( `Ext.Droppable this`, `Ext.Draggable draggable`, `Ext.EventObject e` ) Listeners will be called with the following arguments: `this` : Ext.Droppable `draggable` : Ext.Draggable `e` : Ext.EventObject	Droppable
	dropdeactivate : ( `Ext.Droppable this`, `Ext.Draggable draggable`, `Ext.EventObject e` ) Listeners will be called with the following arguments: `this` : Ext.Droppable `draggable` : Ext.Draggable `e` : Ext.EventObject	Droppable
	dropenter : ( `Ext.Droppable this`, `Ext.Draggable draggable`, `Ext.EventObject e` ) Listeners will be called with the following arguments: `this` : Ext.Droppable `draggable` : Ext.Draggable `e` : Ext.EventObject	Droppable
	dropleave : ( `Ext.Droppable this`, `Ext.Draggable draggable`, `Ext.EventObject e` ) Listeners will be called with the following arguments: `this` : Ext.Droppable `draggable` : Ext.Draggable `e` : Ext.EventObject	Droppable