The vertical distance in pixels from the anchor target to the control's baseline position. By default the anchor target is the the top edge of the container's content area. In layouts with advanced constraints, the target can be a constraint row. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To spcify an anchor target, set the property value to a string in the format "anchorTargetName:value" e.g. "row1:10".

The y-coordinate of the baseline of the first line of text of the component.

A value from the BlendMode class that specifies which blend mode to use.

The default value is auto.

See also

The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge. By default the anchor target is the the container's content area. In layouts with advanced constraints, the target can be a constraint row. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To spcify an anchor target, set the property value to a string in the format "anchorTargetName:value" e.g. "row1:10".

Determines the order in which items inside of containers are rendered. Spark containers order their items based on their depth property, with the lowest depth in the back, and the higher in the front. Items with the same depth value appear in the order they are added to the container.

Specifies the optional DesignLayer instance associated with this visual element.

When a DesignLayer is assigned, a visual element must consider the visibility and alpha of its parent layer when ultimately committing its own effective visibility or alpha to its backing DisplayObject (if applicable).

A visual element must listen for layerPropertyChange notifications from the associated layer parent. When the effectiveAlpha or effectiveVisibility of the layer changes, the element must then compute its own effective visibility (or alpha) and apply it accordingly.

This property should not be set within MXML directly.

The designLayer property is not used for z-order control, please see depth.

The shared DisplayObject where this IGraphicElement is drawn. Implementers should not create the DisplayObject here, but in createDisplayObject().

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

The actual DisplayObject that is drawn into by the GraphicElement. Typically this is equivalent to the displayObject property. Subclasses should perform drawing commands on this property instead of on displayObject.

The x position where the element should be drawn.

The y position where the element should be drawn.

Number that specifies the explicit height of the component, in pixels, in the component's coordinates.

See also

The maximum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

See also

The maximum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

See also

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

See also

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

See also

Number that specifies the explicit width of the component, in pixels, in the component's coordinates.

See also

An indexed array that contains each filter object currently associated with the graphic element. The mx.filters.package contains several classes that define specific filters you can use. The getter returns a copy of the filters array. The filters property value can only be changed via the setter.

Returns true if the GraphicElement has any non-translation (x,y) transform properties

True if the element has 3D Matrix. Use hasLayoutMatrix3D instead of calling and examining the value of getLayoutMatrix3D() as that method returns a valid matrix even when the element is in 2D.

The height of the graphic element.

The default value is 0.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

The horizontal distance in pixels from the center of the component to the center of the anchor target's content area. The default anchor target is the container itself. In layouts with advanced constraints, the anchor target can be a constraint column. Then the content area is the space between the preceeding column (or container side) and the target column. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To specify an anchor target, set the property value to a string in the format "constraintColumnId:value" e.g. "col1:10".

The identity of the component.

Specifies whether this element is included in the layout of the group.

The default value is true.

True, when the element is in 3D. The element can be in 3D either because it has 3D transform properties or it has 3D transform offsets or both.

Contain all of the implementation details of how the GraphicElement implements transform and layering support. In most cases, you should not have to modify this property.

The horizontal distance in pixels from the left edge of the component to the anchor target's left edge. By default the anchor target is the the container's content area. In layouts with advanced constraints, the target can be a constraint column. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To spcify an anchor target, set the property value to a string in the format "anchorTargetName:value" e.g. "col1:10".

Documentation is not currently available.

Documentation is not currently available.

The calling display object is masked by the specified mask object. If, the mask display object is not on the display list, it will be added to the display list as a child of the displayObject. The mask object itself is not drawn. Set mask to null to remove the mask. To use another GraphicElement as a mask, wrap the GraphicElement in a Group or other container.

See also

The maskType defines how the mask is applied to the GraphicElement.

The possible values are MaskType.CLIP and MaskType.ALPHA.

Clip Masking

When masking in clip mode, a clipping masks is reduced to 1-bit. This means that a mask will not affect the opacity of a pixel in the source content; it either leaves the value unmodified, if the corresponding pixel in the mask is has a non-zero alpha value, or makes it fully transparent, if the mask pixel value has an alpha value of zero.

When clip masking is used, only the actual path and shape vectors and fills defined by the mask are used to determine the effect on the source content. strokes and bitmap filters defined on the mask are ignored. Any filled region in the mask is considered filled, and renders the source content. The type and parameters of the fill is irrelevant; a solid color fill, gradient fill, or bitmap fill in a mask will all render the underlying source content, regardless of the alpha values of the mask fill.

