Class Index | File Index

Classes


Class Alfresco.DocumentList

Extends Alfresco.component.Base
DocumentList component.
Defined in: documentlist.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
DocumentList constructor.
Field Summary
Field Attributes Field Name and Description
 
Object container for storing action markup elements.
 
Deferred function calls for after a document list update
 
Current actions menu being shown
 
Current filter to filter document list.
 
Current page being browsed.
 
Current path being browsed.
 
Deferred actions menu element when showing "More Actions" pop-up.
 
Metadata returned by doclist data webscript
 
Indicates whether or not we allow the HTML5 drag and drop capability
 
Indicates whether or not the browser supports the HTML5 drag and drop capability
 
Drag and drop dragEnter / dragLeave event reference counter
 
Tracks currently highlighted folder when dragging files
 
Dynamic controls that take part in the deactivateDynamicControls event
 
FileUpload module instance.
 
Object container for initialization options
 
Registered metadata renderers.
 
Object literal of selected states for visible files (indexed by nodeRef).
 
Whether "More Actions" pop-up is currently visible.
 
Keeps track of different states
 
Total number of records (documents + folders) in the currentPath.
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
Returns actions custom datacell formatter
 
Returns description/detail custom datacell formatter
 
Returns selector custom datacell formatter
 
Returns status custom datacell formatter
 
Returns thumbnail custom datacell formatter
<static>  
Alfresco.DocumentList.generateCategoryMarkup(category)
Generate "changeFilter" event mark-up specifically for category changes
<static>  
Alfresco.DocumentList.generateComments(scope, record)
Generate "Comments" UI
<static>  
Alfresco.DocumentList.generateFavourite(scope, record)
Generate "Favourite" UI
<static>  
Alfresco.DocumentList.generateFileFolderLinkMarkup(record, record)
Generate URL for a file- or folder-link that may be located within a different Site
<static>  
Alfresco.DocumentList.generateFilterMarkup(filter)
Generate "changeFilter" event mark-up suitable for element attribute.
<static>  
Alfresco.DocumentList.generateLikes(scope, record)
Generate "Likes" UI
<static>  
Alfresco.DocumentList.generatePathMarkup(locn)
Generate "changeFilter" event mark-up specifically for path changes
<static>  
Alfresco.DocumentList.generateThumbnailUrl(record)
Generate URL to thumbnail image
<static>  
Alfresco.DocumentList.generateUserLink(scope, oUser)
Generate User Profile link
 
Public function to get array of selected files
 
Check in a new version from Google Docs.
 
Checkout to Google Docs.
 
Edit Offline.
 
onActionShowMore(record, elMore)
Show more actions pop-up.
 
Activate Dynamic Controls event handler
 
onChangeFilter(layer, args)
DocList View change filter request event handler
 
Deactivate All Controls event handler
 
Deactivate Dynamic Controls event handler
 
onDocListRefresh(layer, args)
DocList Refresh Required event handler
 
Fired when an object is dragged into the DocumentList DOM element and then again when dragged into a Folder
 
Fired when an object is dragged out of the DocumentList DOM element or the Folder icon image DOM element.
 
Fired when an object is dragged into the DocumentList DOM element and then again when dragged into a Folder
 
Fired when an object is dropped onto the DocumentList DOM element.
 
Custom event handler to highlight row.
 
Custom event handler to unhighlight row.
 
onFileAction(layer, args)
Generic file action event handler
 
onFileRenamed(layer, args)
File or folder renamed event handler
 
onFileSelect(sType, aArgs, p_obj)
Multi-file select button click handler
 
onFilterChanged(layer, args)
DocList View Filter changed event handler
 
onHighlightFile(layer, args)
Highlight file event handler
 
Fired by YUI when History Manager is initialised and available for scripting.
 
onLikes(row)
Like/Unlike event handler
 
Fired by YUI when parent element is available for scripting.
 
onRegisterRenderer(layer, args)
Register a metadata renderer via Bubbling event
 
onShowFolders(e, p_obj)
Show/Hide folders button checked handler
 
onSimpleDetailed(e, p_obj)
Show/Hide detailed list buttongroup click handler
 
onSortAscending(e, p_obj)
Sort direction button click handler
 
onSortField(sType, aArgs, p_obj)
Sort Field select button click handler
 
