適用於 Adobe® Flash® Platform 的 ActionScript® 3.0 參考
首頁  |  隱藏套件和類別清單 |  套件  |  類別  |  新增內容  |  索引  |  附錄  |  為什麼顯示英文?
篩選: 從伺服器擷取資料...
從伺服器擷取資料...
spark.core 

IGraphicElement  - AS3 Flex

套件spark.core
介面public interface IGraphicElement extends IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
實作者 GraphicElement

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

The IGraphicElement is implemented by IVisualElements that take advantage of the parent IGraphicElementContainer DisplayObject management.

One typical use case is DisplayObject sharing. the Group class, which implements IGraphicElementContainer, organizes its IGraphicElement children in sequences that share and draw to the same DisplayObject. The DisplayObject is created by the first element in the sequence.

Another use case is when an element does not derive from DisplayObject but instead maintains, creates and/or destroys its own DisplayObject. The IGraphicElementContainer will call the element to create the DisplayObject, add the DisplayObject as its child at the correct index, and handle its removal.

Typically, you extend the GraphicElement class instead of directly implementing the IGraphciElement interface. The GraphicElement class already provides most of the required functionality.

相關 API 元素



公用屬性
 屬性定義自
 Inheritedalpha : Number
指出所指定物件的 Alpha 透明度值。
IVisualElement
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
ILayoutElement
 InheritedbaselinePosition : Number
[唯讀] The y-coordinate of the baseline of the first line of text of the component.
ILayoutElement
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
ILayoutElement
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
IVisualElement
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
IVisualElement
  displayObject : DisplayObject
[唯讀] The shared DisplayObject where this IGraphicElement is drawn.
IGraphicElement
  displayObjectSharingMode : String
Indicates the association between this IGraphicElement and its display objects.
IGraphicElement
 InheritedhasLayoutMatrix3D : Boolean
[唯讀] Contains true if the element has 3D Matrix.
ILayoutElement
 Inheritedheight : Number
會指出顯示物件的高度,以像素為單位。
IVisualElement
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
ILayoutElement
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
ILayoutElement
 Inheritedis3D : Boolean
[唯讀] Contains true when the element is in 3D.
IVisualElement
 InheritedlayoutDirection : 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
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
ILayoutElement
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
IVisualElement
 Inheritedparent : DisplayObjectContainer
[唯讀] The parent container or component for this component.
IVisualElement
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
ILayoutElement
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
ILayoutElement
 InheritedpostLayoutTransformOffsets : 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
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
ILayoutElement
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
ILayoutElement
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
ILayoutElement
 Inheritedvisible : Boolean
Controls the visibility of this visual element.
IVisualElement
 Inheritedwidth : Number
會指出顯示物件的寬度,以像素為單位。
IVisualElement
 Inheritedx : Number
指出 DisplayObject 實體相對於父輩 DisplayObjectContainer 之區域座標的 x 座標。
IVisualElement
 Inheritedy : Number
指出 DisplayObject 實體相對於父輩 DisplayObjectContainer 之區域座標的 y 座標。
IVisualElement
公用方法
 方法定義自
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。
IEventDispatcher
  
Returns true if this IGraphicElement is compatible and can share display objects with the next IGraphicElement in the sequence.
IGraphicElement
  
Returns true if this IGraphicElement is compatible and can share display objects with the previous IGraphicElement in the sequence.
IGraphicElement
  
Creates a new DisplayObject where this IGraphicElement is drawn.
IGraphicElement
 Inherited
會將事件傳送到事件流程。
IEventDispatcher
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
ILayoutElement
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
ILayoutElement
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
ILayoutElement
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
ILayoutElement
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
ILayoutElement
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
ILayoutElement
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
ILayoutElement
 Inherited
Returns the layout transform Matrix3D for this element.
ILayoutElement
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
ILayoutElement
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
ILayoutElement
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
ILayoutElement
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
ILayoutElement
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
ILayoutElement
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
ILayoutElement
 Inherited
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。
IEventDispatcher
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
ILayoutDirectionElement
  
