Packagefeathers.layout
Classpublic class BaseLinearLayout
InheritanceBaseLinearLayout Inheritance BaseVariableVirtualLayout Inheritance starling.events.EventDispatcher
Subclasses HorizontalLayout, VerticalLayout

Product Version : Feathers 3.3.0

Abstract base class for HorizontalLayout and VerticalLayout.

See also

feathers.layout.HorizontalLayout
feathers.layout.VerticalLayout


Public Properties
 PropertyDefined By
  afterVirtualizedItemCount : int
BaseLinearLayout
  beforeVirtualizedItemCount : int
BaseLinearLayout
  firstGap : Number
The space, in pixels, between the first and second items.
BaseLinearLayout
  gap : Number
The space, in pixels, between items.
BaseLinearLayout
 InheritedhasVariableItemDimensions : Boolean
When the layout is virtualized, and this value is true, the items may have variable dimensions.
BaseVariableVirtualLayout
  horizontalAlign : String
The alignment of the items horizontally, on the x-axis.
BaseLinearLayout
  lastGap : Number
The space, in pixels, between the last and second to last items.
BaseLinearLayout
  padding : Number
Quickly sets all padding properties to the same value.
BaseLinearLayout
  paddingBottom : Number
The space, in pixels, that appears on the bottom.
BaseLinearLayout
  paddingLeft : Number
The minimum space, in pixels, to the left of the items.
BaseLinearLayout
  paddingRight : Number
The minimum space, in pixels, to the right of the items.
BaseLinearLayout
  paddingTop : Number
The space, in pixels, that appears on top.
BaseLinearLayout
 InheritedrequiresLayoutOnScroll : Boolean
[read-only] Determines if the container calls layout() when the scroll position changes.
BaseVariableVirtualLayout
  resetTypicalItemDimensionsOnMeasure : Boolean
If set to true, the width and height of the typicalItem will be reset to typicalItemWidth and typicalItemHeight, respectively, whenever the typical item needs to be measured.
BaseLinearLayout
 InheritedtypicalItem : DisplayObject
Used internally by a component that supports layout virtualization, such as List, to provide a display object with dimensions that represent a "typical" item in the layout.
BaseVariableVirtualLayout
  typicalItemHeight : Number
Used to reset the height, in pixels, of the typicalItem for measurement.
BaseLinearLayout
  typicalItemWidth : Number
Used to reset the width, in pixels, of the typicalItem for measurement.
BaseLinearLayout
 InheriteduseVirtualLayout : Boolean
Determines if virtual layout should be used.
BaseVariableVirtualLayout
  verticalAlign : String
The alignment of the items vertically, on the x-axis.
BaseLinearLayout
Public Methods
 MethodDefined By
  
Constructor.
BaseLinearLayout
 Inherited
addToVariableVirtualCacheAtIndex(index:int, item:DisplayObject = null):void
Inserts an item in to the cache at the specified index, pushing the old cached value at that index, and all following values, up one index.
BaseVariableVirtualLayout
 Inherited
Removes an item in to the cache at the specified index, moving the values at following indexes down by one.
BaseVariableVirtualLayout
 Inherited
Clears the cached dimensions for all virtualized indices.
BaseVariableVirtualLayout
 Inherited
resetVariableVirtualCacheAtIndex(index:int, item:DisplayObject = null):void
Clears the cached dimensions for one specific virtualized index.
BaseVariableVirtualLayout
Events
 Event Summary Defined By
 InheritedDispatched when a property of the layout changes, indicating that a redraw is probably needed.BaseVariableVirtualLayout
 InheritedDispatched when the layout would like to adjust the container's scroll position.BaseVariableVirtualLayout
Property Detail
afterVirtualizedItemCountproperty
afterVirtualizedItemCount:int


Implementation
    public function get afterVirtualizedItemCount():int
    public function set afterVirtualizedItemCount(value:int):void
beforeVirtualizedItemCountproperty 
beforeVirtualizedItemCount:int


Implementation
    public function get beforeVirtualizedItemCount():int
    public function set beforeVirtualizedItemCount(value:int):void
firstGapproperty 
firstGap:Number

