class
ComponentContainer

package haxe.ui.core

↪ haxe.ui.core.ComponentContainer


read-only
bottomComponent:Component
Gets the child component at the bottom of this component
behaviour
bindable
clonable
disabled:Bool
Whether to disable interactivity for this component or not.

The user can't interact with disabled components, and they don't
send state change events when the user tries to interact with them.
clonable
id:String
This component's identifier.
read-only
isReady:Bool
Whether the framework considers this component ready or not.
behaviour
bindable
clonable
text:String
The text displayed inside this component.
behaviour
bindable
clonable
tooltip::Dynamic
A tooltip to display near the cursor when hovering on top of this component for a while.

@see http://haxeui.org/explorer/#miscellaneous/tooltips
behaviour
bindable
clonable
tooltipRenderer:Component
Some sort of a "default" tooltip layout used when assigning tooltips.
Might be useful when you want to use complex tooltips.

@see http://haxeui.org/explorer/#miscellaneous/tooltips
read-only
topComponent:Component
Gets the child component at the top of this component
behaviour
bindable
clonable
value::Dynamic
The text displayed inside the label.

value is used as a universal way to access the "core" value a component is based on.
in this case, its the component's text.


addComponent(child:Component):Component
Adds a component to the end of this component's display list.

If this component already has children, the given component is added in front of the other children.

Parameters
child:Component
The child component to add to this component.

Returns
The added component.
addComponentAt(child:Component, index:Int):Component
Inserts a child component after index children, effectively adding it "in front" of index children, and "behind" the rest.

If index is below every other child's index, the added component will render behind this component's children.
If index is above every other child's index, the added component will render in front of this component's children.

For example, inserting a child into a VBox at index = 0 will place it at the top, "behind" all other children

Parameters
child:Component
The child component to add to this component.
index:Int
The index at which the child component should be added.

Returns
The added component.
cloneComponent():ComponentContainer
dispatch(event:UIEvent):Void
moveComponentBackward():Void
Moves this component behind the child component behind it.
moveComponentFrontward():Void
Moves this component to the front of the child component in front of it.
moveComponentToBack():Void
Sets this component's z-index to 0,
effectively putting it behind every single one of the parent's children.
moveComponentToFront():Void
Sets this component's z-index to parentComponent.numComponents - 1,
effectively putting it after in front of every single one of the parent's children.
removeComponent(child:Component, dispose:Bool = true, invalidate:Bool = true):Component
Removes a child component from this component's display list, and returns it.

Parameters
child:Component
The child component to remove from this component.
dispose:Bool = true
Decides whether or not the child component should be destroyed too.
invalidate:Bool = true
If true, the child component updates itself after the removal.

Returns
The removed child component
removeComponentAt(index:Int, dispose:Bool = true, invalidate:Bool = true):Component
Removes the child component at index index from this component's display list, and returns it.

Parameters
index:Int
The index of the child component to remove from this component.
dispose:Bool = true
Decides whether or not the child component should be destroyed too.
invalidate:Bool = true
If true, the child component updates itself after the removal.

Returns
The removed child component


read-only
childComponents:Array<Component>
An array of this component's children.

Note: If this component has no children, and empty array is returned.
parentComponent:Component
The parent component of this component instance.

Returns null if this component hasn't been added yet, or just doesn't have a parent.