ILayoutHost - Adobe ActionScript® 3 (AS3 ADEP Guides) API 参考

包	ga.model
接口	public interface ILayoutHost extends IUIComponent , IEventDispatcher , IStyleClient , IFlexDisplayObject , ISimpleStyleClient , IBitmapDrawable , IEventDispatcher
实现器	LayoutTemplate

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

This is the core interface of Guide panel layouts and needs to be implemented by all guide panel layouts.

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		accessibilityProperties : AccessibilityProperties 此显示对象的当前辅助功能选项。	IFlexDisplayObject
		alpha : Number 表示指定对象的 Alpha 透明度值。	IFlexDisplayObject
		baselinePosition : Number [只读] 组件第一行文本的基线的 y 坐标。	IUIComponent
		baseReferenceChain : BaseReferenceChain [只读] The chain of bindings up the ancestor chain.	ILayoutHost
		blendMode : String BlendMode 类中的一个值，用于指定要使用的混合模式。	IFlexDisplayObject
		cacheAsBitmap : Boolean 如果设置为 true，则 Flash 运行时将缓存显示对象的内部位图表示形式。	IFlexDisplayObject
		className : String [只读] 组件类的名称。	IStyleClient
		dataProvider : Object The data provider that is bound to this panel layout.	ILayoutHost
		defaultCaptionWidth : int The default caption width for each panel item within a panel layout.	ILayoutHost
		document : Object 对与此组件关联的文档对象的引用。	IUIComponent
		enabled : Boolean 组件是否可以接受用户交互。	IUIComponent
		explicitHeight : Number 在组件坐标中显式指定的组件高度（以像素为单位）。	IUIComponent
		explicitMaxHeight : Number [只读] 在组件坐标中指定组件最大高度的数字（以像素为单位）。	IUIComponent
		explicitMaxWidth : Number [只读] 在组件坐标中指定组件最大宽度的数字（以像素为单位）。	IUIComponent
		explicitMinHeight : Number [只读] 在组件坐标中指定组件最小高度的数字（以像素为单位）。	IUIComponent
		explicitMinWidth : Number [只读] 在组件坐标中指定组件最小宽度的数字（以像素为单位）。	IUIComponent
		explicitWidth : Number 在组件坐标中显式指定的组件宽度（以像素为单位）。	IUIComponent
		filters : Array 包含当前与显示对象关联的每个滤镜对象的索引数组。	IFlexDisplayObject
		focusPane : Sprite 在组件中共享并用作绘制焦点指示符的叠加层的单个 Sprite 对象。	IUIComponent
		height : Number 表示显示对象的高度，以像素为单位。	IFlexDisplayObject
		includeInLayout : Boolean 指定此组件是否包含在父容器的布局中。	IUIComponent
		inheritingStyles : Object 包含此组件的可继承样式的对象。	IStyleClient
		isPopUp : Boolean PopUpManager 将其设置为 true 以指示已弹出该组件。	IUIComponent
		loaderInfo : LoaderInfo [只读] 返回一个 LoaderInfo 对象，其中包含加载此显示对象所属的文件的相关信息。	IFlexDisplayObject
		mask : DisplayObject 调用显示对象被指定的 mask 对象遮罩。	IFlexDisplayObject
		maxHeight : Number [只读] 在组件坐标中指定组件最大高度的数字（以像素为单位）。	IUIComponent
		maxWidth : Number [只读] 在组件坐标中指定组件最大宽度的数字（以像素为单位）。	IUIComponent
		measuredHeight : Number [只读] 此对象的测量高度。	IFlexDisplayObject
		measuredMinHeight : Number 组件的默认最小高度（以像素为单位）。	IUIComponent
		measuredMinWidth : Number 组件的默认最小宽度（以像素为单位）。	IUIComponent
		measuredWidth : Number [只读] 此对象的测量宽度。	IFlexDisplayObject
		minHeight : Number [只读] 在组件坐标中指定组件最小高度的数字（以像素为单位）。	IUIComponent
		minWidth : Number [只读] 在组件坐标中指定组件最小宽度的数字（以像素为单位）。	IUIComponent
		mouseX : Number [只读] 表示此鼠标或用户输入设备位置的 x 坐标，以像素为单位。	IFlexDisplayObject
		mouseY : Number [只读] 表示此鼠标或用户输入设备位置的 y 坐标，以像素为单位。	IFlexDisplayObject
		name : String 表示 DisplayObject 的实例名称。	IFlexDisplayObject
		nonInheritingStyles : Object 包含此组件的不可继承样式的对象。	IStyleClient
		opaqueBackground : Object 指定显示对象是否由于具有某种背景颜色而不透明。	IFlexDisplayObject
		owner : DisplayObjectContainer 此 IVisualElement 对象的所有者。	IUIComponent
		panel : Panel the parent panel of the layout.	ILayoutHost
		panelItems : Array An array of panel items that are slotted into the panel layout.	ILayoutHost
		parent : DisplayObjectContainer [只读] 表示包含此显示对象的 DisplayObjectContainer 对象。	IFlexDisplayObject
		percentHeight : Number 以组件父项大小百分比的方式指定组件高度的数字。	IUIComponent
		percentWidth : Number 以组件父项大小百分比形式指定其宽度的数字。	IUIComponent
		root : DisplayObject [只读] 对于加载的 SWF 文件中的显示对象，root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。	IFlexDisplayObject
		rotation : Number 表示 DisplayObject 实例距其原始方向的旋转程度，以度为单位。	IFlexDisplayObject
		scale9Grid : Rectangle 当前有效的缩放网格。	IFlexDisplayObject
		scaleX : Number 表示从注册点开始应用的对象的水平缩放比例（百分比）。	IFlexDisplayObject
		scaleY : Number 表示从对象注册点开始应用的对象的垂直缩放比例（百分比）。	IFlexDisplayObject
		scrollRect : Rectangle 显示对象的滚动矩形范围。	IFlexDisplayObject
		sizeState : int The size state of this panel in the Guide layout.	ILayoutHost
		stage : Stage [只读] 显示对象的舞台。	IFlexDisplayObject
		styleDeclaration : CSSStyleDeclaration 具有此对象声明的内嵌样式的样式声明。	IStyleClient
		styleName : Object 该对象的样式值的源。	ISimpleStyleClient
		supportsDynamicAlignmentAreas : Boolean [只读] Indicates that this layout supports a dynamic number of alignment areas.	ILayoutHost
		supportsKeepWithPrevious : Boolean [只读] Indicates that this layout supports the keep with previous hint on a panel item.	ILayoutHost
		systemManager : ISystemManager 对此组件的 SystemManager 对象的引用。	IUIComponent
		transform : flash.geom:Transform 一个对象，具有与显示对象的矩阵、颜色转换和像素范围有关的属性。	IFlexDisplayObject
		tweeningProperties : Array 由 EffectManager 使用。	IUIComponent
		visible : Boolean 显示对象是否可见。	IFlexDisplayObject
		width : Number 表示显示对象的宽度，以像素为单位。	IFlexDisplayObject
		x : Number 表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。	IFlexDisplayObject
		y : Number 表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。	IFlexDisplayObject

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	IEventDispatcher
		clearStyle(styleProp:String):void 删除此组件实例的样式属性。	IStyleClient
		clone():Object Clone this panel layout.	ILayoutHost
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	IEventDispatcher
		executeBindings(recurse:Boolean = false):void Execute all bindings within this panel layout.	ILayoutHost
		getAllItems(container:DisplayObjectContainer = null, itemList:Array = null):Array Returns all display objects on this panel.	ILayoutHost
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle 返回一个矩形，该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。	IFlexDisplayObject
		getClassStyleDeclarations():Array 为应用于该组件的类型选择器返回 CSSStyleDeclaration 对象数组，如果不存在则返回 null。	IStyleClient
		getExplicitOrMeasuredHeight():Number 确定是使用显式高度还是测量高度的一种简便方法	IUIComponent
		getExplicitOrMeasuredWidth():Number 确定是使用显式宽度还是测量宽度的一种简便方法	IUIComponent
		getFields(visibleFieldsOnly:Boolean = false, container:DisplayObjectContainer = null):Array Returns the bound visible fields which are referenced in this layout.	ILayoutHost
		getFirstPanelItem(oContainer:DisplayObjectContainer = null):IPanelItem Returns the first panel item in the panel layout.	ILayoutHost
		getLabelAt(index:int):String Get label corresponding to the index in the data provider.	ILayoutHost
		getNamedAreas():Array Return an array of name areas or groups that this layout supports.	ILayoutHost
		getPanelItems(visibleItemsOnly:Boolean = false, container:DisplayObjectContainer = null, itemList:Array = null):Array Returns the panel items contained in the panel layout.	ILayoutHost
		getRect(targetCoordinateSpace:DisplayObject):Rectangle 返回一个矩形，该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界，但不包括形状上的任何笔触。	IFlexDisplayObject
		getStyle(styleProp:String):* 获取已在此组件的样式查找链中的某个位置设置过的样式属性。	IStyleClient
		globalToLocal(point:Point):Point 将 point 对象从舞台（全局）坐标转换为显示对象的（本地）坐标。	IFlexDisplayObject
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	IEventDispatcher
		hitTestObject(obj:DisplayObject):Boolean 计算显示对象的边框，以确定它是否与 obj 显示对象的边框重叠或相交。	IFlexDisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean 计算显示对象，以确定它是否与 x 和 y 参数指定的点重叠或相交。	IFlexDisplayObject
		initialize():void 初始化对象。	IUIComponent
		isDocPanel():Boolean True if this is a panel containing is a document of record.	ILayoutHost
		isPDFPanel():Boolean True if this is a panel containing a PDF rendition.	ILayoutHost
		localToGlobal(point:Point):Point 将 point 对象从显示对象的（本地）坐标转换为舞台（全局）坐标。	IFlexDisplayObject
		move(x:Number, y:Number):void 将此对象移动到指定的 x 和 y 坐标。	IFlexDisplayObject
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void 向该组件的子项传送样式更改。	IStyleClient
		owns(displayObject:DisplayObject):Boolean 如果 owner 属性链从 child 指向此 UIComponent，则返回 true。	IUIComponent
		parentChanged(p:DisplayObjectContainer):void 当在父项中添加或删除 UIComponent 对象时由 Flex 调用。	IUIComponent
		regenerateStyleCache(recursive:Boolean):void 设置内部样式缓存值，以便 getStyle() 方法可以起作用。	IStyleClient
		registerEffects(effects:Array):void 将 EffectManager 注册为每个效果事件的事件侦听器之一。	IStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		resetData(container:DisplayObjectContainer = null):void Resets the fields in a container.	ILayoutHost
		setActualSize(newWidth:Number, newHeight:Number):void 设置此对象的实际大小。	IFlexDisplayObject
		setSelectedPanelItem(item:Object):void set the selected panel on this layout.	ILayoutHost
		setStyle(styleProp:String, newValue:*):void 对此组件实例设置样式属性。	IStyleClient
		setVisible(value:Boolean, noEvent:Boolean = false):void 当 visible 属性发生更改时调用。	IUIComponent
		styleChanged(styleProp:String):void 当样式属性的值发生更改时调用。	ISimpleStyleClient
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	IEventDispatcher

