class Application
package feathers.controls
extends LayoutGroup › FeathersControl › MeasureSprite › ValidatingSprite
implements IFocusManagerAware
@:directlyUsed@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@:styleContextAn optional root class for Feathers UI applications that will automatically scale the application based on the screen density of the device.
1.0.0
.See also:
Static variables
staticread onlytopLevelApplication:Application
The first Application
instance created is the top-level application.
Feathers UI does not require developers to use the Application
component, so this value may be null
in some projects.
1.0.0
.Constructor
Variables
read onlyscaleFactor:Float
The application's scaling factor on the current device. One pixel in application coordinates is equal to this number of pixels in screen coordinates.
@:style@:flash.propertyscaleManager:IScaleManager
Manages the application's scale, position, and dimensions. The default
theme sets this to an instance of ScreenDensityScaleManager
, which
uses the window scale on desktop or web, or the screen DPI on mobile, to
determine how to scale the application within the stage bounds.
1.0.0
.See also:
popUpContainerFactory:() ‑> DisplayObjectContainer
A factory may be provided to return a custom container where the
application's pop-ups may be added when using PopUpManager
.
1.0.0
.See also:
Inherited Variables
Defined by LayoutGroup
autoSizeMode: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
.@:style@:flash.propertymaskSkin:DisplayObject
A skin to mask the content of the layout group. The skin is resized to
the full dimensions of the layout group. It is passed to the mask
property.
The following example passes a RectangleSkin
with a cornerRadius
for
the layout group's mask skin:
var maskSkin = new RectangleSkin();
maskSkin.fill = SolidColor(0xff0000);
maskSkin.cornerRadius = 10.0;
group.maskSkin = maskSkin;
1.0.0
.See also:
Defined by FeathersControl
@:bindable("creationComplete")read 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:
@:value(null)@:styledisabledAlpha:Null<Float> = null
When disabledAlpha
is not null
, sets the alpha
property to this
value when the the enabled
property is set to false
.
1.0.0
.@stylefocusPaddingBottom:Float
Optional padding outside the bottom edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@stylefocusPaddingLeft:Float
Optional padding outside the left edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@stylefocusPaddingRight:Float
Optional padding outside the right edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@stylefocusPaddingTop:Float
Optional padding outside the top edge of this UI component when the
focusRectSkin
is visible.
1.0.0
.@stylefocusRectSkin:DisplayObject
An optional skin to display when an IFocusObject
component receives
focus.
1.0.0
.@:bindable("layoutDataChange")includeInLayout:Bool
@:bindable("initialize")read 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:
@style@:bindable("layoutDataChange")layoutData:ILayoutData
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.
1.0.0
.styleProvider:IStyleProvider
Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.
When a component initializes, its style provider sets properties that
affect the component's visual appearance. If the style provider
dispatches StyleProviderEvent.STYLES_CHANGE
after the component has
initialized, the original properties set by the style provider will be
reset to their default values and before applying the new property
values.
Setting the style provider or replacing an existing style provider
before a component initializes will queue up the style changes until after
initialization. Once a component initializes, the style provider
may be changed, but the changes will be applied immediately. Similarly
to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE
,
any properties that were set by the previous style provider will be
reset to their default values before applying the new style provider.
If the themeEnabled
property is false
, the current theme's style
provider will be ignored. However, if a custom style provider was
provided from outside of the theme, it will still be used.
1.0.0
.See also:
variant: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
Defined by ValidatingSprite
read onlyvalidating:Bool
Indicates if the display object is currently validating.
1.0.0
.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, `FeathersEvent.INITIALIZE is dispatched.
The following example overrides initialization:
override private function initialize():Void {
super.initialize();
}
1.0.0
.See also:
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
setFocusPadding(value:Float):Void
Sets all four padding properties to the same value.
1.0.0
.See also:
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
.runWithInvalidationFlagsOnly(callback:() ‑> Void):Void
Calls a function that temporarily limits setInvalid()
calls to
setting invalidation flags only, and the control will not be added to
the validation queue. In other words, setInvalid()
calls will work
similarly to setInvalidationFlag()
instead.
Typically, this method should be called only during validation. If
called outside of update()
, the component's validation may be delayed
until a future call to setInvalid()
.
1.2.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
.