Print Friendly

Class Ext.tree.DefaultSelectionModel

Package:Ext.tree
Class:DefaultSelectionModel
Extends:Observable
Defined In:TreeSelectionModel.js
The default single selection for a TreePanel.

Properties   -  Methods   -  Events

Public Properties

This class has no public properties.

Public Methods

Method Defined By
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  clearSelections() : void DefaultSelectionModel
Clear all selections
  fireEvent(String eventName, Object... args) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  getSelectedNode() : TreeNode DefaultSelectionModel
Get the selected node
  isSelected(TreeNode node) : Boolean DefaultSelectionModel
Returns true if the node is selected
  on(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this element (shorthand for addListener)
  purgeListeners() : void Observable
Removes all listeners for this object
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener
  select(TreeNode node) : TreeNode DefaultSelectionModel
Select a node.
  un(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener (shorthand for removeListener)
  unselect(TreeNode node) : void DefaultSelectionModel
Deselect a node.

Public Events

Event Defined By
  selectionchange : (DefaultSelectionModel this, TreeNode node) DefaultSelectionModel
Fires when the selected node changes

Method Details

addListener

public function addListener(String eventName, Function handler, [Object options])
Appends an event handler to this component
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

clearSelections

public function clearSelections()
Clear all selections
Parameters:
  • None.
Returns:
  • void
This method is defined by DefaultSelectionModel.

fireEvent

public function fireEvent(String eventName, Object... args)
Fires the specified event with the passed parameters (minus the event name).
Parameters:
  • eventName : String
  • 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
This method is defined by Observable.

getSelectedNode

public function getSelectedNode()
Get the selected node
Parameters:
  • None.
Returns:
  • TreeNode
    The selected node
This method is defined by DefaultSelectionModel.

isSelected

public function isSelected(TreeNode node)
Returns true if the node is selected
Parameters:
  • node : TreeNode
    The node to check
Returns:
  • Boolean
This method is defined by DefaultSelectionModel.

on

public function on(String eventName, Function handler, [Object options])
Appends an event handler to this element (shorthand for addListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

purgeListeners

public function purgeListeners()
Removes all listeners for this object
Parameters:
  • None.
Returns:
  • void
This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])
Removes a listener
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

select

public function select(TreeNode node)
Select a node.
Parameters:
  • node : TreeNode
    The node to select
Returns:
  • TreeNode
    The selected node
This method is defined by DefaultSelectionModel.

un

public function un(String eventName, Function handler, [Object scope])
Removes a listener (shorthand for removeListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

unselect

public function unselect(TreeNode node)
Deselect a node.
Parameters:
  • node : TreeNode
    The node to unselect
Returns:
  • void
This method is defined by DefaultSelectionModel.

Event Details

selectionchange

public event selectionchange
Fires when the selected node changes
Subscribers will be called with the following parameters:
  • this : DefaultSelectionModel
  • node : TreeNode
    the new selection
This event is defined by DefaultSelectionModel.

yui-ext - Copyright © 2006 Jack Slocum. | Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.