Class Index | File Index

Classes


Class Alfresco.DocListTree

Extends Alfresco.component.Base
DocumentList TreeView component.
Defined in: tree.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
DocumentList TreeView constructor.
Field Summary
Field Attributes Field Name and Description
 
Currently active filter
 
Current path being browsed.
 
Initial filter on page load.
 
Tracks if this component is the active filter owner.
 
Flag set after TreeView instantiated.
 
Object container for initialization options
 
Paths we have to expand as a result of a deep navigation event.
 
Selected tree node.
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
fnLoadNodeData(node, fnLoadComplete)
Dynamically loads TreeView nodes.
 
onDocumentDragOut(layer, args)
Handles applying the styling and node deletion required when a document is dragged
 
onDocumentDragOver(layer, args)
Handles applying the styling and node creation required when a document is dragged
 
Handles "dropTargetOwnerRequest" by determining whether or not the target belongs to the TreeView
 
Fired by YUI TreeView when a node has finished expanding
 
onFilterChanged(layer, args)
Fired when the currently active filter has changed
 
onFolderCopied(layer, args)
Fired when a folder has been copied
 
onFolderCreated(layer, args)
Fired when a folder has been created
 
onFolderDeleted(layer, args)
Fired when a folder has been deleted
 
onFolderMoved(layer, args)
Fired when a folder has been moved
 
onFolderRenamed(layer, args)
Fired when a folder has been renamed
 
Fired by YUI TreeView when a node label is clicked
 
Fired by YUI when parent element is available for scripting
 
pathChanged(path, flags)
Path changed handler
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.DocListTree(htmlId)
DocumentList TreeView constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.DocListTree} The new DocListTree instance
Field Detail
{object} currentFilter
Currently active filter

{string} currentPath
Current path being browsed.

{string} initialFilter
Initial filter on page load.

{boolean} isFilterOwner
Tracks if this component is the active filter owner.

{boolean} isReady
Flag set after TreeView instantiated.

options
Object container for initialization options

{array} pathsToExpand
Paths we have to expand as a result of a deep navigation event.

selectedNode
Selected tree node.
Method Detail
fnLoadNodeData(node, fnLoadComplete)
Dynamically loads TreeView nodes.
This MUST be inline in order to have access to the Alfresco.DocListTree class.
Parameters:
{object} node
Parent node
{function} fnLoadComplete
Expanding node's callback function

onDocumentDragOut(layer, args)
Handles applying the styling and node deletion required when a document is dragged
out of a tree node.
Parameters:
layer
args

onDocumentDragOver(layer, args)
Handles applying the styling and node creation required when a document is dragged
over a tree node.
Parameters:
layer
args

onDropTargetOwnerRequest(layer, args)
Handles "dropTargetOwnerRequest" by determining whether or not the target belongs to the TreeView
widget, and if it does determines it's nodeRef and uses the callback function with it.
Parameters:
layer
args

onExpandComplete(oNode)
Fired by YUI TreeView when a node has finished expanding
Parameters:
oNode
{YAHOO.widget.Node} the node recently expanded

onFilterChanged(layer, args)
Fired when the currently active filter has changed
Parameters:
{string} layer
the event source
{object} args
arguments object

onFolderCopied(layer, args)
Fired when a folder has been copied

Event data contains:
nodeRef - the nodeRef of the newly copied object
destination - new parent path
Parameters:
{string} layer
the event source
{object} args
arguments object

onFolderCreated(layer, args)
Fired when a folder has been created
Parameters:
{string} layer
the event source
{object} args
arguments object

onFolderDeleted(layer, args)
Fired when a folder has been deleted
Parameters:
{string} layer
the event source
{object} args
arguments object

onFolderMoved(layer, args)
Fired when a folder has been moved

Event data contains:
nodeRef - the nodeRef of the moved object
destination - new parent path
Parameters:
{string} layer
the event source
{object} args
arguments object

onFolderRenamed(layer, args)
Fired when a folder has been renamed
Parameters:
{string} layer
the event source
{object} args
arguments object

onNodeClicked()
Fired by YUI TreeView when a node label is clicked
Parameters:
args.event
{HTML Event} the event object
args.node
{YAHOO.widget.Node} the node clicked
Returns:
allowExpand {boolean} allow or disallow node expansion

onReady()
Fired by YUI when parent element is available for scripting

pathChanged(path, flags)
Path changed handler
Parameters:
{string} path
New path
{object} flags
Logic control flags

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Feb 16 2012 12:24:25 GMT-0000 (GMT)