IViewport - Adobe ActionScript® 3 (AS3 Flex) API 參考

套件	spark.core
介面	public interface IViewport extends IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
實作者	GroupBase, RichEditableText

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The IViewport interface is implemented by components that support a viewport. If a component's children are larger than the component, and you want to clip the children to the component boundaries, you can define a viewport and scroll bars. A viewport is a rectangular subset of the area of a component that you want to display, rather than displaying the entire component.

A viewport on its own is not movable by the application user. However, you can combine a viewport with scroll bars so the user can scroll the viewport to see the entire content of the component. Use the Scroller component to add scrolbars to the component.

檢視範例

相關 API 元素

spark.components.Scroller

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		alpha : Number 指出所指定物件的 Alpha 透明度值。	IVisualElement
		baseline : Object The vertical distance in pixels from the anchor target to the control's baseline position.	ILayoutElement
		baselinePosition : Number [唯讀] The y-coordinate of the baseline of the first line of text of the component.	ILayoutElement
		bottom : Object The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.	ILayoutElement
		clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport.	IViewport
		contentHeight : Number [唯讀] The height of the viewport's content.	IViewport
		contentWidth : Number [唯讀] The width of the viewport's contents.	IViewport
		depth : Number Determines the order in which items inside of containers are rendered.	IVisualElement
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	IVisualElement
		hasLayoutMatrix3D : Boolean [唯讀] Contains true if the element has 3D Matrix.	ILayoutElement
		height : Number 會指出顯示物件的高度，以像素為單位。	IVisualElement
		horizontalCenter : Object The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		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.	IViewport
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	ILayoutElement
		is3D : Boolean [唯讀] Contains true when the element is in 3D.	IVisualElement
		layoutDirection : String Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit).	ILayoutDirectionElement
		left : Object The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.	ILayoutElement
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IVisualElement
		parent : DisplayObjectContainer [唯讀] The parent container or component for this component.	IVisualElement
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	ILayoutElement
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	IVisualElement
		right : Object The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.	ILayoutElement
		top : Object The vertical distance in pixels from the top edge of the component to the anchor target's top edge.	ILayoutElement
		verticalCenter : Object The vertical distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		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.	IViewport
		visible : Boolean Controls the visibility of this visual element.	IVisualElement
		width : Number 會指出顯示物件的寬度，以像素為單位。	IVisualElement
		x : Number 指出 DisplayObject 實體相對於父輩 DisplayObjectContainer 之區域座標的 x 座標。	IVisualElement
		y : Number 指出 DisplayObject 實體相對於父輩 DisplayObjectContainer 之區域座標的 y 座標。	IVisualElement

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	IEventDispatcher
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	IEventDispatcher
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	ILayoutElement
		getHorizontalScrollPositionDelta(navigationUnit:uint):Number Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.	IViewport
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	ILayoutElement
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	ILayoutElement
		getVerticalScrollPositionDelta(navigationUnit:uint):Number Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.	IViewport
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	IEventDispatcher
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	ILayoutDirectionElement
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	IEventDispatcher
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	ILayoutElement
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	ILayoutElement
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	IEventDispatcher

屬性詳細資訊

clipAndEnableScrolling

屬性

clipAndEnableScrolling:Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

If true, specifies to clip the children to the boundaries of the viewport. If false, the container children extend past the container boundaries, regardless of the size specification of the component.

預設值為 false。

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

contentHeight

屬性

contentHeight:Number [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The height of the viewport's content. If clipAndEnabledScrolling is true, the viewport's contentHeight defines the limit for vertical scrolling and the viewport's actual height defines how much of the content is visible. To scroll through the content vertically, vary the verticalScrollPosition between 0 and contentHeight - height.

Implementations of this property must be Bindable and must generate events of type propertyChange.

實作
public function get contentHeight():Number

contentWidth

屬性

contentWidth:Number [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The width of the viewport's contents. If clipAndEnabledScrolling is true, the viewport's contentWidth defines the limit for horizontal scrolling and the viewport's actual width defines how much of the content is visible. To scroll through the content horizontally, vary the horizontalScrollPosition between 0 and contentWidth - width.

Implementations of this property must be Bindable and must generate events of type propertyChange.

實作
public function get contentWidth():Number

horizontalScrollPosition

屬性

horizontalScrollPosition:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

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. If clipAndEnableScrolling is true, setting this property typically causes the viewport to be set to:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementations of this property must be Bindable and must generate events of type propertyChange.

預設值為 0。

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

相關 API 元素

target
verticalScrollPosition

verticalScrollPosition

屬性

verticalScrollPosition:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

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. If clipAndEnableScrolling is true, setting this property typically causes the viewport to be set to:

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementations of this property must be Bindable and must generate events of type propertyChange.

預設值為 0。

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

相關 API 元素

horizontalScrollPosition

方法詳細資訊

getHorizontalScrollPositionDelta

()

方法

public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.

參數

navigationUnit:uint — The amount to scroll. The value must be one of the following spark.core.NavigationUnit constants:

LEFT
RIGHT
PAGE_LEFT
PAGE_RIGHT
HOME
END

To scroll by a single column, use LEFT or RIGHT. To scroll to the first or last column, use HOME or END.

傳回值

Number — The number of pixels to add to horizontalScrollPosition.

相關 API 元素

spark.core.NavigationUnit

getVerticalScrollPositionDelta

()

方法

public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.

參數

navigationUnit:uint — The amount to scroll. The value of unit must be one of the following spark.core.NavigationUnit constants:

UP
DOWN
PAGE_UP
PAGE_DOWN
HOME
END

To scroll by a single row use UP or DOWN. To scroll to the first or last row, use HOME or END.

傳回值

Number — The number of pixels to add to verticalScrollPosition.

相關 API 元素

spark.core.NavigationUnit

範例如何使用本範例

IViewportExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate Spark IViewport interface -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:mx="library://ns.adobe.com/flex/mx" 
    xmlns:s="library://ns.adobe.com/flex/spark" >
    <s:layout>
        <s:HorizontalLayout/>
    </s:layout>
    
    <s:Panel title="IViewport Component Example"
        width="75%" height="75%" 
        horizontalCenter="0" verticalCenter="0"> 

        <s:Label text="The Group container implements IViewport. Therefore, you can clip its contents and use it with scrollbars."
            color="blue"
            top="10"/>
        <s:Group id="myGroup" width="100" height="100"
            clipAndEnableScrolling="true"
            horizontalScrollPosition="50" verticalScrollPosition="50" 
            left="100" top="40"> 
            <mx:Image width="300" height="400" 
                source="@Embed(source='/assets/logo.jpg')"/>
        </s:Group>
        <s:VScrollBar viewport="{myGroup}" height="100" left="210" top="40"/>
        <s:HScrollBar viewport="{myGroup}" width="100" left="100" top="150"/>

    </s:Panel>
</s:Application>

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

IViewport - AS3 Flex

套件x

語言元素

附錄

套件 spark.core

clipAndEnableScrolling

contentHeight

contentWidth

horizontalScrollPosition

verticalScrollPosition

getHorizontalScrollPositionDelta

getVerticalScrollPositionDelta