Class orion.explorerNavHandler.ExplorerNavHandler
A tree iteration handler based on an explorer.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/explorers/explorerNavHandler.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
orion.explorerNavHandler.ExplorerNavHandler(explorer, options)
Creates a new tree iteration handler
|
| Method Attributes | Method Name and Description |
|---|---|
|
cursorOn(model, force, next, noScroll)
|
|
|
destroy()
|
|
|
disableItem(model)
Disables the specified model making it no longer respond
to user input such as mouse click or key presses.
|
|
|
enableItem(model)
Enables the specified model.
|
|
|
focus()
|
|
|
getAriaContainerElement(node)
|
|
|
getCurrentGrid(model)
|
|
|
getRowDiv(model)
|
|
|
isDisabled(rowDiv)
Checks if the specified html row node is disabled.
|
|
|
isExpandable(model)
|
|
|
isExpanded(model)
|
|
|
iterate(forward, forceExpand, selecting, selectableOnly)
|
|
|
moveColumn(model, offset)
|
|
|
onClick(model, mouseEvt)
|
|
|
onCollapse(model)
|
|
|
onDownArrow(e)
|
|
|
onEnter(e)
|
|
|
onLeftArrow(e)
|
|
|
onRightArrow(e)
|
|
|
onSpace(e)
|
|
|
onUpArrow(e)
|
|
|
refreshModel(navDict, model, topIterationNodes, noReset)
|
|
|
refreshSelection(noScroll, visually)
|
|
|
setIsNotSelectable(model, isNotSelectable)
Sets the isNotSelectable attribute on the specified model.
|
|
|
setSelection(model, toggling, shiftSelectionAnchor)
|
|
|
setSelectionPolicy(policy)
|
|
|
toggleCursor(model, on)
|
Class Detail
orion.explorerNavHandler.ExplorerNavHandler(explorer, options)
Creates a new tree iteration handler
- Parameters:
- {Object} explorer
- The orion.explorer.Explorer instance.
- {Object} options
- The options object which provides iterate patterns and all call back functions when iteration happens.
- {String} options.gridClickSelectionPolicy Optional, Default: "none"
- Controls how clicking on a grid model item -- for example, a link or a button -- affects
the selection (or how it affects the cursor, if the
selectionPolicyis"cursorOnly"). Allowed values are:"none": Clicking on a grid item will not change the selection (or cursor). This is the default."active": Clicking on a grid item will change the selection (or cursor).
- {String} options.selectionPolicy Optional, Default: null
- Selection policy for this explorer. Allowed values are:
"cursorOnly": No selection of model items is allowed."singleSelection": Up to 1 model item can be selected."readonlySelection": Selection cannot be changed while this selection policy is set.null: Zero or more model items can be selected. This is the default.
- {Function} options.postDefaultFunc Optional
- If this function provides addtional behaviors after the default behavior. Some explorers may want to do something else when the cursor is changed, etc.
- {Function} options.preventDefaultFunc Optional
- If this function returns true then the default behavior of all key press will stop at this time. The key event is passed to preventDefaultFunc. It can implement its own behavior based on the key event.
Method Detail
currentModel()
cursorOn(model, force, next, noScroll)
- Parameters:
- model
- force
- next
- noScroll
destroy()
disableItem(model)
Disables the specified model making it no longer respond
to user input such as mouse click or key presses. The
CSS style of corresponding row node is also modified to
reflect its disabled state.
- Parameters:
- {Object} model
enableItem(model)
Enables the specified model.
- Parameters:
- {Object} model
focus()
{Element}
getAriaContainerElement(node)
- Parameters:
- node
- Returns:
- {Element} The ancestor element of
nodethat provides grid/tree/treegrid behavior, ornullif no such node was found.
getCurrentGrid(model)
- Parameters:
- model
getRowDiv(model)
- Parameters:
- model
getSelection()
getSelectionIds()
getSelectionPolicy()
getTopLevelNodes()
isDisabled(rowDiv)
Checks if the specified html row node is disabled.
- Parameters:
- rowDiv
- Returns:
- true if the specified node's classList contains the "disabledNavRow" class, false otherwise
isExpandable(model)
- Parameters:
- model
isExpanded(model)
- Parameters:
- model
iterate(forward, forceExpand, selecting, selectableOnly)
- Parameters:
- forward
- forceExpand
- selecting
- selectableOnly
moveColumn(model, offset)
- Parameters:
- model
- offset
onClick(model, mouseEvt)
- Parameters:
- model
- mouseEvt
onCollapse(model)
- Parameters:
- model
onDownArrow(e)
- Parameters:
- e
onEnter(e)
- Parameters:
- e
onLeftArrow(e)
- Parameters:
- e
onRightArrow(e)
- Parameters:
- e
onSpace(e)
- Parameters:
- e
onUpArrow(e)
- Parameters:
- e
refreshModel(navDict, model, topIterationNodes, noReset)
- Parameters:
- navDict
- model
- topIterationNodes
- noReset
refreshSelection(noScroll, visually)
- Parameters:
- noScroll
- visually
removeListeners()
setIsNotSelectable(model, isNotSelectable)
Sets the isNotSelectable attribute on the specified model.
- Parameters:
- {Object} model
- {Boolean} isNotSelectable
- true makes the this.iterate() with selectableOnly specified skip the item
setSelection(model, toggling, shiftSelectionAnchor)
- Parameters:
- model
- toggling
- shiftSelectionAnchor
setSelectionPolicy(policy)
- Parameters:
- policy
toggleCursor(model, on)
- Parameters:
- model
- on