Packagespark.layouts
Classpublic class ViewMenuLayout
InheritanceViewMenuLayout Inheritance LayoutBase Inheritance OnDemandEventDispatcher Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The ViewMenuLayout class defines the layout of the ViewMenu container. The menu can have multiple rows depending on the number of menu items.

The requestedMaxColumnCount property defines the maximum number of menu items in a row. By default, the property is set to three.

The ViewMenuLayout class define the layout as follows:

You can create your own custom layout for the menu by creating your own layout class. By default, the spark.skins.mobile.ViewMenuSkin class defines the skin for the ViewMenu container. To apply a customized ViewMenuLayout class to the ViewMenu container, define a new skin class for the ViewMenu container.

The ViewMenuSkin class includes a definition for a Group container named contentGroup, as shown below:

    <s:Group id="contentGroup" left="0" right="0" top="3" bottom="2" 
        minWidth="0" minHeight="0"> 
        <s:layout> 
            <s:ViewMenuLayout horizontalGap="2" verticalGap="2" id="contentGroupLayout" 
                requestedMaxColumnCount="3" requestedMaxColumnCount.landscapeGroup="6"/> 
        </s:layout> 
    </s:Group>

To apply your customized ViewMenuLayout class, your skin class should define a container named contentGroup. That container uses the layout property to specify your customized layout class.

MXML SyntaxexpandedHide MXML Syntax

The <s:ViewMenuLayout> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:ViewMenuLayout 
    Properties
    horizontalGap="2"
    requestedMaxColumnCount="3"
    verticalGap="2"
  />
  

See also

spark.components.ViewMenu
spark.components.ViewMenuItem
spark.skins.mobile.ViewMenuSkin


Public Properties
 PropertyDefined By
 InheritedclipAndEnableScrolling : Boolean
If true, specifies to clip the children to the boundaries of the viewport.
LayoutBase
 InheriteddropIndicator : DisplayObject
The DisplayObject that this layout uses for the drop indicator during a drag-and-drop operation.
LayoutBase
  AIR-only horizontalGap : Number
The horizontal space between columns, in pixels.
ViewMenuLayout
 InheritedhorizontalScrollPosition : 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
  AIR-only requestedMaxColumnCount : int
The maximum number of columns to display in a row.
ViewMenuLayout
 Inheritedtarget : GroupBase
The GroupBase container whose elements are measured, sized and positioned by this layout.
LayoutBase
 InheritedtypicalLayoutElement : ILayoutElement
Used by layouts when fixed row/column sizes are requested but a specific size isn't specified.
LayoutBase
 InheriteduseVirtualLayout : Boolean
A container can hold any number of children.
LayoutBase
  AIR-only verticalGap : Number
The vertical space between rows, in pixels.
ViewMenuLayout
 InheritedverticalScrollPosition : 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
 MethodDefined By
  
Constructor.
ViewMenuLayout
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
OnDemandEventDispatcher
 Inherited
Calculates the drop location in the data provider of the drop target for the specified dragEvent.
LayoutBase
 Inherited
When useVirtualLayout is true, this method can be used by the layout target to clear cached layout information when the target changes.
LayoutBase
 Inherited
dispatchEvent(event:Event):Boolean
OnDemandEventDispatcher
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
getHorizontalScrollPositionDelta(navigationUnit:uint):Number
Returns the change to the horizontal scroll position to handle different scrolling options.
LayoutBase
 Inherited
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
 Inherited
Computes the verticalScrollPosition and horizontalScrollPosition deltas needed to scroll the element at the specified index into view.
LayoutBase
 Inherited
getVerticalScrollPositionDelta(navigationUnit:uint):Number
Returns the change to the vertical scroll position to handle different scrolling options.
LayoutBase
 Inherited
hasEventListener(type:String):Boolean
OnDemandEventDispatcher
 Inherited
Hides the previously shown drop indicator, created by the showDropIndicator() method, removes it from the display list and also stops the drag scrolling.
LayoutBase
 Inherited
measure():void
Measures the target's default size based on its content, and optionally measures the target's default minimum size.
LayoutBase
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
OnDemandEventDispatcher
 Inherited
showDropIndicator(dropLocation:DropLocation):void
Sizes, positions and parents the drop indicator based on the specified drop location.
LayoutBase
 Inherited
updateDisplayList(width:Number, height:Number):void
Sizes and positions the target's elements.
LayoutBase
 Inherited
updateScrollRect(w:Number, h:Number):void
Called by the target at the end of its updateDisplayList to have the layout update its scrollRect.
LayoutBase
 Inherited
willTrigger(type:String):Boolean
OnDemandEventDispatcher
Protected Methods
 MethodDefined By
 Inherited
calculateDragScrollDelta(dropLocation:DropLocation, elapsedTime:Number):Point
Calculates how much to scroll for the specified dropLocation during a drag and drop gesture.
LayoutBase
 Inherited
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
 Inherited
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
 Inherited
getElementBoundsAboveScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or is above the scrollRect's top edge.
LayoutBase
 Inherited
getElementBoundsBelowScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or is below the scrollRect's bottom edge.
LayoutBase
 Inherited
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
 Inherited
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
 Inherited
getScrollRect():Rectangle
Returns the bounds of the target's scroll rectangle in layout coordinates.
LayoutBase
 Inherited
Called when the verticalScrollPosition or horizontalScrollPosition properties change.
LayoutBase
Property Detail
AIR-only horizontalGapproperty
horizontalGap:Number

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The horizontal space between columns, in pixels.

The default value is 2.

This property can be used as the source for data binding.


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

See also

AIR-only requestedMaxColumnCountproperty 
requestedMaxColumnCount:int

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : AIR 1.5

The maximum number of columns to display in a row.

The default value is 3.


Implementation
    public function get requestedMaxColumnCount():int
    public function set requestedMaxColumnCount(value:int):void
AIR-only verticalGapproperty 
verticalGap:Number

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

The vertical space between rows, in pixels.

The default value is 2.

This property can be used as the source for data binding.


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

See also

Constructor Detail
AIR-only ViewMenuLayout()Constructor
public function ViewMenuLayout()

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : AIR 2.5

Constructor.