Packagefeathers.layout
Classpublic class BaseTiledLayout
InheritanceBaseTiledLayout Inheritance starling.events.EventDispatcher
Subclasses TiledColumnsLayout, TiledRowsLayout

Product Version : Feathers 3.3.0

Abstract base class for TiledRowsLayout and TiledColumnsLayout.

See also

feathers.layout.TiledRowsLayout
feathers.layout.TiledColumnsLayout


Public Properties
 PropertyDefined By
  distributeHeights : Boolean
If the total height of the tiles in a column (minus padding and gap) does not fill the entire column, the remaining space will be distributed to each tile equally.
BaseTiledLayout
  distributeWidths : Boolean
If the total width of the tiles in a row (minus padding and gap) does not fill the entire row, the remaining space will be distributed to each tile equally.
BaseTiledLayout
  gap : Number
Quickly sets both horizontalGap and verticalGap to the same value.
BaseTiledLayout
  horizontalAlign : String
If the total row width is less than the bounds, the items in the row can be aligned horizontally.
BaseTiledLayout
  horizontalGap : Number
The horizontal space, in pixels, between tiles.
BaseTiledLayout
  padding : Number
Quickly sets all padding properties to the same value.
BaseTiledLayout
  paddingBottom : Number
The space, in pixels, below the items.
BaseTiledLayout
  paddingLeft : Number
The space, in pixels, to the left of the items.
BaseTiledLayout
  paddingRight : Number
The space, in pixels, to the right of the items.
BaseTiledLayout
  paddingTop : Number
The space, in pixels, above of items.
BaseTiledLayout
  paging : String
Indicates if tiles are divided into pages vertically or horizontally, or if paging is disabled.
BaseTiledLayout
  requestedColumnCount : int
Requests that the layout uses a specific number of columns in a row, if possible.
BaseTiledLayout
  requestedRowCount : int
Requests that the layout uses a specific number of rows, if possible.
BaseTiledLayout
  requiresLayoutOnScroll : Boolean
[read-only] Determines if the container calls layout() when the scroll position changes.
BaseTiledLayout
  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.
BaseTiledLayout
  tileHorizontalAlign : String
If the item's width is less than the tile bounds, the position of the item can be aligned horizontally.
BaseTiledLayout
  tileVerticalAlign : String
If an item's height is less than the tile bounds, the position of the item can be aligned vertically.
BaseTiledLayout
  typicalItem : 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.
BaseTiledLayout
  typicalItemHeight : Number
Used to reset the height, in pixels, of the typicalItem for measurement.
BaseTiledLayout
  typicalItemWidth : Number
Used to reset the width, in pixels, of the typicalItem for measurement.
BaseTiledLayout
  useSquareTiles : Boolean
Determines if the tiles must be square or if their width and height may have different values.
BaseTiledLayout
  useVirtualLayout : Boolean
Determines if virtual layout should be used.
BaseTiledLayout
  verticalAlign : String
If the total column height is less than the bounds, the items in the column can be aligned vertically.
BaseTiledLayout
  verticalGap : Number
The vertical space, in pixels, between tiles.
BaseTiledLayout
Public Methods
 MethodDefined By
  
Constructor.
BaseTiledLayout
Events
 Event Summary Defined By
  Dispatched when a property of the layout changes, indicating that a redraw is probably needed.BaseTiledLayout
Property Detail
distributeHeightsproperty
distributeHeights:Boolean

If the total height of the tiles in a column (minus padding and gap) does not fill the entire column, the remaining space will be distributed to each tile equally.

If the container using the layout might resize, setting requestedRowCount is recommended because the tiles will resize too, and their dimensions may not be reset.

Note: If useSquareTiles is true, the distributeHeights property will be ignored.

The default value is false.


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

See also

distributeWidthsproperty 
distributeWidths:Boolean

If the total width of the tiles in a row (minus padding and gap) does not fill the entire row, the remaining space will be distributed to each tile equally.

If the container using the layout might resize, setting requestedColumnCount is recommended because the tiles will resize too, and their dimensions may not be reset.

The default value is false.


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

See also

gapproperty 
gap:Number

Quickly sets both horizontalGap and verticalGap to the same value. The gap getter always returns the value of horizontalGap, but the value of verticalGap may be different.

The default value is 0.


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

See also

horizontalAlignproperty 
horizontalAlign:String

