feathers.extensions.tree.Tree

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		alpha : Number The opacity of the object.	DisplayObject
		animate : Boolean Determines if open and close item has animate.	Tree
		autoSizeMode : String Determines how the container will set its own size when its dimensions (width and height) aren't set explicitly.	ScrollContainer
		base : DisplayObject [read-only] The topmost object in the display tree the object is part of.	DisplayObject
		blendMode : String The blend mode determines how the object is blended with the objects underneath.	DisplayObject
		bottomPullView : DisplayObject A view that is displayed at the bottom of the scroller's view port when dragging up.	Scroller
		bottomPullViewDisplayMode : String Indicates whether the bottom pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent.	DisplayObject
		dataProvider : Object The json displayed by the tree.	Tree
		defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance.	FeathersControl
		defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.	FeathersControl
		depth : int [read-only] The component's depth in the display list, relative to the stage.	FeathersControl
		draggable : Boolean Determines if items in the tree may be draggable.	Tree
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	FeathersControl
		filter : FragmentFilter The filter that is attached to the display object.	DisplayObject
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : IFocusManager The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.	FeathersControl
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.	FeathersControl
		globalStyleProvider : IStyleProvider [static] The default IStyleProvider for all BorderScrollContainer components.	BorderScrollContainer
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	FeathersControl
		horizontalPageCount : int [read-only] The number of horizontal pages, if snapping is enabled.	Scroller
		horizontalPageIndex : int The index of the horizontal page, if snapping is enabled.	Scroller
		horizontalScrollBarFactory : Function Creates the horizontal scroll bar.	Scroller
		horizontalScrollBarProperties : Object An object that stores properties for the container's horizontal scroll bar, and the properties will be passed down to the horizontal scroll bar when the container validates.	Scroller
		horizontalScrollPolicy : String Determines whether the scroller may scroll horizontally (on the x-axis) or not.	Scroller
		horizontalScrollPosition : Number The number of pixels the container has been scrolled horizontally (on the x-axis).	Scroller
		horizontalScrollStep : Number The number of pixels the horizontal scroll position can be adjusted by a "step".	Scroller
		hoverLineColor : uint The default color of lines when the mouse is hover.	Tree
		hoverSelector : Boolean Determines if the item highlighting when the mouse is hover.	Tree
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		indent : uint The indentation of tree item.	Tree
		is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object.	DisplayObject
		isBottomPullViewActive : Boolean Indicates if the bottomPullView has been activated.	Scroller
		isChildFocusEnabled : Boolean Determines if this component's children can receive focus.	ScrollContainer
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	FeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : Boolean The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.	FeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isLeftPullViewActive : Boolean Indicates if the leftPullView has been activated.	Scroller
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isRightPullViewActive : Boolean Indicates if the rightPullView has been activated.	Scroller
		isScrolling : Boolean [read-only] Determines if the scroller is currently scrolling with user interaction or with animation.	Scroller
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	FeathersControl
		isTopPullViewActive : Boolean Indicates if the topPullView has been activated.	Scroller
		itemRenderer : Object [write-only] The class used to instantiate item renderers.	Tree
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	FeathersControl
		leftPullView : DisplayObject A view that is displayed to the left of the scroller's view port when dragging to the right.	Scroller
		leftPullViewDisplayMode : String Indicates whether the left pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		lineSize : Number the size of the tree item renderer lines in pixels.	Tree
		maintainTouchFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.	FeathersControl
		mask : DisplayObject The display object that acts as a mask for the current object.	DisplayObject
		maskInverted : Boolean Indicates if the masked region of this object is set to be inverted.	DisplayObject
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		maxHorizontalPageIndex : int [read-only] The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.	Scroller
		maxHorizontalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled horizontally to the right.	Scroller
		maxVerticalPageIndex : int [read-only] The maximum vertical page index that may be displayed by this container, if page snapping is enabled.	Scroller
		maxVerticalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled vertically beyond the bottom edge.	Scroller
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		measureViewPort : Boolean Determines if the dimensions of the view port are used when measuring the scroller.	Scroller
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minHorizontalPageIndex : int [read-only] The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.	Scroller
		minHorizontalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled horizontally to the left.	Scroller
		minimumDragDistance : Number The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.	Scroller
		minimumPageThrowVelocity : Number The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page.	Scroller
		minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.	FeathersControl
		minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.	FeathersControl
		minVerticalPageIndex : int [read-only] The minimum vertical page index that may be displayed by this container, if page snapping is enabled.	Scroller
		minVerticalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled vertically beyond the top edge.	Scroller
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		name : String The name of the display object (default: null).	DisplayObject
		nextDownFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.	FeathersControl
		nextUpFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		numChildren : int [read-only] The number of children of this container.	DisplayObjectContainer
		numRawChildren : int [read-only] Returns the number of raw children that are added directly to the Scroller rather than delegating the call to the view port.	ScrollContainer
		pageHeight : Number When set, the vertical pages snap to this height value instead of the height of the scroller.	Scroller
		pageWidth : Number When set, the horizontal pages snap to this width value instead of the width of the scroller.	Scroller
		parent : DisplayObjectContainer [read-only] The display object container that contains this display object.	DisplayObject
		pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		previousTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.	FeathersControl
		requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e.	DisplayObject
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		rightPullView : DisplayObject A view that is displayed to the right of the scroller's view port when dragging to the left.	Scroller
		rightPullViewDisplayMode : String Indicates whether the right pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		root : DisplayObject [read-only] The root object the display object is connected to (i.e.	DisplayObject
		rotation : Number The rotation of the object in radians.	DisplayObject
		scale : Number Sets both 'scaleX' and 'scaleY' to the same value.	DisplayObject
		scaleX : Number The horizontal scale factor.	DisplayObject
		scaleY : Number The vertical scale factor.	DisplayObject
		selectable : Boolean Determines if terminal items in the tree may be selected.	Tree
		selectedIndex : Vector.<int> The index of the currently selected item.	Tree
		selectLineColor : uint The color of lines when a row is selected.	Tree
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		skewX : Number The horizontal skew angle in radians.	DisplayObject
		skewY : Number The vertical skew angle in radians.	DisplayObject
		stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage.	DisplayObject
		styleName : String The concatenated styleNameList, with values separated by spaces.	FeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	FeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	FeathersControl
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		topPullView : DisplayObject A view that is displayed at the top of the scroller's view port when dragging down.	Scroller
		topPullViewDisplayMode : String Indicates whether the top pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		touchable : Boolean Indicates if this object (and its children) will receive touch events.	DisplayObject
		touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object.	DisplayObjectContainer
		transformationMatrix : Matrix The transformation matrix of the object relative to its parent.	DisplayObject
		transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent.	DisplayObject
		useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite.	DisplayObject
		verticalMouseWheelScrollDirection : String The direction of scrolling when the user scrolls the mouse wheel vertically.	Scroller
		verticalMouseWheelScrollStep : Number The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel.	Scroller
		verticalPageCount : int [read-only] The number of vertical pages, if snapping is enabled.	Scroller
		verticalPageIndex : int The index of the vertical page, if snapping is enabled.	Scroller
		verticalScrollBarFactory : Function Creates the vertical scroll bar.	Scroller
		verticalScrollBarProperties : Object An object that stores properties for the container's vertical scroll bar, and the properties will be passed down to the vertical scroll bar when the container validates.	Scroller
		verticalScrollPolicy : String Determines whether the scroller may scroll vertically (on the y-axis) or not.	Scroller
		verticalScrollPosition : Number The number of pixels the container has been scrolled vertically (on the y-axis).	Scroller
		verticalScrollStep : Number The number of pixels the vertical scroll position can be adjusted by a "step".	Scroller
		viewPort : IViewPort The display object displayed and scrolled within the Scroller.	Scroller
		visible : Boolean The visibility of the object.	DisplayObject
		width : Number [override] The width of the component, in pixels.	FeathersControl
		x : Number The x coordinate of the object relative to the local coordinates of the parent.	DisplayObject
		y : Number The y coordinate of the object relative to the local coordinates of the parent.	DisplayObject

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		displayListBypassEnabled : Boolean = true A flag that indicates if the display list functions like addChild() and removeChild() will be passed to the internal view port.	ScrollContainer
		hasPendingHorizontalPageIndex : Boolean = false A flag that indicates if the scroller should scroll to a new page when it validates.	Scroller
		hasPendingVerticalPageIndex : Boolean = false A flag that indicates if the scroller should scroll to a new page when it validates.	Scroller
		horizontalScrollBar : IScrollBar The horizontal scrollbar instance.	Scroller
		horizontalScrollBarStyleName : String = feathers-scroller-horizontal-scroll-bar The value added to the styleNameList of the horizontal scroll bar.	Scroller
		pendingHorizontalPageIndex : int The pending horizontal page index to scroll to after validating.	Scroller
		pendingHorizontalScrollPosition : Number = NaN The pending horizontal scroll position to scroll to after validating.	Scroller
		pendingScrollDuration : Number The duration of the pending scroll action.	Scroller
		pendingVerticalPageIndex : int The pending vertical page index to scroll to after validating.	Scroller
		pendingVerticalScrollPosition : Number = NaN The pending vertical scroll position to scroll to after validating.	Scroller
		verticalScrollBar : IScrollBar The vertical scrollbar instance.	Scroller
		verticalScrollBarStyleName : String = feathers-scroller-vertical-scroll-bar The value added to the styleNameList of the vertical scroll bar.	Scroller

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Tree()	Tree
		addChild(child:DisplayObject):DisplayObject Adds a child to the container.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index.	DisplayObjectContainer
		addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object.	DisplayObject
		addItemAfter(item:Object, index:Vector.<int>):void Add a tree item after the specified index.	Tree
		addItemAt(item:Object, index:Vector.<int>):void Add a tree item in the specified index.	Tree
		addItemBefore(item:Object, index:Vector.<int>):void Add a tree item before the specified index.	Tree
		addRawChild(child:DisplayObject):DisplayObject Adds a child to the Scroller rather than delegating the call to the view port.	ScrollContainer
		addRawChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the Scroller at a specific index rather than delegating the call to the view port.	ScrollContainer
		alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object.	DisplayObject
		broadcastEvent(event:Event):void Dispatches an event on all children (recursively).	DisplayObjectContainer
		broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively).	DisplayObjectContainer
		close(index:Vector.<int>):void Close the the tree control at the specified index.	Tree
		contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively).	DisplayObjectContainer
		dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type.	EventDispatcher
		dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type.	EventDispatcher
		dispose():void [override] Disposes the resources of all children.	DisplayObjectContainer
		drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object.	DisplayObject
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.	FeathersControl
		getChildAt(index:int):DisplayObject Returns a child object at a certain index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively).	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found.	DisplayObjectContainer
		getItemAt(index:Vector.<int>):Object Get a tree item at the specified index.	Tree
		getItemIndex(myObject:Object, dropping:Object = null):Vector.<int> Get the index of an item at the specified index.	Tree
		getItemJsonAt(index:Vector.<int>):Object Get the json item associated with the tree (dataProvider) at the specified index.	Tree
		getItemJsonParentAt(index:Vector.<int>):Object Get the json item parent associated with the tree (dataProvider) at the specified index.	Tree
		getPathAt(index:Vector.<int>, separator:String = /, key:String = name):String Get the path of the specified item.	Tree
		getRawChildAt(index:int):DisplayObject Gets the direct child of the Scroller at a specific index rather than delegating the call to the view port.	ScrollContainer
		getRawChildByName(name:String):DisplayObject Gets the name of a direct child of the Scroller rather than delegating the call to the view port.	ScrollContainer
		getRawChildIndex(child:DisplayObject):int Gets the index of a direct child of the Scroller rather than delegating the call to the view port.	ScrollContainer
		getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system.	DisplayObject
		globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system.	DisplayObject
		hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for the given event type.	EventDispatcher
		hasItemAt(index:Vector.<int>):Boolean Indicates whether an item exist.	Tree
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.	DisplayObjectContainer
		hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask.	DisplayObject
		initializeNow():void If the component has not yet initialized, initializes immediately.	FeathersControl
		invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending.	FeathersControl
		isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not.	FeathersControl
		isItemOpenAt(index:Vector.<int>):Boolean Indicates whether an item is Open.	Tree
		local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates.	DisplayObject
		localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates.	DisplayObject
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		open(index:Vector.<int>):void Open the the tree control at the specified index.	Tree
		readjustLayout():void Readjusts the layout of the container according to its current content.	ScrollContainer
		removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container.	DisplayObjectContainer
		removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included).	DisplayObjectContainer
		removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object.	DisplayObject
		removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null.	DisplayObject
		removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it.	DisplayObject
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		removeItemAt(index:Vector.<int>):void Remove a tree item at the specified index.	Tree
		removeJsonChildrenAt(index:Vector.<int>):void Remove json item children at the specified index.	Tree
		removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the Scroller rather than delegating the call to the view port.	ScrollContainer
		removeRawChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child from the Scroller at a specific index rather than delegating the call to the view port.	ScrollContainer
		render(painter:Painter):void [override] Renders the display object with the help of a painter object.	DisplayObjectContainer
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	FeathersControl
		revealScrollBars():void If the scroll bars are floating, briefly show them as a hint to the user.	Scroller
		scrollToIndex(index:Vector.<int>):void Scroll to the index currently selected in the tabBar.	Tree
		scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void After the next validation, animates the scroll position to a specific page index.	Scroller
		scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void After the next validation, animates the scroll positions to a specific location.	Scroller
		setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index.	DisplayObjectContainer
		setItemAt(item:Object, index:Vector.<int>):void Replace a tree item at the specified index.	Tree
		setRawChildIndex(child:DisplayObject, index:int):void Sets the index of a direct child of the Scroller rather than delegating the call to the view port.	ScrollContainer
		setRequiresRedraw():void Forces the object to be redrawn in the next frame.	DisplayObject
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		showFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class).	DisplayObjectContainer
		sortRawChildren(compareFunction:Function):void Sorts the children of the Scroller rather than delegating the call to the view port.	ScrollContainer
		stopScrolling():void If the user is scrolling with touch or if the scrolling is animated, calling stopScrolling() will cause the scroller to ignore the drag and stop animations.	Scroller
		suspendEffects():void Indicates that effects should not be activated temporarily.	FeathersControl
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children.	DisplayObjectContainer
		swapRawChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the children of the Scroller rather than delegating the call to the view port.	ScrollContainer
		swapRawChildrenAt(index1:int, index2:int):void Swaps the children of the Scroller rather than delegating the call to the view port.	ScrollContainer
		validate():void Immediately validates the display object, if it is invalid.	FeathersControl

	Method	Defined By
		autoSizeIfNeeded():Boolean If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.	Scroller
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		completeScroll():void Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.	Scroller
		createScrollBars():void Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.	Scroller
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		focusInHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.	FeathersControl
		focusOutHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.	FeathersControl
		handlePendingScroll():void Scrolls to a pending scroll position, if required.	Scroller
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	FeathersControl
		initialize():void Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.	FeathersControl
		layoutChildren():void Positions and sizes children based on the actual width and height values.	Scroller
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshBackgroundSkin():void Choose the appropriate background skin based on the control's current state.	Scroller
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	FeathersControl
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl
		startScroll():void If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.	Scroller
		throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void Immediately throws the scroller to the specified position, with optional animation.	Scroller
		throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void Immediately throws the scroller to the specified page index, with optional animation.	Scroller