BitmapGraphics are treated as bitmap filled rectangles when used in a clipping mask. As a result, the alpha channel of the source bitmap is irrelevant when part of a mask -- the bitmap affects the mask in the same manner as solid filled rectangle of equivalent dimensions.

Alpha Masking

In alpha mode, the opacity of each pixel in the source content is multiplied by the opacity of the corresponding region of the mask. i.e., a pixel in the source content with an opacity of 1 that is masked by a region of opacity of .5 will have a resulting opacity of .5. A source pixel with an opacity of .8 masked by a region with opacity of .5 will have a resulting opacity of .4.

Conceptually, Alpha masking is equivalent to rendering the transformed mask and source content into separate RGBA surfaces, and multiplying the alpha channel of the mask content into the alpha channel of the source content. All of the mask content is rendered into its surface before compositing into the source content's surface. As a result, all FXG features, such as strokes, bitmap filters, and fill opacity will affect the final composited content.

When in alpha mode, the alpha channel of any bitmap data is composited normally into the mask alpha channel, and will affect the final rendered content. This holds true for both BitmapGraphics and bitmap filled shapes and paths.

The default value is MaskType.CLIP.

The maximum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value of this property is set by the component developer.

The component developer uses this property to set an upper limit on the height of the component.

If the application developer overrides the default value of maxHeight, the new value is stored in explicitMaxHeight. The default value of maxHeight does not change. As a result, at layout time, if maxHeight was explicitly set by the application developer, then the value of explicitMaxHeight is used for the component's maximum recommended height. If maxHeight is not set explicitly by the user, then the default value is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true maxHeight with respect to its parent is affected by the scaleY property. Some components have no theoretical limit to their height. In those cases their maxHeight will be set to UIComponent.DEFAULT_MAX_HEIGHT.

The maximum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value of this property is set by the component developer.

The component developer uses this property to set an upper limit on the width of the component.

If the application developer overrides the default value of maxWidth, the new value is stored in explicitMaxWidth. The default value of maxWidth does not change. As a result, at layout time, if maxWidth was explicitly set by the application developer, then the value of explicitMaxWidth is used for the component's maximum recommended width. If maxWidth is not set explicitly by the user, then the default value is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true maxWidth with respect to its parent is affected by the scaleX property. Some components have no theoretical limit to their width. In those cases their maxWidth will be set to UIComponent.DEFAULT_MAX_WIDTH.

The default height of the component, in pixels. This value is set by the measure() method.

The default width of the component, in pixels. This value is set by the measure() method.

The default measured bounds top-left corner relative to the origin of the element.

The default measured bounds top-left corner relative to the origin of the element.

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minHeight, the new value is stored in explicitMinHeight. The default value of minHeight does not change. As a result, at layout time, if minHeight was explicitly set by the application developer, then the value of explicitMinHeight is used for the component's minimum recommended height. If minHeight is not set explicitly by the application developer, then the value of measuredMinHeight is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true minHeight with respect to its parent is affected by the scaleY property.

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minWidth, the new value is stored in explicitMinWidth. The default value of minWidth does not change. As a result, at layout time, if minWidth was explicitly set by the application developer, then the value of explicitMinWidth is used for the component's minimum recommended width. If minWidth is not set explicitly by the application developer, then the value of measuredMinWidth is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true minWidth with respect to its parent is affected by the scaleX property.

True if the element requires an exclusive DisplayObject. Developers don't usually call this method directly, but override it in their subclasses to indicate that an exclusive DisplayObject is needed. Usually a subclass needs a DisplayObject when it has to set its properties. Some examples of such DisplayObject properties are filters, blendMode, mask, rotation, alpha.

The owner of this IVisualElement object. By default, it is the parent of this IVisualElement object. However, if this IVisualElement object is a child component that is popped up by its parent, such as the drop-down list of a ComboBox control, the owner is the component that popped up this IVisualElement object.

This property is not managed by Flex, but by each component. Therefore, if you use the PopUpManger.createPopUp() or PopUpManger.addPopUp() method to pop up a child component, you should set the owner property of the child component to the component that popped it up.

The default value is the value of the parent property.

The parent container or component for this component. Only visual elements should have a parent property. Non-visual items should use another property to reference the object to which they belong. By convention, non-visual objects use an owner property to reference the object to which they belong.

Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0-100. Setting the height or explicitHeight properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the width or explicitWidth properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

This property is always set to NaN for the UITextField control.

The horizontal distance in pixels from the right edge of the component to the anchor target's right edge. By default the anchor target is the the container's content area. In layouts with advanced constraints, the target can be a constraint column. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To spcify an anchor target, set the property value to a string in the format "anchorTargetName:value" e.g. "col1:10".

