Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template.
This class also supports single and multi selection modes.
Create a data model bound view:
var store = new Ext.data.Store(...);
var view = new Ext.View("my-element",
'<div id="{0}">{2} - {1}</div>', // auto create template
{
singleSelect: true,
selectedClass: "ydataview-selected",
store: store
});
// listen for node click?
view.on("click", function(vw, index, node, e){
alert('Node "' + node.id + '" at index: ' + index + " was clicked.");
});
// load XML data
dataModel.load("foobar.xml");
For an example of creating a JSON/UpdateManager view, see
Ext.JsonView.
Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to
IE"s limited insertion support with tables and Opera"s faulty event bubbling.
|
View(String/HTMLElement/Element container , String/DomHelper.Template tpl , Object config ) |
View |
Create a new View |
|
addEvents(Object object ) : void |
Observable |
Copies any events from the passed object onto this object if they do not already exist. The passed object
must also ... |
|
addListener(String eventName , Function handler , [Object options ]) : void |
Observable |
Appends an event handler to this component |
|
clearSelections([Boolean suppressEvent ]) : void |
View |
Clear all selections |
|
findItemFromChild(HTMLElement node ) : HTMLElement |
View |
Returns the template node the passed child belongs to or null if it doesn't belong to one. |
|
fireEvent(String eventName , Object... args ) : Boolean |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getEl() : Ext.Element |
View |
Returns the element this view is bound to. |
|
getNode(HTMLElement/String/Number nodeInfo ) : HTMLElement |
View |
Gets a template node. |
|
getNodes(Number startIndex , Number endIndex ) : Array |
View |
Gets a range template nodes. |
|
getSelectedIndexes() : Array |
View |
Get the indexes of the selected nodes. |
|
getSelectedNodes() : Array |
View |
Get the currently selected nodes. |
|
getSelectionCount() : Number |
View |
Get the number of selected nodes. |
|
hasListener(String eventName ) : Boolean |
Observable |
Checks to see if this object is currently listening for a specified event |
|
indexOf(HTMLElement/String/Number nodeInfo ) : Number |
View |
Finds the index of the passed node |
|
isSelected(HTMLElement/Number node ) : Boolean |
View |
Returns true if the passed node is selected |
|
on(String eventName , Function handler , [Object options ]) : void |
Observable |
Appends an event handler to this element (shorthand for addListener) |
|
prepareData(Array/Object data , Number index ) : void |
View |
Function to override to reformat the data that is sent to
the template for each node. |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
refresh() : void |
View |
Refreshes the view. |
|
refreshNode(Number index ) : void |
View |
Refresh an individual node. |
|
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener |
|
select(Array/HTMLElement/String/Number nodeInfo , [Boolean keepExisting ], [Boolean suppressEvent ]) : void |
View |
Selects nodes. |
|
setStore(Store store ) : void |
View |
Changes the data store this view uses and refresh the view. |
|
un(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
beforeclick : (Ext.View this , Number index , HTMLElement node , Ext.EventObject e ) |
View |
Fires before a click is processed. Returns false to cancel the default action. |
|
beforeselect : (Ext.View this , HTMLElement node , Array selections ) |
View |
Fires before a selection is made. If any handlers return false, the selection is cancelled. |
|
click : (Ext.View this , Number index , HTMLElement node , Ext.EventObject e ) |
View |
Fires when a template node is clicked. |
|
contextmenu : (Ext.View this , Number index , HTMLElement node , Ext.EventObject e ) |
View |
Fires when a template node is right clicked. |
|
dblclick : (Ext.View this , Number index , HTMLElement node , Ext.EventObject e ) |
View |
Fires when a template node is double clicked. |
|
selectionchange : (Ext.View this , Array selections ) |
View |
Fires when the selected nodes change. |
addEvents
public function addEvents(Object object
)
Copies any events from the passed object onto this object if they do not already exist. The passed object
must also inherit from Observable for this method to have any effect.
addListener
public function addListener(String eventName
, Function handler
, [Object options
])
Appends an event handler to this component
clearSelections
public function clearSelections([Boolean suppressEvent
])
This method is defined by View.
findItemFromChild
public function findItemFromChild(HTMLElement node
)
Returns the template node the passed child belongs to or null if it doesn't belong to one.
Parameters:
Returns:
HTMLElement
The template node
This method is defined by View.
fireEvent
public function fireEvent(String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
getEl
public function getEl()
Returns the element this view is bound to.
This method is defined by View.
getNode
public function getNode(HTMLElement/String/Number nodeInfo
)
This method is defined by View.
getNodes
public function getNodes(Number startIndex
, Number endIndex
)
Gets a range template nodes.
Parameters:
startIndex
: NumberendIndex
: Number
Returns:
This method is defined by View.
getSelectedIndexes
public function getSelectedIndexes()
Get the indexes of the selected nodes.
This method is defined by View.
getSelectedNodes
public function getSelectedNodes()
Get the currently selected nodes.
Parameters:
Returns:
Array
An array of HTMLElements
This method is defined by View.
getSelectionCount
public function getSelectionCount()
Get the number of selected nodes.
This method is defined by View.
hasListener
public function hasListener(String eventName
)
Checks to see if this object is currently listening for a specified event
indexOf
public function indexOf(HTMLElement/String/Number nodeInfo
)
Finds the index of the passed node
This method is defined by View.
isSelected
public function isSelected(HTMLElement/Number node
)
Returns true if the passed node is selected
Parameters:
node
: HTMLElement/NumberThe node or node index
Returns:
This method is defined by View.
on
public function on(String eventName
, Function handler
, [Object options
])
Appends an event handler to this element (shorthand for addListener)
prepareData
public function prepareData(Array/Object data
, Number index
)
Function to override to reformat the data that is sent to
the template for each node.
This method is defined by View.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
refresh
public function refresh()
This method is defined by View.
refreshNode
public function refreshNode(Number index
)
Refresh an individual node.
This method is defined by View.
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
select
public function select(Array/HTMLElement/String/Number nodeInfo
, [Boolean keepExisting
], [Boolean suppressEvent
])
Selects nodes.
Parameters:
nodeInfo
: Array/HTMLElement/String/NumberAn HTMLElement template node, index of a template node, id of a template node or an array of any of those to select
keepExisting
: Boolean(optional) true to keep existing selections
suppressEvent
: Boolean(optional) true to skip firing of the selectionchange vent
Returns:
This method is defined by View.
setStore
public function setStore(Store store
)
Changes the data store this view uses and refresh the view.
This method is defined by View.
un
public function un(String eventName
, Function handler
, [Object scope
])
Removes a listener (shorthand for removeListener)
beforeclick
public event beforeclick
Fires before a click is processed. Returns false to cancel the default action.
Subscribers will be called with the following parameters:
This event is defined by View.
beforeselect
public event beforeselect
Fires before a selection is made. If any handlers return false, the selection is cancelled.
Subscribers will be called with the following parameters:
This event is defined by View.
click
public event click
Fires when a template node is clicked.
Subscribers will be called with the following parameters:
This event is defined by View.
contextmenu
public event contextmenu
Fires when a template node is right clicked.
Subscribers will be called with the following parameters:
This event is defined by View.
dblclick
public event dblclick
Fires when a template node is double clicked.
Subscribers will be called with the following parameters:
This event is defined by View.
selectionchange
public event selectionchange
Fires when the selected nodes change.
Subscribers will be called with the following parameters:
This event is defined by View.