Class Alfresco.ConsoleGroups
Extends Alfresco.ConsoleTool
ConsoleGroups tool component.
Defined in: groups.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.ConsoleGroups(htmlId)
ConsoleGroups constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The current group
|
|
|
The display name for the current group
|
|
|
Object container for initialization options
|
|
|
The query to use in a search in the panel
|
|
|
Decides if browse panels data needs to be refreshed
|
- Fields borrowed from class Alfresco.ConsoleTool:
- currentPanelId, panels, popups
- Fields borrowed from class Alfresco.component.Base:
- modules, services, widgets
| Method Attributes | Method Name and Description |
|---|---|
|
getParentGroups(shortName, successCallback, failureMessage)
Helper method for getting the parent groups for group with identifier shortName
|
|
|
onNewGroup(e, args)
New Group event handler
|
|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
|
|
onStateChanged(e, args)
History manager state change event handler (override base class)
|
|
|
onUpdateGroup(e, args)
Update Group event handler
|
- Methods borrowed from class Alfresco.ConsoleTool:
- onHistoryManagerReady
- Methods borrowed from class Alfresco.component.Base:
- attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, setMessages, setOptions
Constructor Detail
Alfresco.ConsoleGroups(htmlId)
ConsoleGroups constructor.
- Parameters:
- {String} htmlId
- The HTML id of the parent element
- Returns:
- {Alfresco.ConsoleGroups} The new ConsoleGroups instance
Field Detail
{string}
group
The current group
- Default Value:
- null
{string}
groupDisplayName
The display name for the current group
- Default Value:
- null
{object}
options
Object container for initialization options
{string}
query
The query to use in a search in the panel
- Default Value:
- null
{boolean}
refresh
Decides if browse panels data needs to be refreshed
- Default Value:
- false
Method Detail
getParentGroups(shortName, successCallback, failureMessage)
Helper method for getting the parent groups for group with identifier shortName
- Parameters:
- shortName
- the group identifier
- successCallback
- Callback object Called with the groups as the argument or null if group doesn't exist
- failureMessage
- Displayed if an error (other than 404) occurs
onNewGroup(e, args)
New Group event handler
- Parameters:
- {object} e
- DomEvent
- {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.
onStateChanged(e, args)
History manager state change event handler (override base class)
- Parameters:
- {object} e
- DomEvent
- {array} args
- Event parameters (depends on event type)
onUpdateGroup(e, args)
Update Group event handler
- Parameters:
- {object} e
- DomEvent
- {array} args
- Event parameters (depends on event type)