registerRenderer(propertyName, renderer)
Register a metadata renderer
 
selectFiles(p_selectType)
Public function to select files by specified groups
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.DocumentList(htmlId)
DocumentList constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.DocumentList} The new DocumentList instance
Field Detail
{object} actions
Object container for storing action markup elements.

{array} afterDocListUpdate
Deferred function calls for after a document list update

{object} currentActionsMenu
Current actions menu being shown
Default Value:
null

{object} currentFilter
Current filter to filter document list.

{int} currentPage
Current page being browsed.
Default Value:
1

{string} currentPath
Current path being browsed.

{object} deferredActionsMenu
Deferred actions menu element when showing "More Actions" pop-up.
Default Value:
null

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

{boolean} dragAndDropAllowed
Indicates whether or not we allow the HTML5 drag and drop capability

{boolean} dragAndDropEnabled
Indicates whether or not the browser supports the HTML5 drag and drop capability

{number} dragEventRefCount
Drag and drop dragEnter / dragLeave event reference counter

{boolean} dragFolderHighlight
Tracks currently highlighted folder when dragging files

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

{Alfresco.FileUpload} fileUpload
FileUpload module instance.

{object} options
Object container for initialization options

{object} renderers
Registered metadata renderers.
Register new renderers via registerRenderer() or "registerRenderer" bubbling event

{object} selectedFiles
Object literal of selected states for visible files (indexed by nodeRef).

{boolean} showingMoreActions
Whether "More Actions" pop-up is currently visible.
Default Value:
false

state
Keeps track of different states

{int} totalRecords
Total number of records (documents + folders) in the currentPath.
Default Value:
0
Method Detail
fnRenderCellActions()
Returns actions custom datacell formatter

fnRenderCellDescription()
Returns description/detail custom datacell formatter

fnRenderCellSelected()
Returns selector custom datacell formatter

fnRenderCellStatus()
Returns status custom datacell formatter

fnRenderCellThumbnail()
Returns thumbnail custom datacell formatter

<static> {string} Alfresco.DocumentList.generateCategoryMarkup(category)
Generate "changeFilter" event mark-up specifically for category changes
Parameters:
{Array} category
category[0] is name, category[1] is qnamePath
Returns:
{string} Mark-up for use in node attribute

<static> {string} Alfresco.DocumentList.generateComments(scope, record)
Generate "Comments" UI
Parameters:
{object} scope
DocumentLibrary instance
{object} record
File record
Returns:
{string} HTML mark-up for Comments UI

<static> {string} Alfresco.DocumentList.generateFavourite(scope, record)
Generate "Favourite" UI
Parameters:
{object} scope
DocumentLibrary instance
{object} record
File record
Returns:
{string} HTML mark-up for Favourite UI

<static> {string} Alfresco.DocumentList.generateFileFolderLinkMarkup(record, record)
Generate URL for a file- or folder-link that may be located within a different Site
Parameters:
{object} record
Item record
record
Returns:
{string} Mark-up for use in node attribute
      Folders: Navigate into the folder (ajax)
      Documents: Navigate to the details page (page)
   Links: Same site (or Repository mode)
      Links to folders: Navigate into the folder (ajax)
      Links to documents: Navigate to the details page (page)
   Links: Different site
      Links to folders: Navigate into the site & folder (page)
      Links to documents: Navigate to the details page within the site (page)

<static> {string} Alfresco.DocumentList.generateFilterMarkup(filter)
Generate "changeFilter" event mark-up suitable for element attribute.
Parameters:
{object} filter
Object literal containing new filter parameters
Returns:
{string} Mark-up for use in node attribute

<static> {string} Alfresco.DocumentList.generateLikes(scope, record)
Generate "Likes" UI
Parameters:
{object} scope
DocumentLibrary instance
{object} record
File record
Returns:
{string} HTML mark-up for Likes UI

<static> {string} Alfresco.DocumentList.generatePathMarkup(locn)
Generate "changeFilter" event mark-up specifically for path changes
Parameters:
{object} locn
Location object containing path and folder name to navigate to
Returns:
{string} Mark-up for use in node attribute

<static> {string} Alfresco.DocumentList.generateThumbnailUrl(record)
Generate URL to thumbnail image
Parameters:
{object} record
File record
Returns:
{string} URL to thumbnail

