Class Index | File Index

Classes


Class Alfresco.ObjectFinder

Extends Alfresco.component.Base
ObjectFinder component.
Defined in: object-finder.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
Alfresco.ObjectFinder(htmlId, currentValueHtmlId)
ObjectFinder constructor.
Field Summary
Field Attributes Field Name and Description
 
Resizable columns
 
Decoupled event listeners
 
Determines if this component is ready (to be called from outside)
 
Object container for initialization options
 
Selected items. Keeps a list of selected items for correct Add button state.
 
Single selected item, for when in single select mode
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
Returns if an item can be selected
 
Destroy method - deregister Bubbling event handlers
 
Returns Icon with generic width datacell formatter
 
Returns Icon datacell formatter
 
Returns Action item custom datacell formatter
 
Returns Action item custom datacell formatter
 
Returns Name / description datacell formatter
 
Returns Remove item custom datacell formatter
 
Returns items that have been added to the current value
 
Returns items that have been removed from the current value
 
Returns currently selected items
 
onAddButtonClick(e, p_obj)
Add button click handler, shows picker
 
onCancel(e, p_obj)
Picker Cancel button click handler
 
Create New Cancel button click handler
 
onCreateNewOK(e, p_obj)
Create New OK button click handler
 
onFolderUp(e, p_obj)
Folder Up Navigate button click handler
 
Notification that form is being destroyed.
 
onOK(e, p_obj)
Picker OK button click handler
 
onParentChanged(layer, args)
Parent changed event handler
 
onParentDetails(layer, args)
Parent Details updated event handler
 
Fired by YUI when parent element is available for scripting.
 
Removes all list itesm from the current value list used in "list" display mode
 
onRemoveListItem(layer, args)
Removes selected item from datatable used in "list" mode
 
onRenderCurrentValue(layer, args)
Renders current value in reponse to an event
 
Triggers a search
 
onSelectedItemAdded(layer, args)
Selected Item Added event handler
 
onSelectedItemRemoved(layer, args)
Selected Item Removed event handler
 
selectItems(items)
Populate selected items.
 
Set messages for this component.
 
Set multiple initialization options at once.
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh
Constructor Detail
Alfresco.ObjectFinder(htmlId, currentValueHtmlId)
ObjectFinder constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
{String} currentValueHtmlId
The HTML id of the parent element
Returns:
{Alfresco.ObjectFinder} The new ObjectFinder instance
Field Detail
{array} columns
Resizable columns
Default Value:
[]

eventGroup
Decoupled event listeners

{boolean} isReady
Determines if this component is ready (to be called from outside)

{object} options
Object container for initialization options

{object} selectedItems
Selected items. Keeps a list of selected items for correct Add button state.

{string} singleSelectedItem
Single selected item, for when in single select mode
Method Detail
{boolean} canItemBeSelected(id)
Returns if an item can be selected
Parameters:
{string} id
Item id (nodeRef)
Returns:
{boolean}

destroy()
Destroy method - deregister Bubbling event handlers

fnRenderCellGenericIcon()
Returns Icon with generic width datacell formatter

fnRenderCellIcon()
Returns Icon datacell formatter

fnRenderCellListItemActions()
Returns Action item custom datacell formatter

fnRenderCellListItemName()
Returns Action item custom datacell formatter

fnRenderCellName()
Returns Name / description datacell formatter

fnRenderCellRemove()
Returns Remove item custom datacell formatter

{array} getAddedItems()
Returns items that have been added to the current value
Returns:
{array}

{array} getRemovedItems()
Returns items that have been removed from the current value
Returns:
{array}

{array} getSelectedItems()
Returns currently selected items
Returns:
{array}

onAddButtonClick(e, p_obj)
Add button click handler, shows picker
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onCancel(e, p_obj)
Picker Cancel button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

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

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

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

onFormContainerDestroyed(layer, args)
Notification that form is being destroyed.
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters

onOK(e, p_obj)
Picker OK button click handler
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onParentChanged(layer, args)
Parent changed event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onParentDetails(layer, args)
Parent Details updated event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

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

onRemoveAllButtonClick(e, p_obj)
Removes all list itesm from the current value list used in "list" display mode
Parameters:
{object} e
DomEvent
{object} p_obj
Object passed back from addListener method

onRemoveListItem(layer, args)
Removes selected item from datatable used in "list" mode
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters

onRenderCurrentValue(layer, args)
Renders current value in reponse to an event
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters

onSearch()
Triggers a search

onSelectedItemAdded(layer, args)
Selected Item Added event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onSelectedItemRemoved(layer, args)
Selected Item Removed event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

selectItems(items)
Populate selected items.
Parameters:
{Array} items
Array of item ids to populate the current value with

{Alfresco.ObjectFinder} setMessages(obj)
Set messages for this component.
Parameters:
{object} obj
Object literal specifying a set of messages
Returns:
{Alfresco.ObjectFinder} returns 'this' for method chaining

{Alfresco.ObjectFinder} setOptions(obj)
Set multiple initialization options at once.
Parameters:
{object} obj
Object literal specifying a set of options
Returns:
{Alfresco.ObjectFinder} returns 'this' for method chaining

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