属性详细信息

baseReferenceChain

属性

baseReferenceChain:BaseReferenceChain [只读]

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

The chain of bindings up the ancestor chain. Items in the panel will bind relative to a base reference in the ancestor chain. If the item binding is not relative to any base references in the ancestor chain it will be bind using the absolute address.

实现
public function get baseReferenceChain():BaseReferenceChain

dataProvider

属性

dataProvider:Object

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

The data provider that is bound to this panel layout. Can be a single instance or a collection/instanceManager.

实现
public function get dataProvider():Object
public function set dataProvider(value:Object):void

defaultCaptionWidth

属性

defaultCaptionWidth:int

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

The default caption width for each panel item within a panel layout.

实现
public function get defaultCaptionWidth():int
public function set defaultCaptionWidth(value:int):void

panel

属性

panel:Panel

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

the parent panel of the layout.

实现
public function get panel():Panel
public function set panel(value:Panel):void

panelItems

属性

panelItems:Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

An array of panel items that are slotted into the panel layout.

实现
public function get panelItems():Array
public function set panelItems(value:Array):void

sizeState

属性

sizeState:int

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

The size state of this panel in the Guide layout. This determines whether or not a panel is displayed full screen. 0 - display the panel normal size along with the panel navigator. non-zero - display the panel full screen.

