用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: AIR 30.0 和更早版本, Flash Player 30.0 和更早版本, Flash Lite 4
Flex 4.6 和更早版本, Flash Pro CS6 和更早版本
隐藏过滤条件
mx.core 

IVisualElement  - AS3 Flex

mx.core
接口public interface IVisualElement extends ILayoutElement , ILayoutDirectionElement , IEventDispatcher
实现器 GraphicElement, SpriteVisualElement, StyleableTextField, UIComponent, UIMovieClip

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

IVisualElement 接口定义针对可视元素在 Spark 容器中排列和显示时需要的最低限度属性和方法。



公共属性
 属性由以下参数定义
  alpha : Number
表示指定对象的 Alpha 透明度值。
IVisualElement
 Inheritedbaseline : Object
从锚点目标到控件的基线位置的垂直距离(以像素为单位)。
ILayoutElement
 InheritedbaselinePosition : Number
[只读] 组件第一行文本的基线的 y 坐标。
ILayoutElement
 Inheritedbottom : Object
从组件的下边缘到锚点目标的下边缘的垂直距离(以像素为单位)。
ILayoutElement
  depth : Number
确定容器内各项目的呈示顺序。
IVisualElement
  designLayer : DesignLayer
指定与该可视元素关联的可选 DesignLayer 实例。
IVisualElement
 InheritedhasLayoutMatrix3D : Boolean
[只读] 如果元素具有 3D 矩阵,则为 true。
ILayoutElement
  height : Number
表示显示对象的高度,以像素为单位。
IVisualElement
 InheritedhorizontalCenter : Object
从组件中心到锚点目标的内容区域中心的水平距离(以像素为单位)。
ILayoutElement
 InheritedincludeInLayout : Boolean
指定此组件是否包含在父容器的布局中。
ILayoutElement
  is3D : Boolean
[只读] 当元素为 3D 时,则为 true。
IVisualElement
 InheritedlayoutDirection : String
指定元素的所需布局方向:LayoutDirection.LTR(从左到右)、LayoutDirection.RTL(从右到左)或 null(继承)。
ILayoutDirectionElement
 Inheritedleft : Object
从组件的左边缘到锚点目标的左边缘的水平距离(以像素为单位)。
ILayoutElement
  owner : DisplayObjectContainer
此 IVisualElement 对象的所有者。
IVisualElement
  parent : DisplayObjectContainer
[只读] 此组件的父容器或组件。
IVisualElement
 InheritedpercentHeight : Number
以组件父代大小百分比的方式指定组件高度。
ILayoutElement
 InheritedpercentWidth : Number
以组件父代大小百分比的方式指定组件宽度。
ILayoutElement
  postLayoutTransformOffsets : mx.geom:TransformOffsets
定义能够应用于对象转换且在一定程度上对其父布局不可视的一组调整。
IVisualElement
 Inheritedright : Object
从组件的右边缘到锚点目标的右边缘的水平距离(以像素为单位)。
ILayoutElement
 Inheritedtop : Object
从组件的上边缘到锚点目标的上边缘的垂直距离(以像素为单位)。
ILayoutElement
 InheritedverticalCenter : Object
从组件中心到锚点目标的内容区域中心的垂直距离(以像素为单位)。
ILayoutElement
  visible : Boolean
控制此可视元素的可见性。
IVisualElement
  width : Number
表示显示对象的宽度,以像素为单位。
IVisualElement
  x : Number
表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。
IVisualElement
  y : Number
表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。
IVisualElement
公共方法
 方法由以下参数定义
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
IEventDispatcher
 Inherited
将事件调度到事件流中。
IEventDispatcher
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
按指定的元素大小,返回元素边界的 x 坐标。
ILayoutElement
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
按指定的元素大小,返回元素边界的 y 坐标。
ILayoutElement
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
返回元素的布局高度。
ILayoutElement
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
返回元素的布局宽度。
ILayoutElement
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
返回元素在屏幕上进行绘制时所用的 x 坐标。
ILayoutElement
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
返回元素在屏幕上进行绘制时所用的 y 坐标。
ILayoutElement
 Inherited
返回用于相对于其同级组件计算组件的布局的转换矩阵。
ILayoutElement
 Inherited
返回此元素的布局转换 Matrix3D。
ILayoutElement
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
返回元素的最大高度。
ILayoutElement
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
返回元素的最大宽度。
ILayoutElement
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
返回元素的最小高度。
ILayoutElement
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
返回元素的最小宽度。
ILayoutElement
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
返回元素的首选高度。
ILayoutElement
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
返回元素的首选宽度。
ILayoutElement
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
IEventDispatcher
 Inherited
当某元素的 layoutDirection 更改或其父代的 layoutDirection 更改时,该元素必须调用该方法。
ILayoutDirectionElement
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
IEventDispatcher
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
设置元素在屏幕上进行绘制时所用的坐标。
ILayoutElement
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
设置元素的布局大小。
ILayoutElement
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
设置用于相对于其同级组件计算组件的布局大小和位置的转换 Matrix。
ILayoutElement
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
设置用于计算组件相对于其同级组件的布局大小和位置的转换 Matrix3D。
ILayoutElement
 Inherited
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
 Inherited
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。
IEventDispatcher
属性详细信息

alpha

属性
alpha:Number

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

表示指定对象的 Alpha 透明度值。有效值为 0(完全透明)到 1(完全不透明)。默认值为 1。alpha 设置为 0 的显示对象活动的,即使它们不可见。



实现
    public function get alpha():Number
    public function set alpha(value:Number):void

depth

属性 
depth:Number

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

确定容器内各项目的呈示顺序。Spark 容器根据项目的 depth 属性确定这些项目的顺序,具有最低深度的项目在后面,具有较高深度的项目在前面。具有相同深度值的项目按照添加到容器中的顺序显示。