Indicates the rotation of the element, in degrees, from the transform point.

Indicates the x-axis rotation of the element instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.

Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.

Indicates the rotation of the element, in degrees, from the transform point.

The horizontal scale (percentage) of the element as applied from the transform point.

The vertical scale (percentage) of the element as applied from the transform point.

The z scale (percentage) of the element as applied from the transform point.

The vertical distance in pixels from the top edge of the component to the anchor target's top edge. By default the anchor target is the the container's content area. In layouts with advanced constraints, the target can be a constraint row. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To spcify an anchor target, set the property value to a string in the format "anchorTargetName:value" e.g. "row1:10".

The x position transform point of the element.

The y position transform point of the element.

The z position transform point of the element.

The vertical distance in pixels from the center of the component to the center of the anchor target's content area. The default anchor target is the container itself. In layouts with advanced constraints, the anchor target can be a constraint row. Then the content area is the space between the preceeding row (or container side) and the target row. Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target. To specify an anchor target, set the property value to a string in the format "constraintColumnId:value" e.g. "row1:10".

Controls the visibility of this visual element. If true, the object is visible.

If an object is not visible, but the includeInLayout property is set to true, then the object takes up space in the container, but is invisible.

If visible is set to true, the object may not necessarily be visible due to its size and whether container clipping is enabled.

Setting visible to false, prevents the component from getting focus.

The width of the graphic element.

The default value is 0.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

The x position of the graphic element.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

The y position of the graphic element.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

The z position of the graphic element.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

Parameters

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

Note that in certain cases the element may be passed offered the parent Group itself in a call to setSharedDisplayObject. In those cases, this method won't be called.

Parameters

Processes the properties set on the element. This is an advanced method that you might override when creating a subclass.

You do not call this method directly. Flex calls the commitProperties() method when you use the addElement() method to add an element to the group, or when you call the invalidateProperties() method of the element. Calls to the commitProperties() method occur before calls to the measure() method. This lets you set property values that might be used by the measure() method.

Some elements have properties that interact with each other. It is often best at startup time to process all of these properties at one time to avoid duplicating work.

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 Group will pass along the display objects to the rest of the elements in the sequence. Group will ensure 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 Group to manage invalidation and redrawing of the graphic element sequence and typically is not directly used by the Developer.

Returns the x coordinate of the element's bounds at the specified element size. This method is typically used by layouts during measure() to predict what the element position will be, if the element is resized to particular dimesions.

Parameters

Returns the y coordinate of the element's bounds at the specified element size. This method is typically used by layouts during measure() to predict what the element position will be, if the element is resized to particular dimesions.

Parameters

Returns the element's layout height. This is the size that the element uses to draw on screen.

Parameters

Parameters

Returns the x coordinate that the element uses to draw on screen.

Parameters

Returns the y coordinate that the element uses to draw on screen.

Parameters

Returns the transform matrix that is used to calculate the component's layout relative to its siblings.

This matrix is typically defined by the component's 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Returns the layout transform Matrix3D for this element.

This matrix is typically defined by the component's transform properties such as x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY, scaleZ, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Returns the element's maximum height.

Parameters

Returns the element's maximum width.

Parameters

Returns the element's minimum height.

Parameters

Returns the element's minimum width.

Parameters

Returns the element's preferred height.

Parameters

Returns the element's preferred width.

Parameters

Returns the amount of pixels occupied by the stroke on each side of the element's bounds.

Parameters

Calling this method results in a call to the elements's validateDisplayList() method before the display list is rendered.

Subclasses should override and do their work in updateDisplayList().

Utility method that notifies the host that this element has changed and needs its layer to be updated.

Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).

Calling this method results in a call to the elements's validateProperties() method before the display list is rendered.

Subclasses should do their work in commitProperties().

Calling this method results in a call to the elements's validateSize() method before the display list is rendered.

Subclasses should override and do their measurement in measure(). By default when explicitWidth and explicitHeight are set, measure() will not be called. To override this default behavior subclasses should override skipMeasure().

Converts the point object from the object's (local) coordinates to the Stage (global) coordinates.

This method allows you to convert any given x and y coordinates from values that are relative to the origin (0,0) of a specific object (local coordinates) to values that are relative to the origin of the Stage (global coordinates).

To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the object.

You then pass the Point instance that you created as the parameter to the localToGlobal() method. The method returns a new Point object with x and y values that relate to the origin of the Stage instead of the origin of the object.

Parameters

See also

Calculates the default size of the element. This is an advanced method that you might override when creating a subclass of GraphicElement.

You do not call this method directly. Flex calls the measure() method when the element is added to a group using the addElement() method, and when the element's invalidateSize() method is called.

