new bbbfly.List (def, ref, parent)
Parameters
| Name | Type | Description |
|---|---|---|
| def | bbbfly.List.Definition | optional Descendant definition |
| ref | object | optional Reference owner |
| parent | object | string | optional Parent DIV element or it's ID |
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| ListIndent | integer | 0 | First level indent |
| DefaultIndent | integer | 10 | Each other tree level indent |
| Invalid | boolean | false | If list is invalid |
| HighlightClass | string | 'highlight' | Highlighted item CSS class |
| HighlightInterval | integer | 300 | Interval between highlight flashes |
| HighlightFlashCnt | integer | 2 | Number of highlight flashes |
| Columns | array | object | null | Define columns as object to allow their merging |
| Items | array | object | null | Define items as object to allow their merging |
Extends
- ngList
In Packages
Interfaces
Methods
-
CollapseItems (items){boolean}
-
Parameters:
Name Type Description items Array.<object> Will collapse item with the same ID if passed item contains ID property Returns:
Type Description boolean If items to expand were valid -
abstract DoSetInvalid (invalid, update){boolean}
-
Use this method to implement validity change
Parameters:
Name Type Default Description invalid boolean Validity state update boolean true optional If update list Returns:
Type Description boolean If validity change was not denied by OnSetInvalid() -
ExpandItems (items){boolean}
-
Parameters:
Name Type Description items Array.<object> Will expand to item with the same ID if passed item contains ID property Returns:
Type Description boolean If items to expand were valid -
ExpandToItem (item){boolean}
-
Parameters:
Name Type Description item object Will expand to item with the same ID if passed item contains ID property Returns:
Type Description boolean If item was found in list -
GetExpanded (){Array.<object>}
-
Returns:
Type Description Array.<object> Aray of expanded items with IDs as keys -
HighlightItem (item){boolean}
-
Parameters:
Name Type Description item object Will highlight item with the same ID if passed item contains ID property Returns:
Type Description boolean If item was found in list -
ScrollToItem (item){boolean}
-
Parameters:
Name Type Description item object Will scroll to item with the same ID if passed item contains ID property Returns:
Type Description boolean If item was found in list -
SetInvalid (invalid, update){boolean}
-
Parameters:
Name Type Default Description invalid boolean If set invalid or valid update boolean true optional If update list Returns:
Type Description boolean If validity change was not denied by OnSetInvalid()
Events
-
OnInvalidChanged ()
-
OnSetInvalid (list, invalid, update){boolean}
-
Parameters:
Name Type Description list bbbfly.List List reference invalid boolean If validity state should change to invalid update boolean If list should be updated Returns:
Type Description boolean Return false to deny validity change