默认值为 0。



实现
    public function get depth():Number
    public function set depth(value:Number):void

designLayer

属性 
designLayer:DesignLayer

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

指定与该可视元素关联的可选 DesignLayer 实例。

当分配一个 DesignLayer 时,可视元素在最终将自身的有效可视性或透明度提交给它的支持 DisplayObject(如果适用)时,必须考虑其父层的可视性和透明度。

可视元素必须侦听来自关联层的父项发出的 layerPropertyChange 通知。当层的 effectiveAlphaeffectiveVisibility 发生改变时,元素必须计算其有效可视性(或透明度)且相应地应用。

该属性不应在 MXML 内直接设置。

designLayer 属性不用于 z 轴顺序控件,请参见 depth

默认值为 null。



实现
    public function get designLayer():DesignLayer
    public function set designLayer(value:DesignLayer):void

相关 API 元素

height

属性 
height:Number

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

表示显示对象的高度,以像素为单位。高度是根据显示对象内容的范围来计算的。如果您设置了 height 属性,则 scaleY 属性会相应调整,如以下代码所示:

    var rect:Shape = new Shape();
    rect.graphics.beginFill(0xFF0000);
    rect.graphics.drawRect(0, 0, 100, 100);
    trace(rect.scaleY) // 1;
    rect.height = 200;
    trace(rect.scaleY) // 2;

除 TextField 和 Video 对象以外,没有内容的显示对象(如一个空的 Sprite)的高度为 0,即使您尝试将 height 设置为其他值,也是这样。



实现
    public function get height():Number
    public function set height(value:Number):void

is3D

属性 
is3D:Boolean  [只读]

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

当元素为 3D 时,则为 true。元素也可以是 3D 的,因为它具有 3D 转换属性或 3D 布局后转换偏移,或二者都有。



实现
    public function get is3D():Boolean

相关 API 元素

owner

属性 
owner:DisplayObjectContainer

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

此 IVisualElement 对象的所有者。默认情况下,它是此 IVisualElement 对象的父代。不过,如果此 IVisualElement 对象是由其父代弹出的一个子组件(如 ComboBox 控件的下拉列表),则所有者是弹出此 IVisualElement 对象的组件。

此属性并非由 Flex 管理,而由各个组件管理。因此,如果使用 PopUpManger.createPopUp()PopUpManger.addPopUp() 方法弹出一个子组件,则应该将该子组件的 owner 属性设置为弹出它的组件。

默认值为 parent 属性的值。



实现
    public function get owner():DisplayObjectContainer
    public function set owner(value:DisplayObjectContainer):void

parent

属性 
parent:DisplayObjectContainer  [只读]

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

此组件的父容器或组件。只有可视元素应该具有 parent 属性。非可视项目应该使用其他属性引用其所属对象。一般而言,非可视对象使用 owner 属性引用其所属对象。



实现
    public function get parent():DisplayObjectContainer

postLayoutTransformOffsets

属性 
postLayoutTransformOffsets:mx.geom:TransformOffsets

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

定义能够应用于对象转换且在一定程度上对其父布局不可视的一组调整。

例如,如果希望某个布局为将旋转 90 度的某个对象进行调整,请设置该对象的 rotation 属性。如果希望布局为要旋转的对象进行调整,请设置其 postLayoutTransformOffsets.rotationZ 属性。



实现
    public function get postLayoutTransformOffsets():mx.geom:TransformOffsets
    public function set postLayoutTransformOffsets(value:mx.geom:TransformOffsets):void

visible

属性 
visible:Boolean

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

控制此可视元素的可见性。如果为 true,则对象可见。

如果对象不可视,但将 includeInLayout 属性设置为 true,则该对象占用容器中的空间,但不可视。

如果 visible 设置为 true,对象未必可视,由于其大小以及容器剪裁是否启用。

visible 设置为 false 应该会禁止组件获取焦点。

默认值为 true。



实现
    public function get visible():Boolean
    public function set visible(value:Boolean):void

相关 API 元素

width

属性 
width:Number

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

表示显示对象的宽度,以像素为单位。宽度是根据显示对象内容的范围来计算的。如果您设置了 width 属性,则 scaleX 属性会相应调整,如以下代码所示:

    var rect:Shape = new Shape();
    rect.graphics.beginFill(0xFF0000);
    rect.graphics.drawRect(0, 0, 100, 100);
    trace(rect.scaleX) // 1;
    rect.width = 200;
    trace(rect.scaleX) // 2;

除 TextField 和 Video 对象以外,没有内容的显示对象(如一个空的 Sprite)的宽度为 0,即使您尝试将 width 设置为其他值,也是这样。



实现
    public function get width():Number
    public function set width(value:Number):void

x

属性 
x:Number

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。如果该对象位于具有变形的 DisplayObjectContainer 内,则它也位于包含 DisplayObjectContainer 的本地坐标系中。因此,对于逆时针旋转 90 度的 DisplayObjectContainer,该 DisplayObjectContainer 的子级将继承逆时针旋转 90 度的坐标系。对象的坐标指的是注册点的位置。



实现
    public function get x():Number
    public function set x(value:Number):void

y

属性 
y:Number

语言版本: ActionScript 3.0
产品版本: Flex 4
运行时版本: Flash Player 10, AIR 1.5

表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。如果该对象位于具有变形的 DisplayObjectContainer 内,则它也位于包含 DisplayObjectContainer 的本地坐标系中。因此,对于逆时针旋转 90 度的 DisplayObjectContainer,该 DisplayObjectContainer 的子级将继承逆时针旋转 90 度的坐标系。对象的坐标指的是注册点的位置。



实现
    public function get y():Number
    public function set y(value:Number):void




[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。