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

IViewport 接口是由支持视区的组件实现的。如果组件的子代比组件大，且您希望将子代剪切至组件边界，则可以定义视区和滚动条。视区是您希望显示的组件的区域的矩形子集，而不是显示整个组件。

在其自身上的视区是不能由应用程序用户移动的。但是，可以将视区与滚动条组合到一起，这样用户可以滚动视区以查看组件的整个内容。使用 Scroller 组件将滚动条添加到组件。

查看示例

相关 API 元素

spark.components.Scroller

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		alpha : Number 表示指定对象的 Alpha 透明度值。	IVisualElement
		baseline : Object 从锚点目标到控件的基线位置的垂直距离（以像素为单位）。	ILayoutElement
		baselinePosition : Number [只读] 组件第一行文本的基线的 y 坐标。	ILayoutElement
		bottom : Object 从组件的下边缘到锚点目标的下边缘的垂直距离（以像素为单位）。	ILayoutElement
		clipAndEnableScrolling : Boolean 如果为 true，指定将子代剪切到视区的边界。	IViewport
		contentHeight : Number [只读] 视域的内容的高度。	IViewport
		contentWidth : Number [只读] 视域的内容的宽度。	IViewport
		depth : Number 确定容器内各项目的呈示顺序。	IVisualElement
		designLayer : DesignLayer 指定与该可视元素关联的可选 DesignLayer 实例。	IVisualElement
		hasLayoutMatrix3D : Boolean [只读] 如果元素具有 3D 矩阵，则为 true。	ILayoutElement
		height : Number 表示显示对象的高度，以像素为单位。	IVisualElement
		horizontalCenter : Object 从组件中心到锚点目标的内容区域中心的水平距离（以像素为单位）。	ILayoutElement
		horizontalScrollPosition : Number 组件的坐标系中视域原点（默认值为 (0,0)，与组件的左上角相对应）的 x 坐标。	IViewport
		includeInLayout : Boolean 指定此组件是否包含在父容器的布局中。	ILayoutElement
		is3D : Boolean [只读] 当元素为 3D 时，则为 true。	IVisualElement
		layoutDirection : String 指定元素的所需布局方向：LayoutDirection.LTR（从左到右）、LayoutDirection.RTL（从右到左）或 null（继承）。	ILayoutDirectionElement
		left : Object 从组件的左边缘到锚点目标的左边缘的水平距离（以像素为单位）。	ILayoutElement
		owner : DisplayObjectContainer 此 IVisualElement 对象的所有者。	IVisualElement
		parent : DisplayObjectContainer [只读] 此组件的父容器或组件。	IVisualElement
		percentHeight : Number 以组件父代大小百分比的方式指定组件高度。	ILayoutElement
		percentWidth : Number 以组件父代大小百分比的方式指定组件宽度。	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets 定义能够应用于对象转换且在一定程度上对其父布局不可视的一组调整。	IVisualElement
		right : Object 从组件的右边缘到锚点目标的右边缘的水平距离（以像素为单位）。	ILayoutElement
		top : Object 从组件的上边缘到锚点目标的上边缘的垂直距离（以像素为单位）。	ILayoutElement
		verticalCenter : Object 从组件中心到锚点目标的内容区域中心的垂直距离（以像素为单位）。	ILayoutElement
		verticalScrollPosition : Number 组件的坐标系中视区的原点（默认值为 (0,0)，与组件的左上角相对应）的 y 坐标。	IViewport
		visible : Boolean 控制此可视元素的可见性。	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 按指定的元素大小，返回元素边界的 x 坐标。	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number 按指定的元素大小，返回元素边界的 y 坐标。	ILayoutElement
		getHorizontalScrollPositionDelta(navigationUnit:uint):Number 返回要添加到视域的当前 horizontalScrollPosition 的数量，以按请求的滚动单位进行滚动。	IViewport
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的布局高度。	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的布局宽度。	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number 返回元素在屏幕上进行绘制时所用的 x 坐标。	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number 返回元素在屏幕上进行绘制时所用的 y 坐标。	ILayoutElement
		getLayoutMatrix():Matrix 返回用于相对于其同级组件计算组件的布局的转换矩阵。	ILayoutElement
		getLayoutMatrix3D():Matrix3D 返回此元素的布局转换 Matrix3D。	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的最大高度。	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的最大宽度。	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的最小高度。	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的最小宽度。	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的首选高度。	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的首选宽度。	ILayoutElement
		getVerticalScrollPositionDelta(navigationUnit:uint):Number 返回要添加到视域的当前 verticalScrollPosition 的数量，以按请求的滚动单位进行滚动。	IViewport
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	IEventDispatcher
		invalidateLayoutDirection():void 当某元素的 layoutDirection 更改或其父代的 layoutDirection 更改时，该元素必须调用该方法。	ILayoutDirectionElement
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void 设置元素在屏幕上进行绘制时所用的坐标。	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void 设置元素的布局大小。	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void 设置用于相对于其同级组件计算组件的布局大小和位置的转换 Matrix。	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void 设置用于计算组件相对于其同级组件的布局大小和位置的转换 Matrix3D。	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 用于更新转换的旋转、缩放和平移的一种实用程序方法，同时保留某个特定点，该点是在组件自己的坐标空间中指定的，且在父项的坐标空间中是固定的。	ILayoutElement
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	IEventDispatcher

