class LayoutViewPort
package feathers.controls.supportClasses
extends LayoutGroup › FeathersControl › MeasureSprite › ValidatingSprite
implements IViewPort
@:directlyUsed@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())An implementation of IViewPort
that provides support for layouts.
1.0.0
.Constructor
Variables
@:flash.propertymaxVisibleHeight:Null<Float>
@:flash.propertymaxVisibleWidth:Null<Float>
@:flash.propertyminVisibleHeight:Null<Float>
@:flash.propertyminVisibleWidth:Null<Float>
@:flash.propertyread onlyrequiresMeasurementOnScroll:Bool
@:flash.propertyvisibleHeight:Null<Float>
@:flash.propertyvisibleWidth:Null<Float>
Inherited Variables
Defined by LayoutGroup
@:flash.propertyautoSizeMode:AutoSizeMode
Determines how the layout group will set its own size when its dimensions (width and height) aren't set explicitly.
In the following example, the layout group will be sized to match the stage:
group.autoSizeMode = STAGE;
1.0.0
.See also:
@:style@:flash.propertybackgroundSkin:DisplayObject
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 passes a bitmap for the layout group to use as a background skin:
group.backgroundSkin = new Bitmap(bitmapData);
1.0.0
.See also:
@:style@:flash.propertydisabledBackgroundSkin:DisplayObject
The background skin to display behind all content added to the group when the group is disabled. 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.disabledBackgroundSkin = new Bitmap(bitmapData);
group.enabled = false;
1.0.0
.See also:
@:style@:flash.propertylayout:ILayout
The layout algorithm used to position and size the group's items.
The following example tells the group to use a vertical layout:
var layout = new VerticalLayout();
layout.gap = 20.0;
layout.padding = 20.0;
layout.horizontalAlign = CENTER;
group.layout = layout;
1.0.0
.Defined by FeathersControl
@:flash.propertyread onlycreated:Bool
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.created)
{
control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}
See also:
@style@:flash.propertyfocusPaddingBottom:Float
Optional padding outside the bottom edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@style@:flash.propertyfocusPaddingLeft:Float
Optional padding outside the left edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@style@:flash.propertyfocusPaddingRight:Float
Optional padding outside the right edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@style@:flash.propertyfocusPaddingTop:Float
Optional padding outside the top edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@style@:flash.propertyfocusRectSkin:DisplayObject
An optional skin to display when an IFocusObject
component receives
focus.
1.0.0
.@:flash.propertyread onlyinitialized:Bool
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.initialized)
{
control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
1.0.0
.See also:
@:flash.propertyread 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.
1.0.0
.@:flash.propertystyleProvider: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.
1.0.0
.See also:
@:flash.propertyvariant:String
May be used to provide multiple different variations of the same UI component, each with a different appearance.
1.0.0
.Defined by MeasureSprite
@:flash.propertyexplicitMaxHeight:Null<Float>
@:flash.propertyexplicitMinHeight:Null<Float>
Defined by ValidatingSprite
Inherited Methods
Defined by LayoutGroup
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.
The following example overrides initialization:
override private function initialize():Void {
super.initialize();
}
1.0.0
.move(x:Float, y:Float):Void
Sets both the x
and y
positions of the control in a single function
call.
1.0.0
.See also:
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.
1.0.0
.See also:
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.
1.0.0
.Defined by MeasureSprite
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.
1.0.0
.Defined by ValidatingSprite
isInvalid(?flag:InvalidationFlag):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
.
The following example invalidates a component:
component.setInvalid();
trace(component.isInvalid()); // true
1.0.0
.runWithoutInvalidation(callback:() ‑> Void):Void
Calls a function that temporarily disables invalidation. In other words,
calls to setInvalid()
will be ignored until the function returns.
1.0.0
.setInvalid(?flag:InvalidationFlag):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.
The following example invalidates a component:
component.setInvalid();
trace(component.isInvalid()); // true
1.0.0
.private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):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.
1.0.0
.See also:
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.
The following example overrides updating after invalidation:
override private function update():Void {
super.update();
}
1.0.0
.