The space, in pixels, between the first and second items. If the value of firstGap is NaN, the value of the gap property will be used instead.

The default value is NaN.


Implementation
    public function get firstGap():Number
    public function set firstGap(value:Number):void
gapproperty 
gap:Number

The space, in pixels, between items.

The default value is 0.


Implementation
    public function get gap():Number
    public function set gap(value:Number):void
horizontalAlignproperty 
horizontalAlign:String

The alignment of the items horizontally, on the x-axis.

The default value is feathers.layout.HorizontalAlign.LEFT.


Implementation
    public function get horizontalAlign():String
    public function set horizontalAlign(value:String):void
lastGapproperty 
lastGap:Number

The space, in pixels, between the last and second to last items. If the value of lastGap is NaN, the value of the gap property will be used instead.

The default value is NaN.


Implementation
    public function get lastGap():Number
    public function set lastGap(value:Number):void
paddingproperty 
padding:Number

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

The default value is 0.


Implementation
    public function get padding():Number
    public function set padding(value:Number):void

See also

paddingBottomproperty 
paddingBottom:Number

The space, in pixels, that appears on the bottom.

The default value is 0.


Implementation
    public function get paddingBottom():Number
    public function set paddingBottom(value:Number):void
paddingLeftproperty 
paddingLeft:Number

The minimum space, in pixels, to the left of the items.

The default value is 0.


Implementation
    public function get paddingLeft():Number
    public function set paddingLeft(value:Number):void
paddingRightproperty 
paddingRight:Number

The minimum space, in pixels, to the right of the items.

The default value is 0.


Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
paddingTopproperty 
paddingTop:Number

The space, in pixels, that appears on top.

The default value is 0.


Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
resetTypicalItemDimensionsOnMeasureproperty 
resetTypicalItemDimensionsOnMeasure:Boolean

If set to true, the width and height of the typicalItem will be reset to typicalItemWidth and typicalItemHeight, respectively, whenever the typical item needs to be measured. The measured dimensions of the typical item are used to fill in the blanks of a virtualized layout for virtual items that don't have their own display objects to measure yet.

The default value is false.


Implementation
    public function get resetTypicalItemDimensionsOnMeasure():Boolean
    public function set resetTypicalItemDimensionsOnMeasure(value:Boolean):void

See also

typicalItemHeightproperty 
typicalItemHeight:Number

Used to reset the height, in pixels, of the typicalItem for measurement. The measured dimensions of the typical item are used to fill in the blanks of a virtualized layout for virtual items that don't have their own display objects to measure yet.

This value is only used when resetTypicalItemDimensionsOnMeasure is set to true. If resetTypicalItemDimensionsOnMeasure is set to false, this value will be ignored and the typicalItem dimensions will not be reset before measurement.

If typicalItemHeight is set to NaN, the typical item will auto-size itself to its preferred height. If you pass a valid Number value, the typical item's height will be set to a fixed size. May be used in combination with typicalItemWidth.

The default value is NaN.


Implementation
    public function get typicalItemHeight():Number
    public function set typicalItemHeight(value:Number):void

See also

typicalItemWidthproperty 
typicalItemWidth:Number

Used to reset the width, in pixels, of the typicalItem for measurement. The measured dimensions of the typical item are used to fill in the blanks of a virtualized layout for virtual items that don't have their own display objects to measure yet.

This value is only used when resetTypicalItemDimensionsOnMeasure is set to true. If resetTypicalItemDimensionsOnMeasure is set to false, this value will be ignored and the typicalItem dimensions will not be reset before measurement.

If typicalItemWidth is set to NaN, the typical item will auto-size itself to its preferred width. If you pass a valid Number value, the typical item's width will be set to a fixed size. May be used in combination with typicalItemHeight.

The default value is NaN.


Implementation
    public function get typicalItemWidth():Number
    public function set typicalItemWidth(value:Number):void

See also

verticalAlignproperty 
verticalAlign:String

The alignment of the items vertically, on the x-axis.

The default value is feathers.layout.VerticalAlign.TOP.


Implementation
    public function get verticalAlign():String
    public function set verticalAlign(value:String):void
Constructor Detail
BaseLinearLayout()Constructor
public function BaseLinearLayout()

Constructor.