Summary	Defined By
added	Dispatched when an object is added to a parent.	DisplayObject
addedToStage	Dispatched when an object is connected to the stage (directly or indirectly).	DisplayObject
beginInteraction	Dispatched when the user starts dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user starts interacting with the scroll bar.	Scroller
change	Dispatched when a tree item changes.	Tree
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
dragComplete	Dispatched when a tree item is dragged and dropped.	Tree
endInteraction	Dispatched when the user stops dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user stops interacting with the scroll bar.	Scroller
enterFrame	Dispatched once every frame on every object that is connected to the stage.	DisplayObject
focusIn	Dispatched when the component receives focus.	Scroller
focusOut	Dispatched when the component loses focus.	Scroller
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
keyDown	Dispatched when a key on the keyboard is pressed.	DisplayObject
keyUp	Dispatched when a key on the keyboard is released.	DisplayObject
removed	Dispatched when an object is removed from its parent.	DisplayObject
removedFromStage	Dispatched when an object is removed from the stage and won't be rendered any longer.	DisplayObject
resize	Dispatched when the width or height of the control changes.	FeathersControl
scroll	Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed.	Scroller
scrollComplete	Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation.	Scroller
scrollStart	Dispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.	Scroller
select	Dispatched when a tree item is selected.	Tree
touch	Dispatched when an object is touched.	DisplayObject
update	Dispatched when a pull view is activated.	Scroller

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
autoHideBackground	Type: Boolean If `true`, the background's `visible` property will be set to `false` when the scroll position is greater than or equal to the minimum scroll position and less than or equal to the maximum scroll position. See also backgroundSkin	Scroller
backgroundDisabledSkin	Type: starling.display.DisplayObject A background to display when the container is disabled. See also backgroundSkin	Scroller
backgroundSkin	Type: starling.display.DisplayObject The default background to display. See also backgroundDisabledSkin	Scroller
clipContent	Type: Boolean If true, the viewport will be clipped to the scroller's bounds.	Scroller
customHorizontalScrollBarStyleName	Type: String A style name to add to the container's horizontal scroll bar sub-component. See also DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR feathers.core.FeathersControl.styleNameList horizontalScrollBarFactory	Scroller
customVerticalScrollBarStyleName	Type: String A style name to add to the container's vertical scroll bar sub-component. See also DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR feathers.core.FeathersControl.styleNameList verticalScrollBarFactory	Scroller
decelerationRate	Type: Number This value is used to decelerate the scroller when "thrown". See also feathers.controls.DecelerationRate.NORMAL feathers.controls.DecelerationRate.FAST	Scroller
elasticity	Type: Number If the scroll position goes outside the minimum or maximum bounds when the scroller's content is being actively dragged, the scrolling will be constrained using this multiplier. See also hasElasticEdges throwElasticity	Scroller
elasticSnapDuration	Type: Number The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds. See also hasElasticEdges	Scroller
focusIndicatorSkin	Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when `showFocus()` is called. See also focusPaddingTop focusPaddingRight focusPaddingBottom focusPaddingLeft focusPadding	FeathersControl
focusPadding	Type: Number Quickly sets all focus padding properties to the same value. See also focusPaddingTop focusPaddingRight focusPaddingBottom focusPaddingLeft	FeathersControl
focusPaddingBottom	Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingLeft	Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingRight	Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingTop	Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also focusPadding	FeathersControl
hasElasticEdges	Type: Boolean Determines if the scrolling can go beyond the edges of the viewport. See also elasticity throwElasticity	Scroller
hideScrollBarAnimationDuration	Type: Number The duration, in seconds, of the animation when a scroll bar fades out. See also scrollBarDisplayMode	Scroller
hideScrollBarAnimationEase	Type: Object The easing function used for hiding the scroll bars, if applicable. See also starling.animation.Transitions scrollBarDisplayMode	Scroller
horizontalScrollBarPosition	Type: String Determines where the horizontal scroll bar will be positioned. See also feathers.layout.RelativePosition.TOP feathers.layout.RelativePosition.BOTTOM	Scroller
interactionMode	Type: String Determines how the user may interact with the scroller. See also feathers.controls.ScrollInteractionMode.TOUCH feathers.controls.ScrollInteractionMode.MOUSE feathers.controls.ScrollInteractionMode.TOUCH_AND_SCROLL_BARS	Scroller
layout	Type: feathers.layout.ILayout Controls the way that the container's children are positioned and sized.	ScrollContainer
mouseWheelScrollDuration	Type: Number The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.	Scroller
padding	Type: Number Quickly sets all padding properties to the same value. See also paddingTop paddingRight paddingBottom paddingLeft	Scroller
paddingBottom	Type: Number The minimum space, in pixels, between the container's bottom edge and the container's content. See also padding	Scroller
paddingLeft	Type: Number The minimum space, in pixels, between the container's left edge and the container's content. See also padding	Scroller
paddingRight	Type: Number The minimum space, in pixels, between the container's right edge and the container's content. See also padding	Scroller
paddingTop	Type: Number The minimum space, in pixels, between the container's top edge and the container's content. See also padding	Scroller
pageThrowDuration	Type: Number The duration, in seconds, of the animation when the scroller is thrown to a page.	Scroller
revealScrollBarsDuration	Type: Number The duration, in seconds, that the scroll bars will be shown when calling `revealScrollBars()`. See also revealScrollBars()	Scroller
scrollBarDisplayMode	Type: String Determines how the scroll bars are displayed. See also feathers.controls.ScrollBarDisplayMode.FLOAT feathers.controls.ScrollBarDisplayMode.FIXED feathers.controls.ScrollBarDisplayMode.FIXED_FLOAT feathers.controls.ScrollBarDisplayMode.NONE	Scroller
snapScrollPositionsToPixels	Type: Boolean If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen.	Scroller
snapToPages	Type: Boolean Determines if scrolling will snap to the nearest page.	Scroller
throwEase	Type: Object The easing function used for "throw" animations. See also starling.animation.Transitions	Scroller
throwElasticity	Type: Number If the scroll position goes outside the minimum or maximum bounds when the scroller's content is "thrown", the scrolling will be constrained using this multiplier. See also hasElasticEdges elasticity	Scroller
useFixedThrowDuration	Type: Boolean If `true`, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity. See also decelerationRate	Scroller
verticalScrollBarPosition	Type: String Determines where the vertical scroll bar will be positioned. See also feathers.layout.RelativePosition.RIGHT feathers.layout.RelativePosition.LEFT	Scroller

	Constant	Defined By
		ALTERNATE_STYLE_NAME_TOOLBAR : String = feathers-toolbar-scroll-container [static] An alternate style name to use with ScrollContainer to allow a theme to give it a toolbar style.	ScrollContainer
		DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar [static] The default value added to the styleNameList of the horizontal scroll bar.	Scroller
		DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar [static] The default value added to the styleNameList of the vertical scroll bar.	Scroller
		INVALIDATION_FLAG_ALL : String = all [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = data [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_FOCUS : String = focus [static] Invalidation flag to indicate that the focus of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = layout [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = scroll [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = selected [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = size [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = skin [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = state [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = styles [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl

	Constant	Defined By
		INVALIDATION_FLAG_CLIPPING : String = clipping [static] Flag to indicate that the clipping has changed.	Scroller

Property Detail

animate

property

animate:Boolean

Determines if open and close item has animate.

The default value is false.

Implementation
public function get animate():Boolean
public function set animate(value:Boolean):void

dataProvider

property

dataProvider:Object

The json displayed by the tree. Changing this property to a new value is considered a drastic change to the tree's data, so the horizontal and vertical scroll positions will be reset, and the tree's selection will be cleared. JSON structure :

var json:Object = [
    {
        "name": "File 1",
        "url": "http://www.file1.com/"
    },
    {
        "name": "Folder 1",
        "children": [
            {
                "name": "File 2",
                "url": "http://www.file2.com/"
            },
            {
                "name": "Folder 2",
                "children": [
                    {
                        "name": "File 3",
                        "url": "http://www.file3.com/"
                    }
                ]
            }
        ]
    },
    {
        "name": "File 4",
        "url": "http://www.file4.com/"
    }
];

Implementation
public function get dataProvider():Object
public function set dataProvider(value:Object):void

draggable

property

draggable:Boolean

Determines if items in the tree may be draggable.

The default value is false.

Implementation
public function get draggable():Boolean
public function set draggable(value:Boolean):void

hoverLineColor

property

hoverLineColor:uint

The default color of lines when the mouse is hover.

The default value is 0xCCCCCC.

Implementation
public function get hoverLineColor():uint
public function set hoverLineColor(value:uint):void

hoverSelector

property

hoverSelector:Boolean

Determines if the item highlighting when the mouse is hover.

The default value is false.

Implementation
public function get hoverSelector():Boolean
public function set hoverSelector(value:Boolean):void

indent

property

indent:uint

The indentation of tree item.

The default value is 10.

Implementation
public function get indent():uint
public function set indent(value:uint):void

itemRenderer

property

itemRenderer:Object [write-only]

The class used to instantiate item renderers.

Implementation
public function set itemRenderer(value:Object):void

lineSize

property

lineSize:Number

the size of the tree item renderer lines in pixels.

The default value is 2.

Implementation
public function get lineSize():Number
public function set lineSize(value:Number):void

selectable

property

selectable:Boolean

Determines if terminal items in the tree may be selected.

The default value is false.

Implementation
public function get selectable():Boolean
public function set selectable(value:Boolean):void

selectedIndex

property

selectedIndex:Vector.<int>

The index of the currently selected item. It's a Vector.<int>.

Implementation
public function get selectedIndex():Vector.<int>
public function set selectedIndex(value:Vector.<int>):void

selectLineColor

property

selectLineColor:uint

The color of lines when a row is selected.

The default value is 0xCCCCCC.

Implementation
public function get selectLineColor():uint
public function set selectLineColor(value:uint):void

Constructor Detail

Tree

()

Constructor

public function Tree()

Method Detail

addItemAfter

()

method

public function addItemAfter(item:Object, index:Vector.<int>):void

Add a tree item after the specified index.

Parameters

	`item:Object` — the new item

	`index:Vector.<int>` — row index of the tree

addItemAt

()

method

public function addItemAt(item:Object, index:Vector.<int>):void

Add a tree item in the specified index. It's necessary that the item is a branch.

Parameters

	`item:Object` — the new item

	`index:Vector.<int>` — row index of the tree

addItemBefore

()

method

public function addItemBefore(item:Object, index:Vector.<int>):void

Add a tree item before the specified index.

Parameters

	`item:Object` — the new item

	`index:Vector.<int>` — row index of the tree

()

method

public function close(index:Vector.<int>):void

Close the the tree control at the specified index.

Parameters

index:Vector.<int> — row index of the tree

getItemAt

()

method

public function getItemAt(index:Vector.<int>):Object

Get a tree item at the specified index.

Parameters

index:Vector.<int> — row index of the tree

Returns

Object

getItemIndex

()

method

public function getItemIndex(myObject:Object, dropping:Object = null):Vector.<int>

Get the index of an item at the specified index.

Parameters

	`myObject:Object` — a tree item

	`dropping:Object` (default = `null`)

Returns

Vector.<int>

getItemJsonAt

()

method

public function getItemJsonAt(index:Vector.<int>):Object

Get the json item associated with the tree (dataProvider) at the specified index.

Parameters

index:Vector.<int> — row index of the tree

Returns

Object

getItemJsonParentAt

()

method

public function getItemJsonParentAt(index:Vector.<int>):Object

Get the json item parent associated with the tree (dataProvider) at the specified index.

Parameters

index:Vector.<int> — row index of the tree

Returns

Object

getPathAt

()

method

public function getPathAt(index:Vector.<int>, separator:String = /, key:String = name):String

Get the path of the specified item.

Parameters

	`index:Vector.<int>` — row index of the tree

	`separator:String` (default = `/`) — the separator path

	`key:String` (default = `name`) — the key of the json item object who will serve for the path

Returns

String

hasItemAt

()

method

public function hasItemAt(index:Vector.<int>):Boolean

Indicates whether an item exist.

Parameters

index:Vector.<int> — row index of the tree

Returns

Boolean

isItemOpenAt

()

method

public function isItemOpenAt(index:Vector.<int>):Boolean

Indicates whether an item is Open.

Parameters

index:Vector.<int> — row index of the tree

Returns

Boolean

open

()

method

public function open(index:Vector.<int>):void

Open the the tree control at the specified index.

Parameters

index:Vector.<int> — row index of the tree

removeItemAt

()

method

public function removeItemAt(index:Vector.<int>):void

Remove a tree item at the specified index.

Parameters

index:Vector.<int> — row index of the tree

removeJsonChildrenAt

()

method

public function removeJsonChildrenAt(index:Vector.<int>):void

Remove json item children at the specified index.

Parameters

index:Vector.<int> — row index of the tree

scrollToIndex

()

method

public function scrollToIndex(index:Vector.<int>):void

Scroll to the index currently selected in the tabBar.

Parameters

index:Vector.<int>

setItemAt

()

method

public function setItemAt(item:Object, index:Vector.<int>):void

Replace a tree item at the specified index.

Parameters

	`item:Object` — the new item

	`index:Vector.<int>` — row index of the tree

Event Detail

change

Event

Event Object Type: feathers.extensions.tree.events.TreeEvent

Dispatched when a tree item changes.

dragComplete

Event

Event Object Type: feathers.extensions.tree.events.DragDropTreeEvent

Dispatched when a tree item is dragged and dropped.

select

Event

Event Object Type: feathers.extensions.tree.events.TreeEvent

Dispatched when a tree item is selected.

Dimanche Mars 3 2019, 06:15 PM +01:00

Starling and Feathers Extensions AS3 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Tree	Properties \| Methods \| Events \| Styles \| Constants

Package	feathers.extensions.tree
Class	public class Tree
Inheritance	Tree BorderScrollContainer ScrollContainer Scroller FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object