GODPAPER | All Packages | All Classes | Index | Frames No Frames |
MultiColumnGridLayoutData

Package | feathers.layout
Class | public class MultiColumnGridLayoutData
Inheritance | MultiColumnGridLayoutData EventDispatcher Object
Implements | ILayoutData

Extra, optional data used by an `MultiColumnGridLayout` instance to position and size a display object.

See also

http://wiki.starling-framework.org/feathers/multi-column-grid-layout
MultiColumnGridLayout
ILayoutDisplayObject

Public Properties

| Property | Defined By
--- | --- | ---
|  | cacheOffsetFunctionResult : Boolean If true, the result of offsetFunction will be stored after the function is called for the first time, and this result will always be used. | MultiColumnGridLayoutData
|  | cacheSpanFunctionResult : Boolean If true, the result of spanFunction will be stored after the function is called for the first time, and this result will always be used. | MultiColumnGridLayoutData
|  | forceEndOfRow : Boolean If true the item will be the last in the current row, and a new row will be started. | MultiColumnGridLayoutData
|  | offset : int The number of columns that this item spans. | MultiColumnGridLayoutData
|  | offsetFunction : Function Provides the ability to override the offset value with custom rules instead of using the standard phone and tablet overrides provided by this class. | MultiColumnGridLayoutData
|  | offsetPhone : int Overrides the offset value for devices that are identified as phones. | MultiColumnGridLayoutData
|  | offsetTablet : int Overrides the offset value for devices that are identified as tablets. | MultiColumnGridLayoutData
|  | span : int The number of columns that this item spans. | MultiColumnGridLayoutData
|  | spanFunction : Function Provides the ability to override the span value with custom rules instead of using the standard phone and tablet overrides provided by this class. | MultiColumnGridLayoutData
|  | spanPhone : int Overrides the span value for devices that are identified as phones. | MultiColumnGridLayoutData
|  | spanTablet : int Overrides the span value for devices that are identified as tablets. | MultiColumnGridLayoutData

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MultiColumnGridLayoutData() Constructor. | MultiColumnGridLayoutData
|  | addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type. | EventDispatcher
|  | getOffset():int Returns the offset value for this item, taking into account the various available ways to override this value. | MultiColumnGridLayoutData
|  | getSpan():int Returns the span value for this item, taking into account the various available ways to override this value. | MultiColumnGridLayoutData
|  | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher
|  | removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher
|  | removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher

Public Constants

| Constant | Defined By
--- | --- | ---
|  | OFFSET_USE_DEFAULT : int = -1 [static] Used to ignore phone or tablet offset values. | MultiColumnGridLayoutData
|  | SPAN_USE_DEFAULT : int = -1 [static] Used to ignore phone or tablet span values. | MultiColumnGridLayoutData

Property Detail

cacheOffsetFunctionResult | property

`cacheOffsetFunctionResult:Boolean`

If `true`, the result of `offsetFunction` will be stored after the function is called for the first time, and this result will always be used.

Implementation
`public function get cacheOffsetFunctionResult():Boolean`
`public function set cacheOffsetFunctionResult(value:Boolean):void`

cacheSpanFunctionResult | property |

`cacheSpanFunctionResult:Boolean`

If `true`, the result of `spanFunction` will be stored after the function is called for the first time, and this result will always be used.

Implementation
`public function get cacheSpanFunctionResult():Boolean`
`public function set cacheSpanFunctionResult(value:Boolean):void`

forceEndOfRow | property |

`forceEndOfRow:Boolean`

If `true` the item will be the last in the current row, and a new row will be started.

Implementation
`public function get forceEndOfRow():Boolean`
`public function set forceEndOfRow(value:Boolean):void`

offset | property |

`offset:int`

The number of columns that this item spans. The value may be between `1` and the value of the `columnCount` of the `MultiColumnGridLayout` that is controlling this item. If the value is greater than the column count, the `MultiColumnGridLayout` will automatically reduce it to the column count.

Implementation
`public function get offset():int`
`public function set offset(value:int):void`

offsetFunction | property |

`offsetFunction:Function`

Provides the ability to override the `offset` value with custom rules instead of using the standard phone and tablet overrides provided by this class.

Implementation
`public function get offsetFunction():Function`
`public function set offsetFunction(value:Function):void`

offsetPhone | property |

`offsetPhone:int`

Overrides the `offset` value for devices that are identified as phones. Set to `MultiGridColumnLayoutData.OFFSET_USE_DEFAULT` to switch back to the default offset value.

Implementation
`public function get offsetPhone():int`
`public function set offsetPhone(value:int):void`

See also

offset
offsetTablet
feathers.system.DeviceCapabilities.isPhone()

offsetTablet | property |

`offsetTablet:int`

Overrides the `offset` value for devices that are identified as tablets. Set to `MultiGridColumnLayoutData.OFFSET_USE_DEFAULT` to switch back to the default offset value.

Implementation
`public function get offsetTablet():int`
`public function set offsetTablet(value:int):void`

See also

offset
offsetPhone
feathers.system.DeviceCapabilities.isTablet()

span | property |

`span:int`

The number of columns that this item spans. The value may be between `1` and the value of the `columnCount` of the `MultiColumnGridLayout` that is controlling this item.

Implementation
`public function get span():int`
`public function set span(value:int):void`

spanFunction | property |

`spanFunction:Function`

Provides the ability to override the `span` value with custom rules instead of using the standard phone and tablet overrides provided by this class.

Implementation
`public function get spanFunction():Function`
`public function set spanFunction(value:Function):void`

spanPhone | property |

`spanPhone:int`

Overrides the `span` value for devices that are identified as phones. Set to `MultiGridColumnLayoutData.SPAN_USE_DEFAULT` to switch back to the default span value.

Implementation
`public function get spanPhone():int`
`public function set spanPhone(value:int):void`

See also

span
spanTablet
feathers.system.DeviceCapabilities.isPhone()

spanTablet | property |

`spanTablet:int`

Overrides the `span` value for devices that are identified as tablets. Set to `MultiGridColumnLayoutData.SPAN_USE_DEFAULT` to switch back to the default span value.

Implementation
`public function get spanTablet():int`
`public function set spanTablet(value:int):void`

See also

span
spanPhone
feathers.system.DeviceCapabilities.isTablet()
Constructor Detail

MultiColumnGridLayoutData | () | Constructor

`public function MultiColumnGridLayoutData()`

Constructor.

Method Detail

getOffset | () | method

`public function getOffset():int`

Returns the offset value for this item, taking into account the various available ways to override this value.

Returns

| `int`

getSpan | () | method |

`public function getSpan():int`

Returns the span value for this item, taking into account the various available ways to override this value.

Returns

| `int`

Constant Detail

OFFSET_USE_DEFAULT | Constant

`public static const OFFSET_USE_DEFAULT:int = -1`

Used to ignore phone or tablet offset values.

SPAN_USE_DEFAULT | Constant |

`public static const SPAN_USE_DEFAULT:int = -1`

Used to ignore phone or tablet span values.

Thu Jan 16 2014, 01:11 PM +08:00