Observable Sortable
Package: | Ext.util |
Defined In: | Sortable.js |
Class: | Sortable |
Extends: | Observable |
Config Options | Defined By | |
---|---|---|
cancelSelector : String A simple CSS selector that represents elements within the draggable
that should NOT initiate a drag. | Sortable | |
constrain : Element/Boolean An Element to constrain the Sortable dragging to. Defaults to window.
If true is specified, the dragging will be cons... An Element to constrain the Sortable dragging to. Defaults to window.
If true is specified, the dragging will be constrained to the element
of the sortable. | Sortable | |
direction : String Possible values: 'vertical', 'horizontal'
Defaults to 'vertical' | Sortable | |
disabled : Boolean Passing in true will disable this Sortable. | Sortable | |
group : String Draggable and Droppable objects can participate in a group which are
capable of interacting. Defaults to 'base' | Sortable | |
handleSelector : String A simple CSS selector to indicate what is the handle to drag the Sortable. | Sortable | |
itemSelector : String A simple CSS selector that represents individual items within the Sortable. | Sortable | |
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
| Observable |
Method | Defined By | |
---|---|---|
Sortable( Mixed el , Object config )
Parameters:
| Sortable | |
addEvents( Object|String o , string Optional. )
:
voidAdds 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:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
addManagedListener( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
:
voidAdds 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:
| Observable | |
clearListeners()
:
void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters:
| Observable | |
clearManagedListeners()
:
void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters:
| Observable | |
disable()
:
void Disables sorting for this Sortable. Disables sorting for this Sortable. Parameters:
| Sortable | |
enable()
:
void Enables sorting for this Sortable.
This method is invoked immediately after construction of a Sortable unless
the dis... Enables sorting for this Sortable.
This method is invoked immediately after construction of a Sortable unless
the disabled configuration is set to true. Parameters:
| Sortable | |
enableBubble( String/Array events )
:
voidEnables 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 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:
Parameters:
| Observable | |
fireEvent( String eventName , Object... args )
:
BooleanFires 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:
| Observable | |
hasListener( String eventName )
:
BooleanChecks 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:
| Observable | |
isDisabled()
:
Boolean Method to determine whether this Sortable is currently disabled. Method to determine whether this Sortable is currently disabled. Parameters:
| Sortable | |
isHorizontal()
:
Boolean Method to determine whether this Sortable is currently sorting. Method to determine whether this Sortable is currently sorting. Parameters:
| Sortable | |
isSorting()
:
Boolean Method to determine whether this Sortable is currently sorting. Method to determine whether this Sortable is currently sorting. Parameters:
| Sortable | |
isVertical()
:
Boolean Method to determine whether this Sortable is currently disabled. Method to determine whether this Sortable is currently disabled. Parameters:
| Sortable | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
relayEvents( Object o , Array events )
:
voidRelays 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:
| Observable | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
removeManagedListener( Observable|Element item , Object|String ename , Function fn , Object scope )
:
voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| 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:
| Observable | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
sortchange :
( Ext.Sortable this , Ext.Element el , Number index )
Listeners will be called with the following arguments:
| Sortable | |
sortend :
( Ext.Sortable this , Ext.EventObject e )
Listeners will be called with the following arguments:
| Sortable | |
sortstart :
( Ext.Sortable this , Ext.EventObject e )
Listeners will be called with the following arguments:
| Sortable |