Package: | YAHOO.ext |
Class: | JsonView |
Extends: | View |
Defined In: | TemplateView.js |
var view = new YAHOO.ext.View('my-element',
'<div id="{id}">{foo} - {bar}</div>', // auto create template
{ multiSelect: true, jsonRoot: 'data' });
// listen for node click?
view.on('click', function(vw, index, node, e){
alert('Node "' + node.id + '" at index: ' + index + ' was clicked.');
});
// direct load of JSON data
view.load('foobar.php');
Property | Defined By | |
---|---|---|
jsonRoot : String | View | |
The root property in the loaded json object that contains the data | ||
selectedClass : YAHOO.ext.DomHelper.Template | View | |
The css class to add to selected nodes | ||
tpl : YAHOO.ext.DomHelper.Template | View | |
The template used by this View |
Method | Defined By | |
---|---|---|
JsonView(String/HTMLElement/Element container , DomHelper.Template tpl , Object config ) |
JsonView | |
Create a new JsonView | ||
addListener(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable | |
Appends an event handler to this element | ||
clearSelections([Boolean suppressEvent ]) : void |
View | |
Clear all selections | ||
delayedListener(String eventName , Function handler , [Object scope ], [Number delay ]) : Function |
Observable | |
Appends an event handler to this element that is delayed the specified number of milliseconds. | ||
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 ) : void |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
getEl() : YAHOO.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. | ||
indexOf(HTMLElement/String/Number nodeInfo ) : Number |
View | |
Finds the index of the passed node | ||
load(String/Function url , [String/Object params ], [Function callback ], [Boolean discardUrl ]) : void |
JsonView | |
Direct access to the elements UpdateManager update() method (takes the same parameters). | ||
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. | ||
setDataModel(DataModel dataModel ) : void |
View | |
Changes the data model this view uses and refresh the view. | ||
unplugDataModel(DataModel dataModel ) : void |
View | |
Unplug the data model and stop updates. |
Event | Defined By | |
---|---|---|
click : (YAHOO.ext.View this , Number index , HTMLElement node , YAHOO.ext.EventObject e ) |
View | |
Fires when a template node is clicked. | ||
contextmenu : (YAHOO.ext.View this , Number index , HTMLElement node , YAHOO.ext.EventObject e ) |
View | |
Fires when a template node is right clicked. | ||
dblclick : (YAHOO.ext.View this , Number index , HTMLElement node , YAHOO.ext.EventObject e ) |
View | |
Fires when a template node is double clicked. | ||
selectionchange : (YAHOO.ext.View this , Array selections ) |
View | |
Fires when the selected nodes change. |
public String jsonRoot
public YAHOO.ext.DomHelper.Template selectedClass
public YAHOO.ext.DomHelper.Template tpl
public function JsonView(String/HTMLElement/Element container
, DomHelper.Template tpl
, Object config
)
container
: String/HTMLElement/Elementtpl
: DomHelper.Templateconfig
: Objectpublic function addListener(String eventName
, Function handler
, [Object scope
], [boolean override
])
eventName
: Stringhandler
: Functionscope
: Objectoverride
: booleanvoid
public function clearSelections([Boolean suppressEvent
])
suppressEvent
: Booleanvoid
public function delayedListener(String eventName
, Function handler
, [Object scope
], [Number delay
])
eventName
: Stringhandler
: Functionscope
: Objectdelay
: NumberFunction
public function findItemFromChild(HTMLElement node
)
node
: HTMLElementHTMLElement
public function fireEvent(String eventName
, Object... args
)
eventName
: Stringargs
: Object...void
public function getEl()
YAHOO.ext.Element
public function getNode(HTMLElement/String/Number nodeInfo
)
nodeInfo
: HTMLElement/String/NumberHTMLElement
public function getNodes(Number startIndex
, Number endIndex
)
startIndex
: NumberendIndex
: NumberArray
public function getSelectedIndexes()
Array
public function getSelectedNodes()
Array
public function getSelectionCount()
Number
public function indexOf(HTMLElement/String/Number nodeInfo
)
nodeInfo
: HTMLElement/String/NumberNumber
public function load(String/Function url
, [String/Object params
], [Function callback
], [Boolean discardUrl
])
url
: String/Functionparams
: String/Objectcallback
: FunctiondiscardUrl
: Booleanvoid
public function prepareData(Array/Object data
, Number index
)
data
: Array/Objectindex
: Numbervoid
public function purgeListeners()
void
public function refresh()
void
public function refreshNode(Number index
)
index
: Numbervoid
public function removeListener(String eventName
, Function handler
, [Object scope
])
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function select(Array/HTMLElement/String/Number nodeInfo
, [Boolean keepExisting
], [Boolean suppressEvent
])
nodeInfo
: Array/HTMLElement/String/NumberkeepExisting
: BooleansuppressEvent
: Booleanvoid
public function setDataModel(DataModel dataModel
)
dataModel
: DataModelvoid
public function unplugDataModel(DataModel dataModel
)
dataModel
: DataModelvoid
public event click
this
: YAHOO.ext.Viewindex
: Numbernode
: HTMLElemente
: YAHOO.ext.EventObjectpublic event contextmenu
this
: YAHOO.ext.Viewindex
: Numbernode
: HTMLElemente
: YAHOO.ext.EventObjectpublic event dblclick
this
: YAHOO.ext.Viewindex
: Numbernode
: HTMLElemente
: YAHOO.ext.EventObjectpublic event selectionchange
this
: YAHOO.ext.Viewselections
: Array