Called by IGraphicElementContainer when an IGraphicElement is added to or removed from the host component.
IGraphicElement
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
會從 EventDispatcher 物件移除偵聽程式。
IEventDispatcher
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
ILayoutElement
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
ILayoutElement
 Inherited
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
 Inherited
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
  
Determines whether this element can draw itself to the sharedDisplayObject of the sequence.
IGraphicElement
 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
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
  
Called by the IGraphicElementContainer to redraw this element in its displayObject property.
IGraphicElement
  
Called by the IGraphicElementContainer to validate the properties of this element.
IGraphicElement
  
Called by the IGraphicElementContainer to validate the size of this element.
IGraphicElement
 Inherited
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。
IEventDispatcher
屬性詳細資訊

displayObject

屬性
displayObject:DisplayObject  [唯讀]

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

The shared DisplayObject where this IGraphicElement is drawn.

Implementers should not create the DisplayObject here, but in the createDisplayObject() method.



實作
    public function get displayObject():DisplayObject

相關 API 元素

displayObjectSharingMode

屬性 
displayObjectSharingMode:String

語言版本: ActionScript 3.0
產品版本: Flex 4.5
執行階段版本: Flash Player 10, AIR 2.5

Indicates the association between this IGraphicElement and its display objects. The IGraphicElementContainer manages this property and the values are one of the DisplayObjectSharingMode enum class.

  • A value of DisplayObjectSharingMode.OWNS_UNSHARED_OBJECT indicates that the IGraphicElement owns exclusively the DisplayObject corresponding to its displayObject property.
  • A value of DisplayObjectSharingMode.OWNS_SHARED_OBJECT indicates taht the IGraphicElement owns the DisplayObject corresponding to its displayObject property but other IGraphicElements are using/drawing to that display object as well. Depending on the specific implementation, the IGraphicElement may perform certain management of the display object. For example the base class GraphicElement clears the transform of the display object, reset its visibility, alpha, etc. properties to their default values and additionally clear the graphics on every validateDisplayList() call.
  • A value of DisplayObjectSharingMode.USES_SHARED_OBJECT indicates that the IGraphicElement draws into the DisplayObject corresponding to its displayObject property. There are one or more IGraphicElements that draw into that same displayObject, and the first element that draws has its mode set to DisplayObjectMode.OWNS_SHARED_OBJECT



實作
    public function get displayObjectSharingMode():String
    public function set displayObjectSharingMode(value:String):void
方法詳細資訊

canShareWithNext

()方法
public function canShareWithNext(element:IGraphicElement):Boolean

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Returns true if this IGraphicElement is compatible and can share display objects with the next IGraphicElement in the sequence.

參數

element:IGraphicElement — The element that comes after this element in the sequence.

傳回值
Boolean — Returns true when this element is compatible with the previous element in the sequence.

相關 API 元素

canShareWithPrevious

()方法 
public function canShareWithPrevious(element:IGraphicElement):Boolean

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Returns true if this IGraphicElement is compatible and can share display objects with the previous IGraphicElement in the sequence.

In certain cases the element might be passed to the IGraphicElementContainer in a call to the setSharedDisplayObject() method. In those cases, this method is not called.

參數

element:IGraphicElement — The element that comes before this element in the sequence.

傳回值
Boolean — Returns true when this element is compatible with the previous element in the sequence.

相關 API 元素

createDisplayObject

()方法 
public function createDisplayObject():DisplayObject

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Creates a new DisplayObject where this IGraphicElement is drawn.

Subsequent calls to the getter of the displayObject property must return the same display object.

After the DisplayObject is created, the parent IGraphicElementContainer will pass along the display objects to the rest of the elements in the sequence.

The IGraphicElementContainer ensures that this method is called only when needed.

