| Package | com.sibirjak.asdpc.treeview |
| Class | public class TreeView |
| Inheritance | TreeView ListView BindableView View Container flash.display.Sprite |
| Implements | ITreeView |
| Property | Defined by | ||
|---|---|---|---|
![]() | addedToStage : Boolean
True, if the View is included in the display list.
| View | |
![]() | dataSource : *
Sets or returns the list data source.
| ListView | |
![]() | dataSourceAdapterFunction : Function
Sets or returns a custom data source adapter function.
| ListView | |
![]() | deselect : Boolean
Defines or returns the list deselection behaviour.
| ListView | |
![]() | direction : String
Sets or gets the list direction.
| ListView | |
![]() | firstVisibleIndex : int
The current scroll postion of the list.
| ListView | |
![]() | height : Number | View | |
![]() | itemRenderer : Class
Sets an item renderer.
| ListView | |
![]() | maxScrollIndex : int
The max scroll postion of the list.
| ListView | |
![]() | multiselect : Boolean
Sets or returns the list to be a multiselect list.
| ListView | |
![]() | numItems : uint
The number of items currently displayed in the listView.
| ListView | |
![]() | select : Boolean
Defines or returns the list selection behaviour.
| ListView | |
![]() | selectedIndex : int
The list index of the first selected item.
| ListView | |
![]() | selectedIndices : Array
An array of all selected indices.
| ListView | |
![]() | selectedItemData : ListItemData
The first selected item.
| ListView | |
![]() | selectedItemsData : Array
An array of all selected items data.
| ListView | |
![]() | stage : Stage
Overrides the stage property to use the StageProxy instead.
| View | |
| style : TreeViewStyles
[static]
Central accessor to all TreeView style property definitions.
| TreeView | ||
![]() | styleManager : StyleManager
The clients StyleManager instance.
| Container | |
![]() | viewPropertyManager : ViewPropertyManager
The clients ViewPropertyManager instance.
| View | |
![]() | width : Number | View | |
| Method | Defined by | ||
|---|---|---|---|
|
TreeView()
TreeView constructor.
| TreeView | ||
![]() |
bindProperty(propertyName:String, listener:Object, listenerPropertyName:String = null):void
Binds a listener (bound listener) to a bindable property.
| BindableView | |
![]() |
cleanUp():void
Commands a view to immediately clean up all of its content.
| View | |
|
collapseNodeAt(listIndex:uint, collapseAll:Boolean = false):void
Collapses the node at the given index.
| TreeView | ||
![]() |
deselectItemAt(listIndex:uint):void
Deselects the item at the given position.
| ListView | |
|
expandNodeAt(listIndex:uint, expandAll:Boolean = false):void
Expands the node at the given index.
| TreeView | ||
![]() |
getDefaultStyles():Array
Returns a list of all default style properties.
| View | |
![]() |
getListItemDataAt(listIndex:uint):ListItemData
Returns a ListItemData object for the item at the given index.
| ListView | |
![]() |
getStyle(property:String):*
Returns a style value for a given style property.
| View | |
![]() |
getViewProperty(property:String):*
| View | |
![]() |
moveTo(x:int, y:int):void
Moves a view.
| View | |
![]() |
removeAllBindings():void
Removes all bindings.
| BindableView | |
![]() |
scrollToItemAt(listIndex:uint):void
Scrolls to the specified item.
| ListView | |
![]() |
selectItemAt(listIndex:uint):void
Selects the item at the given position.
| ListView | |
![]() |
setDefaultStyles(defaultStyles:Array):void
Sets a list of default styles, which are referred to, if no
actual style could be found for a property.
| View | |
![]() |
setSize(width:int, height:int):void
Sets the view dimensions.
| View | |
![]() |
setStyle(property:String, value:Array, selectorChain:Array = null, excludeChain:* = null):void
Sets a style to a client.
| View | |
![]() |
setStyles(styles:Array, selectorChain:Array = null, excludeChain:Array = null):void
Convenience method to set a number of styles values at once.
| View | |
![]() |
setViewProperty(property:String, value:*):void
| View | |
![]() |
styleManagerStyleChangeHandler(property:String, value:*):void
Notifies the client about a change of a style value for that it
defines a default style.
| View | |
![]() |
unbindProperty(propertyName:String, listener:Object, listenerPropertyName:String = null):void
Unbinds a formerly bound listener from a bindable property.
| BindableView | |
![]() |
validateNow():void
Commands a view to immediately validate all of its
invalidate properties.
| View | |
| Method | Defined by | ||
|---|---|---|---|
![]() |
applyToRenderers(applyFunction:Function, onlyVisibles:Boolean = true):void
Applies a function to all renderers.
| ListView | |
![]() |
cleanUpCalled():void
Called after cleanup is invoked for the view.
| ListView | |
![]() |
commitUpdate():void
Finalises an update process.
| View | |
![]() |
createListItemData(listIndex:uint):ListItemData
Creates the item data for the item at the given index.
| ListView | |
![]() |
createListItemEvent(type:String, listIndex:uint):ListItemEvent
Creates a ListItemEvent.
| ListView | |
![]() |
createListItemRendererData(listIndex:uint):ListItemRendererData
Creates the item renderer data for the item at the given index.
| ListView | |
![]() |
createListItemRendererEvent(type:String):ListItemRendererEvent
Creates a ListItemRendererEvent.
| ListView | |
![]() |
createListViewEvent(type:String):ListViewEvent
Creates a ListViewEvent.
| ListView | |
|
createNewDataSourceAdapter():IDataProvider
Creates a new data source adapter.
| TreeView | ||
![]() |
draw():void
Creates, draws and layouts sub views initially.
| ListView | |
|
getDefaultListItemRenderer():Class
Returns the concrete default item renderer.
| TreeView | ||
|
getItemIndex(listIndex:uint):*
Returns the position of the item in the containing collection.
| TreeView | ||
|
getItemKey(listIndex:uint):*
Returns the key of the item if the containing collection is an IMap.
| TreeView | ||
|
getListItemDataClass():Class
Returns the concrete ListItemData class.
| TreeView | ||
|
getListItemEventClass():Class
Returns the concrete ListItemEvent class.
| TreeView | ||
|
getListItemRendererDataClass():Class
Returns the concrete ListItemRendererData class.
| TreeView | ||
|
getListItemRendererEventClass():Class
Returns the concrete ListItemRendererEvent class.
| TreeView | ||
|
getListViewEventClass():Class
Returns the concrete ListViewEvent class.
| TreeView | ||
|
getParentItem(listIndex:uint):*
Returns the containing collection of the item at the given list index.
| TreeView | ||
![]() |
getRendererAt(listIndex:uint):IListItemRenderer
Returns the renderer at the given list index.
| ListView | |
|
init():void
Initialises view styles and properties.
| TreeView | ||
![]() |
initDataSource():void
Initialises the data source.
| ListView | |
|
initialised():void
Notifies a view after it has been fully initialised.
| TreeView | ||
![]() |
invalidate():void
Starts a property independent validation cycle.
| View | |
![]() |
invalidateProperty(property:String):void
Starts a property dependent validation cycle.
| View | |
![]() |
isInvalid(property:String):Boolean
Returns true if the given property has been marked
to be invalid beforehand.
| View | |
![]() |
removeFromAutoUpdate(subView:DisplayObject):void
Removes a sub view from the auto update list.
| View | |
|
setAdditionalListItemDataProperties(data:ListItemData):void
Sets additional list item data properties.
| TreeView | ||
![]() |
setBindableProperties(properties:Array):void
Sets a list of bindable properties.
| BindableView | |
![]() |
setDefaultSize(width:int, height:int):void
Defines a default size if no size is set else.
| View | |
![]() |
shouldUpdate(property:String):Boolean
Returns true if the given property has been marked
to be updated beforehand.
| View | |
|
styleChanged(property:String, value:*):void
Notifies the view about a change of a style value for that it
defines a default style.
| TreeView | ||
![]() |
update():void
Updates, redraws and layouts sub views.
| ListView | |
![]() |
updateAllBindings():void
Commands the BindingManager to update all bound listeners of a all properties.
| BindableView | |
![]() |
updateAutomatically(subView:DisplayObject):void
Marks a sub view to be updated automatically after an
update has been finished.
| View | |
![]() |
updateBindingsForProperty(propertyName:String, listeners:LinkedMap = null):void
Commands the BindingManager to update all bound listeners of a certain property.
| BindableView | |
![]() |
updateProperty(property:String):void
Marks a property to be updated in commitProperties().
| View | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
![]() |
Event type CLICK
Dispatched if the user clicks a list item. | ListView | ||
![]() |
Event type MOUSE_DOWN
Dispatched if the user presses the mouse over a list item. | ListView | ||
![]() |
Event type ROLL_OUT
Dispatched if the mouse leaves the list item area. | ListView | ||
![]() |
Event type ROLL_OVER
Dispatched if the mouse enters the list item area. | ListView | ||
![]() |
Event type SELECTION_CHANGED
Dispatched if the user has selected or deselected a list item. | ListView | ||
![]() |
Event type DATA_RESET
Dispatched after the list data source has been changed drastically. | ListView | ||
![]() |
Event type ITEM_ADDED
Dispatched if items have been added to the list. | ListView | ||
![]() |
Event type ITEM_REMOVED
Dispatched if items have been removed from the list. | ListView | ||
![]() |
Event type REFRESH
Dispatched every time the list is refreshed. | ListView | ||
![]() |
Event type SCROLL
Dispatched if the user scrolls the list by mouse. | ListView | ||
![]() |
Event type SELECTION_CHANGED
Dispatched if an item has been selected or deselected, both manually or programmatically. | ListView | ||
|
Event type COLLAPSED
Dispatched, after the user has collapsed a node. | TreeView | |||
|
Event type EXPANDED
Dispatched, after the user has expanded a node. | TreeView | |||
|
Event type COLLAPSED
Dispatched after a node has been collapsed, both manually or programmatically. | TreeView | |||
|
Event type EXPANDED
Dispatched after a node has been expanded, both manually or programmatically. | TreeView | |||
| Style | Description | Defined by | ||
|---|---|---|---|---|
![]() | Type: uint Format: Size Style property defining the list item size. | ListView | ||
![]() | Type: uint Format: Size Style property defining the scrollbar size. | ListView | ||
![]() | Type: String Style property defining the scrollbar visibility. | ListView | ||
![]() | Type: uint Format: Size Style property defining the selected item size. | ListView | ||
|
treeView_maxExpandAllLevel
| Type: uint Style property defining the max level for a recursive expansion. | TreeView | ||
|
treeView_showRoot
| Type: Boolean Style property defining the root node visibility. | TreeView | ||
| maxExpandAllLevel_internal | property |
maxExpandAllLevel_internal:uint [read-only]The max expand level in a recursive expansion.
Implementation asdpc_internal function get maxExpandAllLevel_internal():uint
| showRoot | property |
showRoot:Boolean [read-only]True, if the root node is visible.
Implementation asdpc_internal function get showRoot():Boolean
| style | property |
public static var style:TreeViewStylesCentral accessor to all TreeView style property definitions.
| TreeView | () | constructor |
public function TreeView()TreeView constructor.
| collapseNodeAt | () | method |
public function collapseNodeAt(listIndex:uint, collapseAll:Boolean = false):voidCollapses the node at the given index.
ParameterslistIndex:uint — The index of the node.
|
|
collapseAll:Boolean (default = false) — True, if the node should be collapsed recursively.
|
| collapseNodeAt_internal | () | method |
asdpc_internal function collapseNodeAt_internal(listIndex:uint, collapseAll:Boolean = false):voidCollapses a node.
ParameterslistIndex:uint — The list index of the node to collaps.
|
|
collapseAll:Boolean (default = false) — Flag, indicates if the node is recursively to collaps.
|
| createNewDataSourceAdapter | () | method |
protected override function createNewDataSourceAdapter():IDataProviderCreates a new data source adapter.
ReturnsIDataProvider — The data source Adapter.
|
| createTreeNodeRendererData_internal | () | method |
asdpc_internal function createTreeNodeRendererData_internal(treeNode:ITreeNode):ListItemRendererDataCreates a TreeNodeRendererData for a given TreeNode.
ParameterstreeNode:ITreeNode — The node to create the data for.
|
ListItemRendererData |
| expandNodeAt | () | method |
public function expandNodeAt(listIndex:uint, expandAll:Boolean = false):voidExpands the node at the given index.
ParameterslistIndex:uint — The index of the node.
|
|
expandAll:Boolean (default = false) — True, if the node should be expanded recursively.
|
| expandNodeAt_internal | () | method |
asdpc_internal function expandNodeAt_internal(listIndex:uint, expandAll:Boolean = false):voidExpands a node.
ParameterslistIndex:uint — The list index of the node to expand.
|
|
expandAll:Boolean (default = false) — Flag, indicates if the node is recursively to expand.
|
| getDefaultListItemRenderer | () | method |
protected override function getDefaultListItemRenderer():ClassReturns the concrete default item renderer.
ListView: ListItemRenderer
TreeView: TreeNodeRenderer
ReturnsClass — The concrete item renderer.
|
| getItemIndex | () | method |
protected override function getItemIndex(listIndex:uint):*Returns the position of the item in the containing collection.
ParameterslistIndex:uint |
* — The position of the item in the containing collection.
|
| getItemKey | () | method |
protected override function getItemKey(listIndex:uint):*Returns the key of the item if the containing collection is an IMap.
ParameterslistIndex:uint |
* — The key of item or null if the containing collection is not a map.
|
| getListItemDataClass | () | method |
protected override function getListItemDataClass():ClassReturns the concrete ListItemData class.
ListView: ListItemData
TreeView: TreeNodeData
ReturnsClass — The concrete ListItemData class.
|
| getListItemEventClass | () | method |
protected override function getListItemEventClass():ClassReturns the concrete ListItemEvent class.
ListView: ListItemEvent
TreeView: TreeNodeEvent
ReturnsClass — The concrete ListItemEvent class.
|
| getListItemRendererDataClass | () | method |
protected override function getListItemRendererDataClass():ClassReturns the concrete ListItemRendererData class.
ListView: ListItemRendererData
TreeView: TreeNodeRendererData
ReturnsClass — The concrete ListItemRendererData class.
|
| getListItemRendererEventClass | () | method |
protected override function getListItemRendererEventClass():ClassReturns the concrete ListItemRendererEvent class.
ListView: ListItemRendererEvent
TreeView: TreeNodeRendererEvent
ReturnsClass — The concrete ListItemRendererEvent class.
|
| getListViewEventClass | () | method |
protected override function getListViewEventClass():ClassReturns the concrete ListViewEvent class.
ListView: ListViewEvent
TreeView: TreeViewEvent
ReturnsClass — The concrete ListViewEvent class.
|
| getParentItem | () | method |
protected override function getParentItem(listIndex:uint):*Returns the containing collection of the item at the given list index.
ParameterslistIndex:uint |
* — The item's containing collection.
|
| init | () | method |
protected override function init():voidInitialises view styles and properties.
This method is called once right after the view has been added to the display list.
Here is the first place to access parent style properties. You use this method to perform operations connected with view styles or properties, e.g. caching style values into a local properties or evaluating property consistencies.
| initialised | () | method |
protected override function initialised():voidNotifies a view after it has been fully initialised.
This method is a hook to enable subclasses to perform further operations after the initialisation has been finished and the _initialised property is set to true.
You use this method to set or dispatch an initial view state, e.g. to select an item of a ListView instance.
The propetected property _initialised is set to true at this point.
| notifyRendererForConnectionChange_internal | () | method |
asdpc_internal function notifyRendererForConnectionChange_internal(listIndex:uint):voidNotifies the renderer at the given position about a connection change.
This method is called by the ListDataProvider after items have been added or removed. The node at the given position or one of its ancestors either:
In both cases the affected node and all of its children have to show new connections.
It is not necessary to perform an immediate validation.
ParameterslistIndex:uint — The position of the node in the list.
|
| notifyRendererForTreeNodeStateChange_internal | () | method |
asdpc_internal function notifyRendererForTreeNodeStateChange_internal(listIndex:uint):voidNotifies the renderer at the given position about a node state change.
If the state changes due to a expand or collaps operation, we wish the renderer to immediate reflect the changes.
ParameterslistIndex:uint — The position of the node in the list.
|
| setAdditionalListItemDataProperties | () | method |
protected override function setAdditionalListItemDataProperties(data:ListItemData):voidSets additional list item data properties.
Parametersdata:ListItemData — The list item data to update.
|
| styleChanged | () | method |
protected override function styleChanged(property:String, value:*):voidNotifies the view about a change of a style value for that it defines a default style.
To generally get notifications from the style manager, you need to declare all particular styles via the StyleManager.setDefaultStyles() method. You do this at best in the constructor of the client.
If this method has been called, you should update your view to reflect the changes in its visualisation.
Parametersproperty:String — The style name.
|
|
value:* — The style value.
|
| treeNode_collapsed | event |
com.sibirjak.asdpc.treeview.TreeNodeEvent
com.sibirjak.asdpc.treeview.TreeNodeEvent.COLLAPSED
Event type COLLAPSED
Dispatched, after the user has collapsed a node.
| treeNode_expanded | event |
com.sibirjak.asdpc.treeview.TreeNodeEvent
com.sibirjak.asdpc.treeview.TreeNodeEvent.EXPANDED
Event type EXPANDED
Dispatched, after the user has expanded a node.
| treeView_collapsed | event |
com.sibirjak.asdpc.treeview.TreeViewEvent
com.sibirjak.asdpc.treeview.TreeViewEvent.COLLAPSED
Event type COLLAPSED
Dispatched after a node has been collapsed, both manually or programmatically.
| treeView_expanded | event |
com.sibirjak.asdpc.treeview.TreeViewEvent
com.sibirjak.asdpc.treeview.TreeViewEvent.EXPANDED
Event type EXPANDED
Dispatched after a node has been expanded, both manually or programmatically.