By default you set both explicit height and explicit width of an element, Flex does not call the measure() method, even if you explicitly call the invalidateSize() method. To override this behavior, override skipMeasure() method.

In your override of this method, you must set the measuredWidth and measuredHeight properties to define the default size. You can optionally set the measuredX and measuredY properties to define the default measured bounds top-left corner relative to the origin of the element.

The conceptual point of measure() is for the element to provide its own natural or intrinsic bounds as a default. Therefore, the measuredWidth and measuredHeight properties should be determined by factors such as:

• The amount of text the component needs to display.
• The size of a JPEG image that the component displays.

In some cases, there is no intrinsic way to determine default values. For example, a simple GreenCircle element might simply set measuredWidth = 100 and measuredHeight = 100 in its measure() method to provide a reasonable default size. In other cases, such as a TextArea, an appropriate computation (such as finding the right width and height that would just display all the text and have the aspect ratio of a Golden Rectangle) might be too time-consuming to be worthwhile.

The default implementation of measure() sets the values of the measuredWidth, measuredHeight, measuredX, and measuredY properties to 0.

Called by Group when an IGraphicElement is added to or removed from a Group. Developers typically never need to call this method.

Parameters

Used for the implementation of the ILayoutElement interface, returns the explicit of measured height pre-transform.

Used for the implementation of the ILayoutElement interface, returns the explicit of measured width pre-transform.

Sets the coordinates that the element uses to draw on screen.

Parameters

Sets the layout size to the specified dimensions. This is the size that the element uses to draw on screen. If one of the dimensions is left unspecified (NaN), it's size will be picked such that element can be optimally sized to fit the other dimension. This is useful when the caller doesn't want to overconstrain the element, for example when the element's width and height are corelated (text, components with complex transforms, etc.) If both dimensions are left unspecified, the element will have its layout size set to its preferred size. setLayoutSize does not clip against minium or maximum sizes. Note that calls to setLayoutSize can affect the layout position, so setLayoutSize should be called before setLayoutPosition.

Parameters

Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.

This matrix is typically defined by the component's 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets.

Note that layout Matrix is factored in the getPreferredSize(), getMinSize(), getMaxSize(), getLayoutSize() when computed in parent coordinates as well as in getLayoutPosition() in both parent and child coordinates. Layouts that calculate the transform matrix explicitly typically call this method and work with sizes in child coordinates. Layouts calling this method pass false to invalidateLayout so that a subsequent layout pass is not triggered.

Developers that call this method directly typically pass true to invalidateLayout so that the parent container is notified that it needs to re-layout the children.

Parameters

Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.

This matrix is typically defined by the component's transform properties such as x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY, scaleZ, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Note that layout Matrix3D is factored in the getPreferredSize(), getMinSize(), getMaxSize(), getLayoutSize() when computed in parent coordinates as well as in getLayoutPosition() in both parent and child coordinates. Layouts that calculate the transform matrix explicitly typically call this method and work with sizes in child coordinates. Layouts calling this method pass false to invalidateLayout so that a subsequent layout pass is not triggered.

Developers that call this method directly typically pass true to invalidateLayout so that the parent container is notified that it needs to re-layout the children.

Parameters

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

Typically implementers will 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 DisplayObject 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, layer, etc.

Note that in certain cases the sharedDisplayObject may be the parent Group 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 parent Group by calling its invalidateGraphicElementSharing() method.

Parameters

Parameters

Transform the element's size.

Parameters

FIXME (chaase) : FLEXDOCS-1031

Parameters

Transform the element's size.

Parameters

Draws the element and/or sizes and positions its content. This is an advanced method that you might override when creating a subclass of GraphicElement.

You do not call this method directly. Flex calls the updateDisplayList() method when the component is added to a group using the addElement() method, and when the element's invalidateDisplayList() method is called.

This method is where you would do programmatic drawing using methods on the elements's displayObject such as graphics.drawRect().

Parameters

Called by the parent Group 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 validateDisplayList() was called as the parent Group will redraw the whole sequence if any of its elements need to be redrawn.

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

Note that this method may be called even if this element have not notified the parent Group.

Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary.

Used by layout logic to validate the properties of a component by calling the commitProperties() method. In general, subclasses should override the commitProperties() method and not this method.

Called by the parent Group to validate the size of this element. When the size of the element changes and is going to affect the parent Group layout, the implementer is responsible for invalidating the parent's size and display list. To ensure this method is called, notify the parent Group by calling its invalidateGraphicElementSize() method. Note that this method may be called even if this element have not notified the parent Group.