Package | feathers.controls |
Class | public class LayoutGroup |
Inheritance | LayoutGroup ![]() ![]() |
Subclasses | BaseMediaPlayer, LayoutGroupGroupedListHeaderOrFooterRenderer, LayoutGroupGroupedListItemRenderer, LayoutGroupListItemRenderer, Screen |
ScrollContainer
.
The following example creates a layout group with a horizontal layout and adds two buttons to it:
var group:LayoutGroup = new LayoutGroup(); var layout:HorizontalLayout = new HorizontalLayout(); layout.gap = 20; layout.padding = 20; group.layout = layout; this.addChild( group ); var yesButton:Button = new Button(); yesButton.label = "Yes"; group.addChild( yesButton ); var noButton:Button = new Button(); noButton.label = "No"; group.addChild( noButton );
See also
Property | Defined By | ||
---|---|---|---|
autoSizeMode : String
Determines how the layout group will set its own size when its
dimensions (width and height) aren't set explicitly. | LayoutGroup | ||
backgroundDisabledSkin : DisplayObject
The background to display behind all content when the layout group is
disabled. | LayoutGroup | ||
backgroundSkin : DisplayObject
The default background to display behind all content. | LayoutGroup | ||
clipContent : Boolean
If true, the group will be clipped to its bounds. | LayoutGroup | ||
![]() | 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 | |
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all LayoutGroup
components. | LayoutGroup | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | 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 | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
layout : ILayout
Controls the way that the group's children are positioned and sized. | LayoutGroup | ||
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | 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 | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | 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 | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height 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
globalStyleProvider property is set to this value. | FeathersControl | |
![]() | explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
![]() | explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
items : Vector.<DisplayObject>
The items added to the group. | LayoutGroup | ||
viewPortBounds : ViewPortBounds
The view port bounds result object passed to the layout. | LayoutGroup |
Method | Defined By | ||
---|---|---|---|
Constructor. | LayoutGroup | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
readjustLayout():void
Readjusts the layout of the group according to its current content. | LayoutGroup | ||
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current
state. | LayoutGroup | ||
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
refreshViewPortBounds():void
Refreshes the values in the viewPortBounds variable that
is passed to the layout. | LayoutGroup | ||
![]() | 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 |
Constant | Defined By | ||
---|---|---|---|
ALTERNATE_STYLE_NAME_TOOLBAR : String = feathers-toolbar-layout-group [static]
An alternate style name to use with LayoutGroup to
allow a theme to give it a toolbar style. | LayoutGroup | ||
AUTO_SIZE_MODE_CONTENT : String = content [static]
The layout group will auto size itself to fit its content. | LayoutGroup | ||
AUTO_SIZE_MODE_STAGE : String = stage [static]
The layout group will auto size itself to fill the entire stage. | LayoutGroup | ||
![]() | 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. | LayoutGroup |
autoSizeMode | property |
autoSizeMode:String
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 = LayoutGroup.AUTO_SIZE_MODE_STAGE;
The default value is LayoutGroup.AUTO_SIZE_MODE_CONTENT
.
public function get autoSizeMode():String
public function set autoSizeMode(value:String):void
See also
backgroundDisabledSkin | property |
backgroundDisabledSkin:DisplayObject
The background to display behind all content when the layout group is disabled. The background skin is resized to fill the full width and height of the layout group.
In the following example, the group is given a background skin:
group.backgroundDisabledSkin = new Image( texture );
The default value is null
.
public function get backgroundDisabledSkin():DisplayObject
public function set backgroundDisabledSkin(value:DisplayObject):void
backgroundSkin | property |
backgroundSkin:DisplayObject
The default background to display behind all content. The background skin is resized to fill the full width and height of the layout group.
In the following example, the group is given a background skin:
group.backgroundSkin = new Image( texture );
The default value is null
.
public function get backgroundSkin():DisplayObject
public function set backgroundSkin(value:DisplayObject):void
clipContent | property |
clipContent:Boolean
If true, the group will be clipped to its bounds. In other words, anything appearing beyond the edges of the group will be masked or hidden.
Since LayoutGroup
is designed to be a light
container focused on performance, clipping is disabled by default.
In the following example, clipping is enabled:
group.clipContent = true;
The default value is false
.
public function get clipContent():Boolean
public function set clipContent(value:Boolean):void
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all LayoutGroup
components.
The default value is null
.
See also
items | property |
protected var items:Vector.<DisplayObject>
The items added to the group.
layout | property |
layout:ILayout
Controls the way that the group's children are positioned and sized.
The following example tells the group to use a horizontal layout:
var layout:HorizontalLayout = new HorizontalLayout(); layout.gap = 20; layout.padding = 20; container.layout = layout;
The default value is null
.
public function get layout():ILayout
public function set layout(value:ILayout):void
viewPortBounds | property |
protected var viewPortBounds:ViewPortBounds
The view port bounds result object passed to the layout. Its values
should be set in refreshViewPortBounds()
.
LayoutGroup | () | Constructor |
public function LayoutGroup()
Constructor.
readjustLayout | () | method |
public function readjustLayout():void
Readjusts the layout of the group according to its current content.
Call this method when changes to the content cannot be automatically
detected by the container. For instance, Feathers components dispatch
FeathersEventType.RESIZE
when their width and height
values change, but standard Starling display objects like
Sprite
and Image
do not.
refreshBackgroundSkin | () | method |
protected function refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current state.
refreshViewPortBounds | () | method |
protected function refreshViewPortBounds():void
Refreshes the values in the viewPortBounds
variable that
is passed to the layout.
ALTERNATE_STYLE_NAME_TOOLBAR | Constant |
public static const ALTERNATE_STYLE_NAME_TOOLBAR:String = feathers-toolbar-layout-group
An alternate style name to use with LayoutGroup
to
allow a theme to give it a toolbar style. If a theme does not provide
a style for the toolbar container, the theme will automatically fall
back to using the default scroll container skin.
An alternate style name should always be added to a component's
styleNameList
before the component is initialized. If
the style name is added later, it will be ignored.
In the following example, the toolbar style is applied to a layout group:
var group:LayoutGroup = new LayoutGroup(); group.styleNameList.add( LayoutGroup.ALTERNATE_STYLE_NAME_TOOLBAR ); this.addChild( group );
See also
AUTO_SIZE_MODE_CONTENT | Constant |
public static const AUTO_SIZE_MODE_CONTENT:String = content
The layout group will auto size itself to fit its content.
See also
AUTO_SIZE_MODE_STAGE | Constant |
public static const AUTO_SIZE_MODE_STAGE:String = stage
The layout group will auto size itself to fill the entire stage.
See also
INVALIDATION_FLAG_CLIPPING | Constant |
protected static const INVALIDATION_FLAG_CLIPPING:String = clipping
Flag to indicate that the clipping has changed.