<static> {string} Alfresco.DocumentList.generateUserLink(scope, oUser)
Generate User Profile link
Parameters:
{object} scope
DocumentLibrary instance
{object} oUser
Object literal container user data
Returns:
{string} HTML mark-up for user profile link

{Array} getSelectedFiles()
Public function to get array of selected files
Returns:
{Array} Currently selected files

onActionCheckinFromGoogleDocs(record)
Check in a new version from Google Docs.
Parameters:
{object} record
Object literal representing the file to be actioned upon

onActionCheckoutToGoogleDocs(record)
Checkout to Google Docs.
Parameters:
{object} record
Object literal representing file or folder to be actioned

onActionEditOffline(record)
Edit Offline.
Parameters:
{object} record
Object literal representing file or folder to be actioned

onActionShowMore(record, elMore)
Show more actions pop-up.
Parameters:
{object} record
Object literal representing file or folder to be actioned
{element} elMore
DOM Element of "More Actions" link

onActivateDynamicControls(layer, args)
Activate Dynamic Controls event handler
(Re-)Activates controls taking part in dynamic deactivation
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onChangeFilter(layer, args)
DocList View change filter request event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (new filterId)

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 specifically defined controls.
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDocListRefresh(layer, args)
DocList Refresh Required event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (unused)

onDocumentListDragEnter(e)
Fired when an object is dragged into the DocumentList DOM element and then again when dragged into a Folder
icon image DOM element.
Parameters:
{object} e
HTML5 drag and drop event

onDocumentListDragLeave(e)
Fired when an object is dragged out of the DocumentList DOM element or the Folder icon image DOM element.
Parameters:
{object} e
HTML5 drag and drop event

onDocumentListDragOver(e)
Fired when an object is dragged into the DocumentList DOM element and then again when dragged into a Folder
icon image DOM element.
Parameters:
{object} e
HTML5 drag and drop event

onDocumentListDrop(e)
Fired when an object is dropped onto the DocumentList DOM element.
Checks that files are present for upload, determines the target (either the current document list or
a specific folder rendered in the document list and then calls on the DNDUpload singleton component
to perform the upload.
Parameters:
{object} e
HTML5 drag and drop event

onEventHighlightRow()
Custom event handler to highlight row.
Parameters:
oArgs.event
{HTMLEvent} Event object.
oArgs.target
{HTMLElement} Target element.

onEventUnhighlightRow()
Custom event handler to unhighlight row.
Parameters:
oArgs.event
{HTMLEvent} Event object.
oArgs.target
{HTMLElement} Target element.

onFileAction(layer, args)
Generic file action event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onFileRenamed(layer, args)
File or folder renamed event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onFileSelect(sType, aArgs, p_obj)
Multi-file select 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

onFilterChanged(layer, args)
DocList View Filter changed event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (new filterId)

onHighlightFile(layer, args)
Highlight file event handler
Used when a component (including the DocList itself on loading) wants to scroll to and highlight a file
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (filename to be highlighted)

onHistoryManagerReady()
Fired by YUI when History Manager is initialised and available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.

onLikes(row)
Like/Unlike event handler
Parameters:
{HTMLElement} row
DOM reference to a TR element (or child thereof)

onReady()
Fired by YUI when parent element is available for scripting.
Initial History Manager event registration

onRegisterRenderer(layer, args)
Register a metadata renderer via Bubbling event
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (property name, rendering function)

onShowFolders(e, p_obj)
Show/Hide folders button checked handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onSimpleDetailed(e, p_obj)
Show/Hide detailed list buttongroup click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onSortAscending(e, p_obj)
Sort direction button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onSortField(sType, aArgs, p_obj)
Sort Field select 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

{boolean} registerRenderer(propertyName, renderer)
Register a metadata renderer
Parameters:
{string} propertyName
Property name to attach this renderer to
{function} renderer
Rendering function
Returns:
{boolean} Success status of registration

selectFiles(p_selectType)
Public function to select files by specified groups
Parameters:
{string} p_selectType
Can be one of the following:

selectAll - all documents and folders
selectNone - deselect all
selectInvert - invert selection
selectDocuments - select all documents
selectFolders - select all folders

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