Available since

1.0.0

.

Constructor

new ()

Variables

@:value(null)dataProvider:IFlatCollection<Dynamic> = null

Available since

1.0.0

.

@:value(new DisplayObjectRecycler(ItemRenderer))itemRendererRecycler:DisplayObjectRecycler<Dynamic, ListBoxItemState, DisplayObject> = new DisplayObjectRecycler(ItemRenderer)

Available since

1.0.0

.

@:value(null)@:stylelayout:ILayout = null

Available since

1.0.0

.

@:value(true)selectable:Bool = true

@:value(-1)selectedIndex:Int = -1

Available since

1.0.0

.

@:value(null)@:isVarselectedItem:Dynamic = null

Available since

1.0.0

.

Methods

dynamicitemToText (data:Dynamic):String

Inherited Variables

Defined by BaseScrollContainer

@:value(true)@:styleautoHideScrollBars:Null<Bool> = true

Determines if the scroll bars should be automatically hidden after scrolling has ended, whether it was through user interaction or animation.

In the following example, scroll bar auto-hiding is disabled:

container.autoHideScrollBars = false;
Available since

1.0.0

.

@:value(null)@:stylebackgroundDisabledSkin:DisplayObject = null

The default background skin to display behind all content added to the group. The background skin is resized to fill the complete width and height of the group.

The following example gives the group a disabled background skin:

group.backgroundDisabledSkin = new Bitmap(bitmapData);
group.enabled = false;
Available since

1.0.0

.

See:

@:value(null)@:stylebackgroundSkin:DisplayObject = null

The default background skin to display behind all content added to the group. The background skin is resized to fill the complete width and height of the group.

The following example gives the group a background skin:

group.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See:

@:value(true)@:styleelasticEdges:Bool = true

Determines if the scrolling can go beyond the edges of the viewport when dragging with a touch.

In the following example, elastic edges are disabled:

container.elasticEdges = false;
Available since

1.0.0

.

@:value(false)@:stylefixedScrollBars:Null<Bool> = false

Determines if the scroll bars are fixed to the edges of the container, without overlapping the container's content, or if the scroll bars are floating above the container's content.

In the following example, the scroll bars are fixed:

container.fixedScrollBars = true;
Available since

1.0.0

.

@:value(0.2)@:stylehideScrollBarDuration:Float = 0.2

The duration, in seconds, of the animation when a scroll bar fades out.

In the following example, the duration of the animation that hides the scroll bars is set to 500 milliseconds:

container.hideScrollBarDuration = 0.5;
Available since

1.0.0

.

@:value(Quart.easeOut)@:stylehideScrollBarEase:IEasing = Quart.easeOut

The easing function used for hiding the scroll bars, if applicable.

In the following example, the ease of the animation that hides the scroll bars is customized:

container.hideScrollBarEase = Elastic.easeOut;
Available since

1.0.0

.

read onlymaxScrollX:Float

The number of pixels the container may be scrolled horizontally in the rightward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollX property may have a higher value than the maximum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the maximum position.

Available since

1.0.0

.

See:

read onlymaxScrollY:Float

The number of pixels the container may be scrolled vertically in the downward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollY property may have a higher value than the maximum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the maximum position.

Available since

1.0.0

.

See:

read onlyminScrollX:Float

The number of pixels the container may be scrolled horizontally in the leftward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollX property may have a lower value than the minimum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the minimum position.

Available since

1.0.0

.

See:

read onlyminScrollY:Float

The number of pixels the container may be scrolled vertically in the upward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollY property may have a lower value than the minimum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the minimum position.

Available since

1.0.0

.

See:

@:value(defaultScrollBarXFactory)scrollBarXFactory:Void ‑> IScrollBar = defaultScrollBarXFactory

Creates the horizontal scroll bar. The horizontal scroll bar may be any implementation of IScrollBar, but typically, the feathers.controls.HScrollBar component is used.

In the following example, a custom horizontal scroll bar factory is passed to the container:

scroller.scrollBarXFactory = () ->
{
	return new HScrollBar();
};
Available since

1.0.0

.

See:

@:value(BOTTOM)@:stylescrollBarXPosition:RelativePosition = BOTTOM

Determines the edge of the container where the horizontal scroll bar will be positioned (either on the top or the bottom).

In the following example, the horizontal scroll bar is positioned on the top edge of the container:

container.scrollBarXPosition = TOP;
Available since

1.0.0

.

See:

@:value(defaultScrollBarYFactory)scrollBarYFactory:Void ‑> IScrollBar = defaultScrollBarYFactory

Creates the vertical scroll bar. The vertical scroll bar may be any implementation of IScrollBar, but typically, the feathers.controls.VScrollBar component is used.

In the following example, a custom vertical scroll bar factory is passed to the container:

scroller.scrollBarYFactory = () ->
{
	return new VScrollBar();
};
Available since

1.0.0

.

See:

