Class Index | File Index

Classes


Class Alfresco.component.BaseFilter

Extends Alfresco.component.Base
Defined in: alfresco.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
Alfresco.component.BaseFilter(name, id, components)
Alfresco.component.BaseFilter constructor.
Field Summary
Field Attributes Field Name and Description
 
Flag to indicate whether all controls are deactivated or not.
 
Filter name, automatically generated from component name.
 
Selected filter.
 
Unique event key used to hook DOM clicks on filters
Fields borrowed from class Alfresco.component.Base:
modules, options, services, widgets
Method Summary
Method Attributes Method Name and Description
 
Called if this filter is the owner, but the filterId could be found in the DOM
 
Deactivate All Controls event handler
 
onFilterChanged(layer, args)
Fired when the currently active filter has changed
 
Fired by YUI when parent element is available for scripting.
 
setFilterIds(p_aFilterIds)
Set the filterId(s) this filter will be owning.
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.component.BaseFilter(name, id, components)
Alfresco.component.BaseFilter constructor.
Parameters:
{String} name
The name of the component
{String} id
he DOM ID of the parent element
{Array} components
Optional: Array of required YAHOO
Returns:
{object} The new instance
Field Detail
controlsDeactivated
Flag to indicate whether all controls are deactivated or not.

filterName
Filter name, automatically generated from component name.

selectedFilter
Selected filter.

uniqueEventKey
Unique event key used to hook DOM clicks on filters
Method Detail
handleFilterIdNotFound(filter)
Called if this filter is the owner, but the filterId could be found in the DOM
Parameters:
{object} filter
New filter trying to be set

onDeactivateAllControls(layer, args)
Deactivate All Controls event handler
Parameters:
{object} layer
Event fired
{array} args
Event parameters (depends on event type)

onFilterChanged(layer, args)
Fired when the currently active filter has changed
Parameters:
{string} layer
the event source
{object} args
arguments object

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

setFilterIds(p_aFilterIds)
Set the filterId(s) this filter will be owning.
Parameters:
{array} p_aFilterIds
Array of filterIds this filter will be owning

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