Class Alfresco.GroupFinder
Extends Alfresco.component.Base
GroupFinder component.
Defined in: group-finder.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.GroupFinder(htmlId)
GroupFinder constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Decoupled event listeners
|
|
|
Keeps track if this component is searching or not
|
|
|
Object container for storing YUI button instances, indexed by groupname.
|
|
|
Groups for whom the action is not allowed
|
|
|
Object container for initialization options
|
|
|
Current search term, obtained from form input field.
|
|
|
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 Attributes | Method Name and Description |
|---|---|
|
Public function to clear the results DataTable
|
|
|
onAllItemsDeselected(layer, args)
All Items Deselected event handler
|
|
|
onItemDeselected(layer, args)
Item Deselected event handler
|
|
|
onItemSelect(e, p_obj)
Select person button click handler
|
|
|
onItemSelected(layer, args)
Item Selected event handler
|
|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
|
|
onSearchClick(e, p_obj)
Search button click 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.GroupFinder(htmlId)
GroupFinder constructor.
- Parameters:
- {String} htmlId
- The HTML id of the parent element
- Returns:
- {Alfresco.GroupFinder} The new GroupFinder instance
Field Detail
eventGroup
Decoupled event listeners
{Boolean}
isSearching
Keeps track if this component is searching or not
{object}
itemSelectButtons
Object container for storing YUI button instances, indexed by groupname.
{array}
notAllowed
Groups for whom the action is not allowed
{object}
options
Object container for initialization options
{string}
searchTerm
Current search term, obtained from form input field.
{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
clearResults()
Public function to clear the results DataTable
onAllItemsDeselected(layer, args)
All Items Deselected event handler
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
onItemDeselected(layer, args)
Item Deselected event handler
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
onItemSelect(e, p_obj)
Select person button click handler
- Parameters:
- {object} e
- DomEvent
- {object} p_obj
- Object passed back from addListener method
onItemSelected(layer, args)
Item Selected 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.
Component initialisation, including instantiation of YUI widgets and event listener binding.
onSearchClick(e, p_obj)
Search button click event handler
- Parameters:
- {object} e
- DomEvent
- {object} p_obj
- Object passed back from addListener method