Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
MobileGridLayout

Package | spark.layouts
Class | public class MobileGridLayout
Inheritance | MobileGridLayout VerticalLayout LayoutBase OnDemandEventDispatcher Object

Language Version : | ActionScript 3.0

Product Version : | Flex 4.11

Runtime Versions : | AIR 3.8

| This class is experimental, which means it has not been tested or documented as thoroughly as other core Apache Flex classes.

Internal class used for laying out rows, columns and headers of a MobileGrid component.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport. | LayoutBase
|  | dropIndicator : DisplayObject The DisplayObject that this layout uses for the drop indicator during a drag-and-drop operation. | LayoutBase
|  | firstIndexInView : int [read-only] The index of the first layout element that is part of the layout and within the layout target's scroll rectangle, or -1 if nothing has been displayed yet. | VerticalLayout
|  | gap : int The vertical space between layout elements, in pixels. | VerticalLayout
|  | horizontalAlign : String The horizontal alignment of layout elements. | VerticalLayout
|  | horizontalScrollPosition : Number The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. | LayoutBase
|  | lastIndexInView : int [read-only] The index of the last row that's part of the layout and within the container's scroll rectangle, or -1 if nothing has been displayed yet. | VerticalLayout
|  | padding : Number The minimum number of pixels between the container's edges and the edges of the layout element. | VerticalLayout
|  | paddingBottom : Number Number of pixels between the container's bottom edge and the bottom edge of the last layout element. | VerticalLayout
|  | paddingLeft : Number The minimum number of pixels between the container's left edge and the left edge of the layout element. | VerticalLayout
|  | paddingRight : Number The minimum number of pixels between the container's right edge and the right edge of the layout element. | VerticalLayout
|  | paddingTop : Number Number of pixels between the container's top edge and the top edge of the first layout element. | VerticalLayout
|  | requestedMaxRowCount : int The measured height of this layout is large enough to display at most requestedMaxRowCount layout elements. | VerticalLayout
|  | requestedMinRowCount : int The measured height of this layout is large enough to display at least requestedMinRowCount layout elements. | VerticalLayout
|  | requestedRowCount : int The measured size of this layout is tall enough to display the first requestedRowCount layout elements. | VerticalLayout
|  | rowCount : int [read-only] The current number of visible elements. | VerticalLayout
|  | rowHeight : Number If variableRowHeight is false, then this property specifies the actual height of each child, in pixels. | VerticalLayout
|  | target : GroupBase The GroupBase container whose elements are measured, sized and positioned by this layout. | LayoutBase
|  | typicalLayoutElement : ILayoutElement Used by layouts when fixed row/column sizes are requested but a specific size isn't specified. | LayoutBase
|  | useVirtualLayout : Boolean A container can hold any number of children. | LayoutBase
|  | variableRowHeight : Boolean Specifies whether layout elements are allocated their preferred height. | VerticalLayout
|  | verticalAlign : String The vertical alignment of the content relative to the container's height. | VerticalLayout
|  | verticalScrollPosition : Number The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. | LayoutBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MobileGridLayout(grid:MobileGrid) | MobileGridLayout
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void | OnDemandEventDispatcher
|  | calculateDropLocation(dragEvent:DragEvent):DropLocation Calculates the drop location in the data provider of the drop target for the specified dragEvent. | LayoutBase
|  | clearVirtualLayoutCache():void When useVirtualLayout is true, this method can be used by the layout target to clear cached layout information when the target changes. | LayoutBase
|  | dispatchEvent(event:Event):Boolean | OnDemandEventDispatcher
|  | elementAdded(index:int):void Called by the target after a layout element has been added and before the target's size and display list are validated. | LayoutBase
|  | elementRemoved(index:int):void This method must is called by the target after a layout element has been removed and before the target's size and display list are validated. | LayoutBase
|  | fractionOfElementInView(index:int):Number Returns 1.0 if the specified index is completely in view, 0.0 if it's not, or a value between 0.0 and 1.0 that represents the percentage of the if the index that is partially in view. | VerticalLayout
|  | getElementBounds(index:int):Rectangle Returns the specified element's layout bounds as a Rectangle or null if the index is invalid, the corresponding element is null, includeInLayout=false, or if this layout's target property is null. | LayoutBase
|  | getHorizontalScrollPositionDelta(navigationUnit:uint):Number Returns the change to the horizontal scroll position to handle different scrolling options. | LayoutBase
|  | getNavigationDestinationIndex(currentIndex:int, navigationUnit:uint, arrowKeysWrapFocus:Boolean):int Delegation method that determines which item to navigate to based on the current item in focus and user input in terms of NavigationUnit. | LayoutBase
|  | getScrollPositionDeltaToElement(index:int):Point Computes the verticalScrollPosition and horizontalScrollPosition deltas needed to scroll the element at the specified index into view. | LayoutBase
|  | getVerticalScrollPositionDelta(navigationUnit:uint):Number Returns the change to the vertical scroll position to handle different scrolling options. | LayoutBase
|  | hasEventListener(type:String):Boolean | OnDemandEventDispatcher
|  | hideDropIndicator():void Hides the previously shown drop indicator, created by the showDropIndicator() method, removes it from the display list and also stops the drag scrolling. | LayoutBase
|  | measure():void Measures the target's default size based on its content, and optionally measures the target's default minimum size. | LayoutBase
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void | OnDemandEventDispatcher
|  | showDropIndicator(dropLocation:DropLocation):void Sizes, positions and parents the drop indicator based on the specified drop location. | LayoutBase
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] | MobileGridLayout
|  | updateScrollRect(w:Number, h:Number):void Called by the target at the end of its updateDisplayList to have the layout update its scrollRect. | LayoutBase
|  | willTrigger(type:String):Boolean | OnDemandEventDispatcher

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | calculateDragScrollDelta(dropLocation:DropLocation, elapsedTime:Number):Point Calculates how much to scroll for the specified dropLocation during a drag and drop gesture. | LayoutBase
|  | calculateDropIndex(x:Number, y:Number):int Returns the index where a new item should be inserted if the user releases the mouse at the specified coordinates while completing a drag and drop gesture. | LayoutBase
|  | calculateDropIndicatorBounds(dropLocation:DropLocation):Rectangle Calculates the bounds for the drop indicator that provides visual feedback to the user of where the items will be inserted at the end of a drag and drop gesture. | LayoutBase
|  | getElementBoundsAboveScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is above the scrollRect's top edge. | LayoutBase
|  | getElementBoundsBelowScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is below the scrollRect's bottom edge. | LayoutBase
|  | getElementBoundsLeftOfScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is to the left of the scrollRect's left edge. | LayoutBase
|  | getElementBoundsRightOfScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is to the right of the scrollRect's right edge. | LayoutBase
|  | getScrollRect():Rectangle Returns the bounds of the target's scroll rectangle in layout coordinates. | LayoutBase
|  | scrollPositionChanged():void Called when the verticalScrollPosition or horizontalScrollPosition properties change. | LayoutBase
|  | updateColumnWidths(unscaledWidth:Number):void compute colum actual widths from colum width and percentWidth simple algorithm is following: first set all columns that have fixed width set distribute the remainder between the percentages, normalized to 100% | MobileGridLayout

Constructor Detail

MobileGridLayout | () | Constructor

`public function MobileGridLayout(grid:MobileGrid)`

Parameters

| `grid:MobileGrid`

Method Detail

updateColumnWidths | () | method

`protected function updateColumnWidths(unscaledWidth:Number):void`

compute colum actual widths from colum width and percentWidth simple algorithm is following: first set all columns that have fixed width set distribute the remainder between the percentages, normalized to 100%

Parameters

| `unscaledWidth:Number`

updateDisplayList | () | method |

`override public function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void`

Parameters

| `unscaledWidth:Number`
| `unscaledHeight:Number`

Wed Nov 15 2017, 09:50 AM +01:00