Class Index | File Index

Classes


Class Alfresco.component.DataGrid

Extends Alfresco.component.Base
Data Lists: DataGrid component.
Defined in: datagrid.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
DataGrid constructor.
Field Summary
Field Attributes Field Name and Description
 
Deferred function calls for after a data grid update
 
Current actions menu being shown
 
Current filter to filter document list.
 
Current page being browsed.
 
Data List columns from Form configuration
 
Data List metadata retrieved from the Repository
 
Fields sent in the data request
 
Fields returned from the data request
 
Deferred actions menu element when showing "More Actions" pop-up.
 
Object container for initialization options
 
Object literal of selected states for visible items (indexed by nodeRef).
 
Whether "More Actions" pop-up is currently visible.
 
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 selector custom datacell formatter
 
getActionUrls(record)
The urls to be used when creating links in the action cell
 
Return data type-specific formatter
 
Public function to get array of selected items
 
Return data type-specific sorter
 
Edit Data Item pop-up
 
Current DataList changed event handler
 
onChangeFilter(layer, args)
DataList View change filter request event handler
 
onDataGridRefresh(layer, args)
DataGrid Refresh Required event handler
 
onDataItemCreated(layer, args)
Data Item created event handler
 
onDataItemsDeleted(layer, args)
Data Items deleted event handler
 
onDataItemUpdated(layer, args)
Data Item updated event handler
 
Data List column definitions returned from the Repository
 
Data List modified event handler
 
Custom event handler to highlight row.
 
Custom event handler to unhighlight row.
 
onFilterChanged(layer, args)
DataGrid View Filter changed event handler
 
Fired by YUI when History Manager is initialised and available for scripting.
 
onItemSelect(sType, aArgs, p_obj)
Multi-item select button click handler
 
Fired by YUI when parent element is available for scripting
 
Retrieves the Data List from the Repository
 
Renders Data List metadata, i.e. title and description
 
selectItems(p_selectType)
Public function to select items 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.component.DataGrid(htmlId)
DataGrid constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.component.DataGrid} The new DataGrid instance
Field Detail
{array} afterDataGridUpdate
Deferred function calls for after a data grid 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

{Object} datalistColumns
Data List columns from Form configuration

{Object} datalistMeta
Data List metadata retrieved from the Repository

{Object} dataRequestFields
Fields sent in the data request

{Object} dataResponseFields
Fields returned from the data request

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

{object} options
Object container for initialization options

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

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

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

fnRenderCellSelected()
Returns selector custom datacell formatter

{object} getActionUrls(record)
The urls to be used when creating links in the action cell
Parameters:
record
{YAHOO.widget.Record | Object} A data record, or object literal describing the item in the list
Returns:
{object} Object literal containing URLs to be substituted in action placeholders

{function} getCellFormatter()
Return data type-specific formatter
Returns:
{function} Function to render read-only value

{Array} getSelectedItems()
Public function to get array of selected items
Returns:
{Array} Currently selected items

{function} getSortFunction()
Return data type-specific sorter
Returns:
{function} Function to sort column by

onActionEdit(item)
Edit Data Item pop-up
Parameters:
{object} item
Object literal representing one data item

onActiveDataListChanged(layer, args)
Current DataList changed event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (unused)

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

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

onDataItemCreated(layer, args)
Data Item created event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDataItemsDeleted(layer, args)
Data Items deleted event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDataItemUpdated(layer, args)
Data Item updated event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onDatalistColumns(response)
Data List column definitions returned from the Repository
Parameters:
{Object} response
Ajax data structure

onDataListDetailsUpdated(layer, args)
Data List modified event handler
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters (unused)

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.

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

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

onItemSelect(sType, aArgs, p_obj)
Multi-item 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

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

populateDataGrid()
Retrieves the Data List from the Repository

renderDataListMeta()
Renders Data List metadata, i.e. title and description

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

selectAll - all items
selectNone - deselect all
selectInvert - invert selection

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