HorizontalLayout

套件	spark.layouts
類別	public class HorizontalLayout
繼承	HorizontalLayout LayoutBase OnDemandEventDispatcher Object

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The HorizontalLayout class arranges the layout elements in a horizontal sequence, left to right, with optional gaps between the elements and optional padding around the elements.

The horizontal position of the elements is determined by arranging them in a horizontal sequence, left to right, taking into account the padding before the first element and the gaps between the elements.

The vertical position of the elements is determined by the layout's verticalAlign property.

During the execution of the measure() method, the default size of the container is calculated by accumulating the preferred sizes of the elements, including gaps and padding. When the requestedColumnCount property is set to a value other than -1, only the space for that many elements is measured, starting from the first element.

During the execution of the updateDisplayList() method, the width of each element is calculated according to the following rules, listed in their respective order of precedence (element's minimum width and maximum width are always respected):

If variableColumnWidth is false, then set the element's width to the value of the columnWidth property.
If the element's percentWidth is set, then calculate the element's width by distributing the available container width between all elements with percentWidth setting. The available container width is equal to the container width minus the gaps, the padding and the space occupied by the rest of the elements. The element's precentWidth property is ignored when the layout is virtualized.
Set the element's width to its preferred width.

The height of each element is calculated according to the following rules, listed in their respective order of precedence (element's minimum height and maximum height are always respected):

If the verticalAlign property is "justify", then set the element's height to the container height.
If the verticalAlign property is "contentJustify", then set the element's height to the maximum between the container's height and all elements' preferred height.
If the element's percentHeight property is set, then calculate the element's height as a percentage of the container's height.
Set the element's height to its preferred height.

MXML 語法

隱藏 MXML 語法

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

  <s:HorizontalLayout 
    Properties
    columnWidth="calculated"
    gap="6"
    paddingBottom="0"
    paddingLeft="0"
    paddingRight="0"
    paddingTop="0"
    requestedColumnCount="-1"
    requestedMaxColumnCount="-1"
    requestedMinColumnCount="-1"
    variableColumnWidth="true"
    verticalAlign="top"
  />

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport.	LayoutBase
		columnCount : int [唯讀] Returns the current number of elements in view.	HorizontalLayout
		columnWidth : Number If the variableColumnWidth property is false, then this property specifies the actual width of each layout element, in pixels.	HorizontalLayout
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		dropIndicator : DisplayObject The DisplayObject that this layout uses for the drop indicator during a drag-and-drop operation.	LayoutBase
		firstIndexInView : int [唯讀] The index of the first column that is part of the layout and within the layout target's scroll rectangle, or -1 if nothing has been displayed yet.	HorizontalLayout
		gap : int The horizontal space between layout elements, in pixels.	HorizontalLayout
		horizontalAlign : String The horizontal alignment of the content relative to the container's width.	HorizontalLayout
		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 [唯讀] The index of the last column that is part of the layout and within the layout target's scroll rectangle, or -1 if nothing has been displayed yet.	HorizontalLayout
		paddingBottom : Number The minimum number of pixels between the container's bottom edge and the bottom of all the container's layout elements.	HorizontalLayout
		paddingLeft : Number Number of pixels between the container's left edge and the left edge of the first layout element.	HorizontalLayout
		paddingRight : Number Number of pixels between the container's right edge and the right edge of the last layout element.	HorizontalLayout
		paddingTop : Number The minimum number of pixels between the container's top edge and the top of all the container's layout elements.	HorizontalLayout
		requestedColumnCount : int The measured size of this layout is wide enough to display the first requestedColumnCount layout elements.	HorizontalLayout
		requestedMaxColumnCount : int The measured width of this layout is large enough to display at most requestedMaxColumnCount layout elements.	HorizontalLayout
		requestedMinColumnCount : int The measured width of this layout is large enough to display at least requestedMinColumnCount layout elements.	HorizontalLayout
		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
		variableColumnWidth : Boolean If true, specifies that layout elements are to be allocated their preferred width.	HorizontalLayout
		verticalAlign : String The vertical alignment of layout elements.	HorizontalLayout
		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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		HorizontalLayout() Constructor.	HorizontalLayout
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	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 Dispatches an event into the event flow.	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.	HorizontalLayout
		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 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	OnDemandEventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		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
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		measure():void Measures the target's default size based on its content, and optionally measures the target's default minimum size.	LayoutBase
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	OnDemandEventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		showDropIndicator(dropLocation:DropLocation):void Sizes, positions and parents the drop indicator based on the specified drop location.	LayoutBase
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		updateDisplayList(width:Number, height:Number):void Sizes and positions the target's elements.	LayoutBase
		updateScrollRect(w:Number, h:Number):void Called by the target at the end of its updateDisplayList to have the layout update its scrollRect.	LayoutBase
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	OnDemandEventDispatcher

保護方法

隱藏繼承保護方法

顯示繼承保護方法

	方法		定義自
		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

屬性詳細資訊

columnCount

屬性

columnCount:int [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

Returns the current number of elements in view.

預設值為 -1。

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 propertyChange 事件。

實作
public function get columnCount():int

columnWidth

屬性

columnWidth:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

If the variableColumnWidth property is false, then this property specifies the actual width of each layout element, in pixels.

If the variableColumnWidth property is true, the default, then this property has no effect.

The default value of this property is the preferred width of the item specified by the typicalLayoutElement property.

實作
public function get columnWidth():Number
public function set columnWidth(value:Number):void

firstIndexInView

屬性

firstIndexInView:int [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The index of the first column that is part of the layout and within the layout target's scroll rectangle, or -1 if nothing has been displayed yet. Note that the column may only be partially in view.

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 indexInViewChanged 事件。

實作
public function get firstIndexInView():int

相關 API 元素

lastIndexInView
fractionOfElementInView

gap

屬性

gap:int

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The horizontal space between layout elements, in pixels. Note that the gap is only applied between layout elements, so if there's just one element, the gap has no effect on the layout.

預設值為 6。

實作
public function get gap():int
public function set gap(value:int):void

horizontalAlign

屬性

horizontalAlign:String

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The horizontal alignment of the content relative to the container's width. If the value is "left", "right", or "center" then the layout element is aligned relative to the container's contentWidth property.

This property has no effect when clipAndEnableScrolling is true and the contentWidth is greater than the container's width.

This property does not affect the layout's measured size.

預設值為 "left"。

實作
public function get horizontalAlign():String
public function set horizontalAlign(value:String):void

lastIndexInView

屬性

lastIndexInView:int [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The index of the last column that is part of the layout and within the layout target's scroll rectangle, or -1 if nothing has been displayed yet. Note that the column may only be partially in view.

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 indexInViewChanged 事件。

實作
public function get lastIndexInView():int

相關 API 元素

firstIndexInView
fractionOfElementInView

paddingBottom

屬性

paddingBottom:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The minimum number of pixels between the container's bottom edge and the bottom of all the container's layout elements.

預設值為 0。

實作
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void

paddingLeft

屬性

paddingLeft:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

Number of pixels between the container's left edge and the left edge of the first layout element.

預設值為 0。

實作
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void

paddingRight

屬性

paddingRight:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

Number of pixels between the container's right edge and the right edge of the last layout element.

預設值為 0。

實作
public function get paddingRight():Number
public function set paddingRight(value:Number):void

paddingTop

屬性

paddingTop:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The minimum number of pixels between the container's top edge and the top of all the container's layout elements.

預設值為 0。

實作
public function get paddingTop():Number
public function set paddingTop(value:Number):void

requestedColumnCount

屬性

requestedColumnCount:int

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The measured size of this layout is wide enough to display the first requestedColumnCount layout elements. If requestedColumnCount is -1, then the measured size will be big enough for all of the layout elements.

If the actual size of the container using this layout has been explicitly set, then this property has no effect.

預設值為 -1。

實作
public function get requestedColumnCount():int
public function set requestedColumnCount(value:int):void

requestedMaxColumnCount

屬性

requestedMaxColumnCount:int

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10, AIR 2.5

The measured width of this layout is large enough to display at most requestedMaxColumnCount layout elements.

If requestedColumnCount is set, then this property has no effect.

If the actual size of the container using this layout has been explicitly set, then this property has no effect.

預設值為 -1。

實作
public function get requestedMaxColumnCount():int
public function set requestedMaxColumnCount(value:int):void

requestedMinColumnCount

屬性

requestedMinColumnCount:int

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10, AIR 2.5

The measured width of this layout is large enough to display at least requestedMinColumnCount layout elements.

If requestedColumnCount is set, then this property has no effect.

If the actual size of the container using this layout has been explicitly set, then this property has no effect.

預設值為 -1。

實作
public function get requestedMinColumnCount():int
public function set requestedMinColumnCount(value:int):void

variableColumnWidth

屬性

variableColumnWidth:Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

If true, specifies that layout elements are to be allocated their preferred width.

Setting this property to false specifies fixed width columns. The actual width of each layout element is the value of the columnWidth property, and the layout ignores a layout elements' percentWidth property.

預設值為 true。

實作
public function get variableColumnWidth():Boolean
public function set variableColumnWidth(value:Boolean):void

verticalAlign

屬性

verticalAlign:String

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The vertical alignment of layout elements.

If the value is "bottom", "middle", or "top" then the layout elements are aligned relative to the container's contentHeight property.

If the value is "contentJustify" then the actual height of the layout element is set to the container's contentHeight property. The content height of the container is the height of the largest layout element. If all layout elements are smaller than the height of the container, then set the height of all the layout elements to the height of the container.

If the value is "justify" then the actual height of the layout elements is set to the container's height.

If the value is "baseline" then the elements are positioned such that their text is aligned to the maximum of the elements' text ascent.

預設值為 "top"。

實作
public function get verticalAlign():String
public function set verticalAlign(value:String):void

建構函式詳細資料

()

建構函式

public function HorizontalLayout()

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

Constructor.

方法詳細資訊

fractionOfElementInView

()

方法

public function fractionOfElementInView(index:int):Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

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.

An index is "in view" if the corresponding non-null layout element is within the horizontal limits of the container's scrollRect and included in the layout.

If the specified index is partially within the view, the returned value is the percentage of the corresponding layout element that's visible.

參數

index:int — The index of the column.

傳回值

Number — The percentage of the specified element that's in view. Returns 0.0 if the specified index is invalid or if it corresponds to null element, or a ILayoutElement for which the includeInLayout property is false.

法律聲明 | 線上隱私權政策

HorizontalLayout - AS3 Flex

套件x

語言元素

附錄

套件 spark.layouts

columnCount

columnWidth

firstIndexInView

gap

horizontalAlign

lastIndexInView

paddingBottom

paddingLeft

paddingRight

paddingTop

requestedColumnCount

requestedMaxColumnCount

requestedMinColumnCount

variableColumnWidth

verticalAlign

HorizontalLayout

fractionOfElementInView