实现
public function get sizeState():int
public function set sizeState(value:int):void

supportsDynamicAlignmentAreas

属性

supportsDynamicAlignmentAreas:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Indicates that this layout supports a dynamic number of alignment areas. This is queried by guide builder and is a design time parameter. When dynamic alignment areas are supported the designer will automatically create a new alignment area when the last alignment area is used.

实现
public function get supportsDynamicAlignmentAreas():Boolean

supportsKeepWithPrevious

属性

supportsKeepWithPrevious:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Indicates that this layout supports the keep with previous hint on a panel item. This is queried by guide builder and is a design time parameter. When keep with previous is supported the layout will position a panel item with keep with previous set to the right of the last panel item added to the layout.

实现
public function get supportsKeepWithPrevious():Boolean

方法详细信息

clone

()

方法

public function clone():Object

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Clone this panel layout.

Object — the clone of this object

executeBindings

()

方法

public function executeBindings(recurse:Boolean = false):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Execute all bindings within this panel layout.

参数

recurse:Boolean (default = false) — whether to recursively call executeBinding of child objects.

getAllItems

()

方法

public function getAllItems(container:DisplayObjectContainer = null, itemList:Array = null):Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Returns all display objects on this panel. Recursively searches through all DisplayObjectContainers inside this panel.

