MultiColumnGridLayoutData

public class
feathers.layout.MultiColumnGridLayoutData

Description

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
feathers.layout.MultiColumnGridLayout
feathers.layout.ILayoutDisplayObject

API overview

Constructor

MultiColumnGridLayoutData ()
Constructor.

Attributes

Public attributes

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

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

forceEndOfRow: Boolean

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

offset: Number

The number of columns that this item spans

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

offsetPhone: Number

Overrides the offset value for devices that are identified as phones

offsetTablet: Number

Overrides the offset value for devices that are identified as tablets

span: Number

The number of columns that this item spans

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

spanPhone: Number

Overrides the span value for devices that are identified as phones

spanTablet: Number

Overrides the span value for devices that are identified as tablets

Constants

Constants

OFFSET_USE_DEFAULT: Number static

Used to ignore phone or tablet offset values

SPAN_USE_DEFAULT: Number static

Used to ignore phone or tablet span values

Functions

Public functions

getOffset (): Number

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

getSpan (): Number

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

Constructor

MultiColumnGridLayoutData ()

Constructor.

Attributes

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.

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.

forceEndOfRow: Boolean

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

offset: Number

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.

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.

offsetPhone: Number

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.

See also:
#offset
#offsetTablet
feathers.system.DeviceCapabilities.isPhone().html)

offsetTablet: Number

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.

See also:
#offset
#offsetPhone
feathers.system.DeviceCapabilities.isTablet().html)

span: Number

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.

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.

spanPhone: Number

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.

See also:
#span
#spanTablet
feathers.system.DeviceCapabilities.isPhone().html)

spanTablet: Number

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.

See also:
#span
#spanPhone
feathers.system.DeviceCapabilities.isTablet().html)

Constants

OFFSET_USE_DEFAULT: Number

static

Used to ignore phone or tablet offset values.

SPAN_USE_DEFAULT: Number

static

Used to ignore phone or tablet span values.

Functions

addEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Registers an event listener at a certain object.

Parameters

type: String
listener: Function


dispatchEvent ( event: Event ): Void
Inherited from EventDispatcher

Dispatches an event to all objects that have registered listeners for its type. If an event with enabled 'bubble' property is dispatched to a display object, it will travel up along the line of parents, until it either hits the root object or someone stops its propagation manually.

Parameters

event: Event


dispatchEventWith ( type: String , bubbles: Boolean = false , data: Object = null ): Void
Inherited from EventDispatcher

Dispatches an event with the given parameters to all objects that have registered listeners for the given type. The method uses an internal pool of event objects to avoid allocations.

Parameters

type: String
bubbles: Boolean = false
data: Object = null


getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getOffset (): Number

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



getSpan (): Number

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



getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

hasEventListener ( type: String ): Boolean
Inherited from EventDispatcher

Returns if there are listeners registered for a certain event type.

Parameters

type: String


removeEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Removes an event listener from the object.

Parameters

type: String
listener: Function


removeEventListeners ( type: String = null ): Void
Inherited from EventDispatcher

Removes all event listeners with a certain type, or all of them if type is null. Be careful when removing all event listeners: you never know who else was listening.

Parameters

type: String = null


toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.

: