SpriteVisualElement  - AS3 Flex

The vertical distance in pixels from the anchor target to the control's baseline position.

By default the anchor target is 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 specify an anchor target, set the property value to a string in the format: "anchorTargetName:value". For example, "row1:10".

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

This property is used to implement the baseline constraint style. It is also used to align the label of a FormItem with the controls in the FormItem.

Each component should override this property.

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

Wartością domyślną jest auto.

Powiązane elementy interfejsu API

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 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 specify an anchor target, set the property value to a string in the format: "anchorTargetName:value". For example, "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.

Contains true if the element has 3D Matrix.

Use hasLayoutMatrix3D instead of calling and examining the return value of getLayoutMatrix3D() because that method returns a valid matrix even when the element is in 2D.

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 preceding 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". For example, "col1:10".

The identity of the component.

Specifies whether this component is included in the layout of the parent container. If true, the object is included in its parent container's layout and is sized and positioned by its parent container as per its layout rules. If false, the object size and position are not affected by its parent container's layout.

Contains true when the element is in 3D. The element can be in 3D either because it has 3D transform properties or it has 3D post layout transform offsets or both.

Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit). This property is typically backed by an inheriting style. If null, the layoutDirection style will be set to undefined. Classes like GraphicElement, which implement ILayoutDirectionElement but do not support styles, must additionally support a null value for this property which means the layoutDirection must be inherited from its parent.

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 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 specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "col1:10".

A property that controls whether the luminosity mask clips the masked content. This property can only have an effect if the graphic element has a mask applied to it that is of type MaskType.LUMINOSITY.

A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask. If true, the RGB color value of a pixel in the source content is inverted and multipled by the corresponding region in the mask. If false, the source content's pixel's RGB color value is used directly.

Sets the mask. The mask will be added to the display list. The mask must not already on a display list nor in the elements array.

The mask type. Possible values are MaskType.CLIP, MaskType.ALPHA or MaskType.LUMINOSITY.

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.

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.

Luminosity Masking

A luminosity mask, sometimes called a 'soft mask', works very similarly to an alpha mask except that both the opacity and RGB color value of a pixel in the source content is multiplied by the opacity and RGB color value of the corresponding region in the mask.

Luminosity masking is not native to Flash but is common in Adobe Creative Suite tools like Adobe Illustrator and Adobe Photoshop. In order to accomplish the visual effect of a luminosity mask in Flash-rendered content, a graphic element specifying a luminosity mask actually instantiates a shader filter that mimics the visual look of a luminosity mask as rendered in Adobe Creative Suite tools.

Objects being masked by luminosity masks can set properties to control the RGB color value and clipping of the mask. See the luminosityInvert and luminosityClip attributes.

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .

A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.

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.

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.

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.

When used with Spark layouts, this property is used to calculate the width of the component's bounds after scaling and rotation. For example if the component is rotated at 90 degrees, then specifying percentWidth will affect the component's height.

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.

For example, if you want a layout to adjust for an object that is rotated 90 degrees, set the object's rotation property. If you want the layout to not adjust for the object being rotated, set its postLayoutTransformOffsets.rotationZ property.

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 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 specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "col1:10".

Indicates the x-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 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.

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 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 specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "row1:10".

Sets the x coordinate for the transform center of the component.

When this object is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformX, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target object.

Powiązane elementy interfejsu API

Sets the y coordinate for the transform center of the component.

When this object is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformY, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target object.

Powiązane elementy interfejsu API

Sets the z coordinate for the transform center of the component.

When this object is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformZ, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target object.

Powiązane elementy interfejsu API

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 preceding 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". For example, "row1:10".

Defines the vertical space that the graphic uses in the layout. When you set this value, the content is not scaled. Whereas, if you specify the value of the height property, the content is scaled.

There are two cases where this can be useful: 1) Specify a viewHeight larger than the natural size of the content. You might do this so that the graphic takes up more space than its visual size. 2) Specify a viewHeight that is smaller than the natural size of the content. You might do this if your graphic has extra chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.

Defines the horizontal space that the graphic uses in the layout. When you set this value, the content is not scaled. Whereas, if you specify the value of the width property, the content is scaled.

There are two cases where this can be useful: 1) Specify a viewWidth larger than the natural size of the content. You might do this so that the graphic takes up more space than its visual size. 2) Specify a viewWidth that is smaller than the natural size of the content. You might do this if your graphic has extra chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.

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.

Constructor.

Returns the x coordinate of the element's bounds at the specified element size.

This method is typically used by layouts during a call to the measure() method to predict what the element position will be, if the element is resized to particular dimensions.

Parametry

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

Parametry

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

Parametry

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

Parametry

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

Parametry

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

Parametry

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.

Parametry

Returns the element's maximum width.

Parametry

Returns the element's minimum height.

Parametry

Returns the element's minimum width.

Parametry

Returns the element's preferred height.

Parametry

Returns the element's preferred width.

Parametry

Called automatically by the MXML compiler when the SpriteVisualElement is created using an MXML tag. If you create the SpriteVisualElement through ActionScript you must set the id property manually.

Parametry

An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. If they differ, this method is responsible for mirroring the element’s contents and for updating the element’s post-layout transform so that descendants inherit a mirrored coordinate system. IVisualElements typically implement mirroring by using postLayoutTransformOffsets to scale the X axis by -1 and to translate the x coordinate of the origin by the element's width. The net effect of this "mirror" transform is to reverse the direction in which the X axis increases without changing the element's location relative to its parent's origin.

Invalidates parent size and display list if this object affects its layout (includeInLayout is true).

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

Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().

Parametry

Sets the layout size of the element. This is the size that the element uses to draw on screen.

If the width and/or height parameters are left unspecified (NaN), Flex sets the element's layout size to its preferred width and/or preferred height.

Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().

Parametry

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

The 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() methods 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 the invalidateLayout() method so that a subsequent layout pass is not triggered.

Parametry

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 the invalidateLayout() method so that a subsequent layout pass is not triggered.

Parametry

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. This function will assign the rotation, scale, and translation values provided, then update the x/y/z properties as necessary to keep the transform center fixed.

Parametry

Transform the element's size.

This method calculates the bounding box of the graphic element as if the element’s width/height properties were set to the passed in values. The method returns the height of the bounding box.

In general, this method is not for use by developers. Instead, you should implement or override the methods defined by the ILayoutElement interface.

Parametry