Class Index | File Index

Classes


Class Alfresco.DocListToolbar

Extends Alfresco.component.Base
DocumentList Toolbar component.
Defined in: toolbar.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
DocListToolbar constructor.
Field Summary
Field Attributes Field Name and Description
 
Current filter to choose toolbar view and populate description.
 
Current path being browsed.
 
Metadata returned by doclist data webscript
 
Dynamic controls that take part in the deactivateDynamicControls event
 
FileUpload module instance.
 
Folder Details Url for last breadcrumb
 
Object container for initialization options
 
Array of selected states for visible files.
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
onActionDelete(records)
Delete Multiple Records.
 
Deselect currectly selected records.
 
Create Content Template Node menu beforeShow handler
 
onCreateByTemplateNodeClick(sType, aArgs, p_obj)
Create Content Template Node sub menu click handler
 
onCreateContent(sType, aArgs, p_obj)
Create Content menu click handler for create content menu items (not create by template node menu items)
 
Deactivate All Controls event handler
 
Deactivate Dynamic Controls event handler.
 
onDoclistMetadata(layer, args)
Document List Metadata event handler
 
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 breacrumb
 
onFileUpload(e, p_obj)
File Upload button click handler
 
File Upload complete event handler
 
Calls the file Upload button click handler but creates an additional tooltip
 
onFilterChanged(layer, args)
Filter Changed event handler
 
onFolderUp(e, p_obj)
Folder Up Navigate button click handler
 
onHideNavBar(e, p_obj)
Show/Hide navigation bar button click handler
 
onNewFolder(e, p_obj)
New Folder button click handler
 
Fired by YUI when parent element is available for scripting.
 
Selected Files Changed event handler.
 
onSelectedItems(sType, aArgs, p_obj)
Selected Items button click handler
 
onUserAccess(layer, args)
User Access event handler
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.DocListToolbar(htmlId)
DocListToolbar constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.DocListToolbar} The new DocListToolbar instance
Field Detail
{string} currentFilter
Current filter to choose toolbar view and populate description.

{string} currentPath
Current path being browsed.

{object} doclistMetadata
Metadata returned by doclist data webscript
Default Value:
null

{array} dynamicControls
Dynamic controls that take part in the deactivateDynamicControls event

{Alfresco.FileUpload} fileUpload
FileUpload module instance.

{string} folderDetailsUrl
Folder Details Url for last breadcrumb

{object} options
Object container for initialization options

{array} selectedFiles
Array of selected states for visible files.
Method Detail
onActionDelete(records)
Delete Multiple Records.
Parameters:
{object} records
Object literal representing one or more file(s) or folder(s) to be actioned

onActionDeselectAll()
Deselect currectly selected records.

onCreateByTemplateNodeBeforeShow()
Create Content Template Node menu beforeShow handler

onCreateByTemplateNodeClick(sType, aArgs, p_obj)
Create Content Template Node sub menu click handler
Parameters:
{string} sType
Event type, e.g. "click"
{array} aArgs
Arguments array, [0] = DomEvent, [1] = EventTarget
{object} p_obj
Object passed back from subscribe method

onCreateContent(sType, aArgs, p_obj)
Create Content menu click handler for create content menu items (not create by template node menu items)
Parameters:
{string} sType
Event type, e.g. "click"
{array} aArgs
Arguments array, [0] = DomEvent, [1] = EventTarget
{object} p_obj
Object passed back from subscribe method

onDeactivateAllControls(layer, args)
Deactivate All Controls event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDeactivateDynamicControls(layer, args)
Deactivate Dynamic Controls event handler.
Only deactivates those controls whose enabled state is evaluated on each update.
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDoclistMetadata(layer, args)
Document List Metadata event handler
NOTE: This is a temporary fix to enable access to the View Details action from the breadcrumb.
A more complete solution is to present the full list of parent folder actions.
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

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 breacrumb
trail, and if it does determines it's path and uses it with the container nodeRef on the callback
function.
Parameters:
layer
args

onFileUpload(e, p_obj)
File Upload button click handler
Parameters:
{object} e
DomEvent
p_obj
{object|array} Object passed back from addListener method or args from Bubbling event

onFileUploadComplete(complete)
File Upload complete event handler
Parameters:
{object} complete
Object literal containing details of successful and failed uploads

onFileUploadWithTooltip(e, p_obj)
Calls the file Upload button click handler but creates an additional tooltip
with information on Drag-and-Drop as an alternative method for uploading content
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onFilterChanged(layer, args)
Filter Changed event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onFolderUp(e, p_obj)
Folder Up Navigate button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onHideNavBar(e, p_obj)
Show/Hide navigation bar button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onNewFolder(e, p_obj)
New Folder button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onReady()
Fired by YUI when parent element is available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.

onSelectedFilesChanged(layer, args)
Selected Files Changed event handler.
Determines whether to enable or disable the multi-file action drop-down
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onSelectedItems(sType, aArgs, p_obj)
Selected Items button click handler
Parameters:
{string} sType
Event type, e.g. "click"
{array} aArgs
Arguments array, [0] = DomEvent, [1] = EventTarget
{object} p_obj
Object passed back from subscribe method

onUserAccess(layer, args)
User Access event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

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