参数

	`container:DisplayObjectContainer` (default = `null`) — - the container to start the search. If null defaults to this object.

	`itemList:Array` (default = `null`) — - the array to append the results. If null creates a new array.

Array — the array containing all display objects.

getFields

()

方法

public function getFields(visibleFieldsOnly:Boolean = false, container:DisplayObjectContainer = null):Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Returns the bound visible fields which are referenced in this layout.

参数

	`visibleFieldsOnly:Boolean` (default = `false`) — - Set to true if the visible flelds are required. The default value is false.

	`container:DisplayObjectContainer` (default = `null`) — - The container to search for panelItems/fields (used for recursive searches).

Array — The array of fields

getFirstPanelItem

()

方法

public function getFirstPanelItem(oContainer:DisplayObjectContainer = null):IPanelItem

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Returns the first panel item in the panel layout.

参数

oContainer:DisplayObjectContainer (default = null) — the container to being searching for the first panel item.

IPanelItem — the first panel item

getLabelAt

()

方法

public function getLabelAt(index:int):String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Get label corresponding to the index in the data provider.

参数

index:int — - index into the data provider

String — the label.

getNamedAreas

()

方法

public function getNamedAreas():Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Return an array of name areas or groups that this layout supports. This is queried by guide builder and is a design time parameter.

Array — array of named areas for this layout

getPanelItems

()

方法

 public function getPanelItems(visibleItemsOnly:Boolean = false, container:DisplayObjectContainer = null, itemList:Array = null):Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Returns the panel items contained in the panel layout. This include all components implementing the IPanelItem interface. which include PanelItem (interactive controls) and PanelText (static text).

参数

	`visibleItemsOnly:Boolean` (default = `false`) — - Set to true if the visible panel items are required only. The default value is false.

	`container:DisplayObjectContainer` (default = `null`) — - The container to search for panelItems/fields (used for recursive searches).

	`itemList:Array` (default = `null`) — - The aggregate of all the fields found during the search (used for recursive searches).

Array — The array of panel items.

isDocPanel

()

方法

public function isDocPanel():Boolean

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

True if this is a panel containing is a document of record.

Boolean — Boolean indicating whether or not this is a document of record panel.

isPDFPanel

()

方法

public function isPDFPanel():Boolean

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

True if this is a panel containing a PDF rendition.

Boolean — Boolean indicating whether or not this is a PDF panel.

resetData

()

方法

public function resetData(container:DisplayObjectContainer = null):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

Resets the fields in a container. This function also resets data in the nested layouts if there are any. This is only used when the submitAll option is false, some customers need the ability to clear the data from a hidden field, as they have legal restructions that data from non-visible fields can never be submitted.

参数

container:DisplayObjectContainer (default = null) — - The container from which the fields must be reset.

setSelectedPanelItem

()

方法

public function setSelectedPanelItem(item:Object):void

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

AIR 1.0, Flash Player 10.2

set the selected panel on this layout.

参数

item:Object — the selected panel item.

法律声明 | 在线隐私策略

ILayoutHost - AS3 ADEP Guides

类 x

baseReferenceChain

dataProvider

defaultCaptionWidth

panel

panelItems

sizeState

supportsDynamicAlignmentAreas

supportsKeepWithPrevious

clone

executeBindings

getAllItems

getFields

getFirstPanelItem

getLabelAt

getNamedAreas

getPanelItems

isDocPanel

isPDFPanel

resetData

setSelectedPanelItem