@:value(RIGHT)@:stylescrollBarYPosition:RelativePosition = RIGHT

Determines the edge of the container where the vertical scroll bar will be positioned (either on the left or the right).

In the following example, the vertical scroll bar is positioned on the left edge of the container:

container.scrollBarYPosition = LEFT;
Available since

1.0.0

.

See:

@:value(AUTO)scrollPolicyX:ScrollPolicy = AUTO

Determines whether the container may scroll horizontally (on the x-axis) or not.

In the following example, horizontal scrolling is disabled:

container.scrollPolicyX = OFF;
Available since

1.0.0

.

See:

@:value(AUTO)scrollPolicyY:ScrollPolicy = AUTO

Determines whether the container may scroll vertically (on the y-axis) or not.

In the following example, vertical scrolling is disabled:

container.scrollPolicyY = OFF;
Available since

1.0.0

.

See:

read onlyscrollX:Float

The number of pixels the container has been scrolled horizontally (on the x-axis).

In the following example, the horizontal scroll position is modified immediately, without being animated:

container.scrollX = 100.0;
Available since

1.0.0

.

See:

read onlyscrollY:Float

The number of pixels the container has been scrolled vertically (on the y-axis).

In the following example, the vertical scroll position is modified immediately, without being animated:

container.scrollY = 100.0;
Available since

1.0.0

.

See:

@:value(false)@:stylesimulateTouch:Bool = false

When simulating touch, mouse events are treated as if they were mouse events instead, allowing the user to click and drag the container with momentum scrolling using the mouse instead of touch.

Generally, this is intended for testing during development and should not be used in production.

container.simulateTouch = true;
Available since

1.0.0

.

private@:dox(show)viewPort:IViewPort

The display object rendered and scrolled within the container, provided by a subclass of BaseScrollContainer.

Available since

1.0.0

.

Defined by FeathersControl

@:value(false)read onlycreated:Bool = false

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if( !control.isCreated )
{
	control.addEventListener( FeathersEventType.CREATION_COMPLETE, creationCompleteHandler );
}

See:

@:value(true)@:isVarenabled:Bool = true

Indicates whether the control should respond when a user attempts to interact with it. The appearance of the control may also be affected by whether the control is enabled or disabled.

In the following example, the control is disabled:

component.enabled = false;
Available since

1.0.0

.

@:value(true)includeInLayout:Bool = true

Determines if the ILayout of the parent container should measure and position this object or ignore it.

In the following example, the object is excluded from the layout:

object.includeInLayout = false;
Available since

1.0.0

.

@:value(false)read onlyinitialized:Bool = false

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if( !control.isInitialized )
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See:

@:value(null)@stylelayoutData:ILayoutData = null

Optional, extra data used by some ILayout implementations.

Available since

1.0.0

.

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See:

variant

@:value(null)variant:String = null

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

@:value(null)@:isVarexplicitHeight:Null<Float> = null

@:value(null)@:isVarexplicitMaxHeight:Null<Float> = null

@:value(null)@:isVarexplicitMaxWidth:Null<Float> = null

@:value(null)@:isVarexplicitMinHeight:Null<Float> = null

@:value(null)@:isVarexplicitMinWidth:Null<Float> = null

@:value(null)@:isVarexplicitWidth:Null<Float> = null

maxHeight:Float

maxWidth:Float

minHeight:Float

minWidth:Float

Defined by ValidatingSprite

@:value(-1)read onlydepth:Int = -1

The object's depth in the display list, relative to the stage. If the object isn't on the stage, its depth will be -1.

Used by the validation system to validate objects from the top down.

Available since

1.0.0

.

Inherited Methods

Defined by FeathersControl

private@:dox(show)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. Do things like create children and set up event listeners. After this function is called, Event.INIT is dispatched.

Available since

1.0.0

.

initializeNow ():Void

If the component has not yet initialized, initializes immediately. The initialize() method will be called, and the FeathersEvent.INITIALIZE event will be dispatched. Then, if the component has a style provider, it will be applied. The component will not validate, though. To both initialize and validate immediately, call validateNow() instead.

Available since

1.0.0

.

move (x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See:

DisplayObject.x

DisplayObject.y

setSize (width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See:

DisplayObject.width

DisplayObject.height

private@:dox(show)setStyle (styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

resetHeight ():Void

Resets the height so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMaxHeight ():Void

Resets the maximum height so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMaxWidth ():Void

Resets the maximum width so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMinHeight ():Void

Resets the minimum height so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMinWidth ():Void

Resets the minimum width so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetWidth ():Void

Resets the width so that it will be calculated automatically by the component.

Available since

1.0.0

.

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements (width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

@:value({ flag : null })isInvalid (?flag:String):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

Available since

1.0.0

.

@:value({ flag : null })setInvalid (?flag:String):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

Available since

1.0.0

.

private@:dox(show)setInvalidationFlag (flag:String):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See:

private@:dox(show)update ():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

Available since

1.0.0

.