Packagecom.flextoolbox.controls
Classpublic class AdvancedList
InheritanceAdvancedList Inheritance mx.controls.List
SubclassesCheckBoxList

An extension of the standard Flex List control. Like the labelField and labelFunction properties, similar properties for the enabled value of item renderers give developers more control over the list. Custom drag formats allow developers to limit drag-and-drop between lists and create more powerful interactions.



Public Properties
 PropertyDefined by
  dragFormat : String
Sets the string value used to restrict the locations where dragged items from this list may be dropped.
AdvancedList
  enabledField : String
The name of the field in the data provider items to determine if the item renderer should be enabled.
AdvancedList
  enabledFunction : Function
A user-supplied function to run on each item to determine if its renderer is enabled.
AdvancedList
Public Methods
 MethodDefined by
  
Constructor.
AdvancedList
  
isItemEnabled(item:Object):Boolean
Determines if the item renderer for a data provider item is enabled and if the user may interact with it.
AdvancedList
Property detail
dragFormatproperty
dragFormat:String  [read-write]

Sets the string value used to restrict the locations where dragged items from this list may be dropped. The standard mx.controls.List class offers no functionality to let the developer manipulate this value.

This property can be used as the source for data binding.

Implementation
    public function get dragFormat():String
    public function set dragFormat(value:String):void

See also

mx.managers.DragManager
mx.managers.dragClasses.DragSource
enabledFieldproperty 
enabledField:String  [read-write]

The name of the field in the data provider items to determine if the item renderer should be enabled. By default the list looks for a property named enabled on each item. However, if the data objects do not contain an enabled property, you can set the enabledField property to use a different value in the data object.

This property can be used as the source for data binding.

Implementation
    public function get enabledField():String
    public function set enabledField(value:String):void
enabledFunctionproperty 
enabledFunction:Function  [read-write]

A user-supplied function to run on each item to determine if its renderer is enabled. By default, the list looks for a property named enabled on each data provider item and displays it. However, some data sets do not have an enabled property nor do they have another property that can be used.

The enabled function takes a single argument which is the item in the data provider and returns a Boolean value.

enabledFunction(item:Object):Boolean

This property can be used as the source for data binding.

Implementation
    public function get enabledFunction():Function
    public function set enabledFunction(value:Function):void
Constructor detail
AdvancedList()constructor
public function AdvancedList()

Constructor.

Method detail
isItemEnabled()method
public function isItemEnabled(item:Object):Boolean

Determines if the item renderer for a data provider item is enabled and if the user may interact with it. This value is not related to selection. If the list is selectable, but an item is disabled, that item may not be selected.

Parameters
item:Object — The data provider item

Returns
Booleantrue if the item is enabled, and false if it is not.