If the element wants to participate in the DisplayObject sharing, then the new DisplayObject must implement IShareableDisplayObject. This interface is being used by the IGraphicElementContainer to manage invalidation and redrawing of the graphic element sequence and typically is not directly used by the developer.

To reevaluate the shared sequences, call the invalidateGraphicElementSharing() method on the IGraphicElementContainer.

To force the IGraphicElementContainer to remove the element's current DisplayObject from its display list and recalculate the display object sharing, call the discardDisplayObject() method on the IGraphicElementContainer.

傳回值
DisplayObject — The display object created.

相關 API 元素

parentChanged

()方法 
public function parentChanged(parent:IGraphicElementContainer):void

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Called by IGraphicElementContainer when an IGraphicElement is added to or removed from the host component.

You typically never need to call this method.

參數

parent:IGraphicElementContainer — The IGraphicElementContainer of this IGraphicElement.

setSharedDisplayObject

()方法 
public function setSharedDisplayObject(sharedDisplayObject:DisplayObject):Boolean

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Determines whether this element can draw itself to the sharedDisplayObject of the sequence.

Typically implementers return true when this IGraphicElement can cumulatively draw in the shared DisplayObject graphics property. In all cases where this IGraphicElement needs to set properties on the DisplayObjects that don't apply to the rest of the elements in the sequence, this method must return false. Examples for such properties are rotation, scale, transform, mask, alpha, filters, color transform, 3D, and layer.

When this method returns true, subsequent calls to the getter of the displayObject property must return the same display object.

In certain cases, the sharedDisplayObject property might be the IGraphicElementContainer itself. In the rest of the cases, the DisplayObject is created by the first element in the sequence.

When this IGraphicElement needs to rebuild its sequence, it notifies the IGraphicElementContainer by calling its invalidateGraphicElementSharing() method.

參數

sharedDisplayObject:DisplayObject — The shared DisplayObject.

傳回值
Boolean — Returns true when this IGraphicElement can draw itself to the shared DisplayObject of the sequence.

相關 API 元素

validateDisplayList

()方法 
public function validateDisplayList():void

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Called by the IGraphicElementContainer to redraw this element in its displayObject property.

If the element is the first in the sequence (displayObjectSharingMode is set to DisplayObjectSharingMode.OWNS_SHARED_OBJECT) then it must clear the displayObject graphics and set it up as necessary for drawing the rest of the elements.

The element must alway redraw even if it itself has not changed since the last time the validateDisplayList() method was called. The parent IGraphicElementContainer will redraw the whole sequence if any of its elements need to be redrawn.

To ensure this method is called, notify the IGraphicElementContainer by calling its invalidateGraphicElementSize() method.

This method might be called even if this element has not notified the IGraphicElementContainer.

相關 API 元素

validateProperties

()方法 
public function validateProperties():void

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Called by the IGraphicElementContainer to validate the properties of this element.

To ensure that this method is called, notify the IGraphicElementContainer by calling its invalidateGraphicElementProperties() method.

This method might be called even if this element has not notified the IGraphicElementContainer.

相關 API 元素

validateSize

()方法 
public function validateSize():void

語言版本: ActionScript 3.0
產品版本: Flex 4
執行階段版本: Flash Player 10, AIR 1.5

Called by the IGraphicElementContainer to validate the size of this element.

When the size of the element changes and is going to affect the IGraphicElementContainer layout, the implementer is responsible for invalidating the parent's size and display list.

To ensure that this method is called, notify the IGraphicElementContainer by calling its invalidateGraphicElementSize() method.

This method might be called even if this element has not notified the IGraphicElementContainer.

相關 API 元素





[ X ]為什麼顯示英文?
「ActionScript 3.0 參考」的內容是以英文顯示

並非所有「ActionScript 3.0 參考」的內容都翻譯為所有語言。當語言元素未翻譯時,就會以英文顯示。例如,ga.controls.HelpBox 類別並沒有翻譯為任何語言。因此在參考的繁體中文版本中,ga.controls.HelpBox 類別就會以英文顯示。