属性详细信息

clipAndEnableScrolling

属性

clipAndEnableScrolling:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

如果为 true，指定将子代剪切到视区的边界。如果为 false，则容器子代会从容器边界扩展过去，而不管组件的大小规范。

默认值为 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

视域的内容的高度。如果 clipAndEnabledScrolling 为 true，则视域的 contentHeight 为垂直滚动定义限制，且视域的实际高度定义可见的内容量。要在内容中垂直滚动，请在 0 和 contentHeight - height 之间更改 verticalScrollPosition。

此属性的实现必须为 Bindable，且必须生成类型为 propertyChange 的事件。

实现
public function get contentHeight():Number

contentWidth

属性

contentWidth:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

视域的内容的宽度。如果 clipAndEnabledScrolling 为 true，则视域的 contentWidth 为水平滚动定义限制，且视域的实际宽度定义可见的内容量。要在内容中水平滚动，请在 0 和 contentWidth - width 之间更改 horizontalScrollPosition。

此属性的实现必须为 Bindable，且必须生成类型为 propertyChange 的事件。

实现
public function get contentWidth():Number

horizontalScrollPosition

属性

horizontalScrollPosition:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

组件的坐标系中视域原点（默认值为 (0,0)，与组件的左上角相对应）的 x 坐标。如果 clipAndEnableScrolling 为 true，则设置此属性通常会导致将视区设置为：

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

此属性的实现必须为 Bindable，且必须生成类型为 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

组件的坐标系中视区的原点（默认值为 (0,0)，与组件的左上角相对应）的 y 坐标。如果 clipAndEnableScrolling 为 true，则设置此属性通常会导致将视区设置为：

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

此属性的实现必须为 Bindable，且必须生成类型为 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

返回要添加到视域的当前 horizontalScrollPosition 的数量，以按请求的滚动单位进行滚动。

参数

navigationUnit:uint — 要滚动的数量。该值必须是以下 spark.core.NavigationUnit 常量之一：

LEFT
RIGHT
PAGE_LEFT
PAGE_RIGHT
HOME
END

要按单列滚动，请使用 LEFT 或 RIGHT。要滚动到第一列或最后一列，请使用 HOME 或 END。

Number — 要添加到 horizontalScrollPosition 的像素数目。

相关 API 元素

spark.core.NavigationUnit

getVerticalScrollPositionDelta

()

方法

public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

返回要添加到视域的当前 verticalScrollPosition 的数量，以按请求的滚动单位进行滚动。

参数

navigationUnit:uint — 要滚动的数量。该单元值必须是以下 spark.core.NavigationUnit 常量之一：

UP
DOWN
PAGE_UP
PAGE_DOWN
HOME
END

要按单行滚动，请使用 UP 或 DOWN。要滚动到第一行或最后一行，请使用 HOME 或 END。

Number — 要添加到 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

clipAndEnableScrolling

contentHeight

contentWidth

horizontalScrollPosition

verticalScrollPosition

getHorizontalScrollPositionDelta

getVerticalScrollPositionDelta