If the total row width is less than the bounds, the items in the row can be aligned horizontally.

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


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

See also

horizontalGapproperty 
horizontalGap:Number

The horizontal space, in pixels, between tiles.

The default value is 0.


Implementation
    public function get horizontalGap():Number
    public function set horizontalGap(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, below the items.

The default value is 0.


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

The 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 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, above of items.

The default value is 0.


Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
pagingproperty 
paging:String

Indicates if tiles are divided into pages vertically or horizontally, or if paging is disabled.

The default value is feathers.layout.Direction.NONE.


Implementation
    public function get paging():String
    public function set paging(value:String):void

See also

requestedColumnCountproperty 
requestedColumnCount:int

Requests that the layout uses a specific number of columns in a row, if possible. Set to 0 to calculate the maximum of columns that will fit in the available space.

If the view port's explicit or maximum width is not large enough to fit the requested number of columns, it will use fewer. If the view port doesn't have an explicit width and the maximum width is equal to Number.POSITIVE_INFINITY, the width will be calculated automatically to fit the exact number of requested columns.

If paging is enabled, this value will be used to calculate the number of columns in a page. If paging isn't enabled, this value will be used to calculate a minimum number of columns, even if there aren't enough items to fill each column.

The default value is 0.


Implementation
    public function get requestedColumnCount():int
    public function set requestedColumnCount(value:int):void
requestedRowCountproperty 
requestedRowCount:int

Requests that the layout uses a specific number of rows, if possible. If the view port's explicit or maximum height is not large enough to fit the requested number of rows, it will use fewer. Set to 0 to calculate the number of rows automatically based on width and height.

If paging is enabled, this value will be used to calculate the number of rows in a page. If paging isn't enabled, this value will be used to calculate a minimum number of rows, even if there aren't enough items to fill each row.

The default value is 0.


Implementation
    public function get requestedRowCount():int
    public function set requestedRowCount(value:int):void
requiresLayoutOnScrollproperty 
requiresLayoutOnScroll:Boolean  [read-only]

Determines if the container calls layout() when the scroll position changes. Useful for transforming items as the view port scrolls. This value should be true for layouts that implement the IVirtualLayout interface and the useVirtualLayout property is set to true. May also be used by layouts that toggle item visibility as the items scroll into and out of the view port.


Implementation
    public function get requiresLayoutOnScroll():Boolean
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

tileHorizontalAlignproperty 
tileHorizontalAlign:String

If the item's width is less than the tile bounds, the position of the item can be aligned horizontally.

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


Implementation
    public function get tileHorizontalAlign():String
    public function set tileHorizontalAlign(value:String):void

See also

tileVerticalAlignproperty 
tileVerticalAlign:String

If an item's height is less than the tile bounds, the position of the item can be aligned vertically.

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


Implementation
    public function get tileVerticalAlign():String
    public function set tileVerticalAlign(value:String):void

See also

typicalItemproperty 
typicalItem: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. These dimensions will be used to fill in blanks for the layout when an item is virtual and isn't actually on the display list. If you are simply passing a layout to a component, setting this property will have no effect. It is meant to be used by the component, and the component will replace any value you pass to this property.


Implementation
    public function get typicalItem():DisplayObject
    public function set typicalItem(value:DisplayObject):void
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

useSquareTilesproperty 
useSquareTiles:Boolean

Determines if the tiles must be square or if their width and height may have different values.

The default value is true.


Implementation
    public function get useSquareTiles():Boolean
    public function set useSquareTiles(value:Boolean):void
useVirtualLayoutproperty 
useVirtualLayout:Boolean

Determines if virtual layout should be used. Some components don't support virtual layouts, and they will always change this property to false. In those cases, the virtual layout options will be ignored.

The default value is true.


Implementation
    public function get useVirtualLayout():Boolean
    public function set useVirtualLayout(value:Boolean):void
verticalAlignproperty 
verticalAlign:String

If the total column height is less than the bounds, the items in the column can be aligned vertically.

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


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

See also

verticalGapproperty 
verticalGap:Number

The vertical space, in pixels, between tiles.

The default value is 0.


Implementation
    public function get verticalGap():Number
    public function set verticalGap(value:Number):void
Constructor Detail
BaseTiledLayout()Constructor
public function BaseTiledLayout()

Constructor.

Event Detail
change Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

Dispatched when a property of the layout changes, indicating that a redraw is probably needed.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.