(Preview)
| Package | spark.primitives |
| Class | public class Rect |
| Inheritance | Rect  FilledElement StrokedElement GraphicElement EventDispatcher Object |
| Subclasses | BeveledBorder |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
drawElement() method
calls the Graphics.drawRect() and Graphics.drawRoundRect()
methods.
Note: By default, the stroke of the border is rounded.
If you do not want rounded corners, set the joints property of
the stroke to JointStyle.MITER.
More examples
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number
The level of transparency of the graphic element. | GraphicElement | |
| alwaysCreateDisplayObject : Boolean
Specifies that this GraphicElement is to be associated with and be rendered
to its own DisplayObject. | GraphicElement | |
| baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | GraphicElement | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | GraphicElement | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | GraphicElement | |
| bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | GraphicElement | |
| bottomLeftRadiusX : Number
The x radius of the bottom left corner of the rectangle. | Rect | ||
| bottomLeftRadiusY : Number
The y radius of the bottom left corner of the rectangle. | Rect | ||
| bottomRightRadiusX : Number
The x radius of the bottom right corner of the rectangle. | Rect | ||
| bottomRightRadiusY : Number
The y radius of the bottom right corner of the rectangle. | Rect | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | GraphicElement | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | GraphicElement | |
| displayObject : DisplayObject [read-only]
The shared DisplayObject where this
IGraphicElement is drawn. | GraphicElement | |
| displayObjectSharingMode : String
Indicates the association between this IGraphicElement and its
display objects. | GraphicElement | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | GraphicElement | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | GraphicElement | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | GraphicElement | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | GraphicElement | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | GraphicElement | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | GraphicElement | |
| fill : IFill
The object that defines the properties of the fill. | FilledElement | |
| filters : Array
An indexed array that contains each filter object currently associated with the graphic element. | GraphicElement | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | GraphicElement | |
| height : Number
The height of the graphic element. | GraphicElement | |
| horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | GraphicElement | |
| id : String
The identity of the component. | GraphicElement | |
| includeInLayout : Boolean
Specifies whether this element is included in the layout of the parent. | GraphicElement | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | GraphicElement | |
| layoutDirection : String
Specifies the desired layout direction for an element: one of LayoutDirection.LTR
(left to right), LayoutDirection.RTL (right to left), or null (inherit). | GraphicElement | |
| left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | GraphicElement | |
| luminosityClip : Boolean
A property that controls whether the luminosity
mask clips the masked content. | GraphicElement | |
| luminosityInvert : Boolean
A property that controls the calculation of the RGB
color value of a graphic element being masked by
a luminosity mask. | GraphicElement | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | GraphicElement | |
| maskType : String
Defines how the mask is applied to the GraphicElement.
The possible values are MaskType.CLIP, MaskType.ALPHA, and
MaskType.LUMINOSITY.
Clip Masking
When masking in clip mode, a clipping masks is reduced to 1-bit. | GraphicElement | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | GraphicElement | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | GraphicElement | |
| measuredHeight : Number
The default height of the component, in pixels. | GraphicElement | |
| measuredWidth : Number
The default width of the component, in pixels. | GraphicElement | |
| measuredX : Number
The default measured bounds top-left corner relative to the origin of the element. | GraphicElement | |
| measuredY : Number
The default measured bounds top-left corner relative to the origin of the element. | GraphicElement | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | GraphicElement | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | GraphicElement | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | GraphicElement | |
| parent : DisplayObjectContainer [read-only]
The parent container or component for this component. | GraphicElement | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | GraphicElement | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | GraphicElement | |
| postLayoutTransformOffsets : 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. | GraphicElement | |
| radiusX : Number
The default corner radius to use for the x axis on all corners. | Rect | ||
| radiusY : Number
The default corner radius to use for the y axis on all corners. | Rect | ||
| right : Object
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | GraphicElement | |
| rotation : Number
Indicates the rotation of the element, in degrees,
from the transform point. | GraphicElement | |
| rotationX : Number
Indicates the x-axis rotation of the element instance, in degrees, from its original orientation
relative to the 3D parent container. | GraphicElement | |
| rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | GraphicElement | |
| rotationZ : Number
Indicates the rotation of the element, in degrees,
from the transform point. | GraphicElement | |
| scaleX : Number
The horizontal scale (percentage) of the element
as applied from the transform point. | GraphicElement | |
| scaleY : Number
The vertical scale (percentage) of the element
as applied from the transform point. | GraphicElement | |
| scaleZ : Number
The z scale (percentage) of the element
as applied from the transform point. | GraphicElement | |
| stroke : IStroke
The stroke used by this element. | StrokedElement | |
| top : Object
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | GraphicElement | |
| topLeftRadiusX : Number
The x radius of the top left corner of the rectangle. | Rect | ||
| topLeftRadiusY : Number
The y radius of the top left corner of the rectangle. | Rect | ||
| topRightRadiusX : Number
The x radius of the top right corner of the rectangle. | Rect | ||
| topRightRadiusY : Number
The y radius of the top right corner of the rectangle. | Rect | ||
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | GraphicElement | |
| transformX : Number
The x position transform point of the element. | GraphicElement | |
| transformY : Number
The y position transform point of the element. | GraphicElement | |
| transformZ : Number
The z position transform point of the element. | GraphicElement | |
| verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | GraphicElement | |
| visible : Boolean
Controls the visibility of this visual element. | GraphicElement | |
| width : Number
The width of the graphic element. | GraphicElement | |
| x : Number
The x position of the graphic element. | GraphicElement | |
| y : Number
The y position of the graphic element. | GraphicElement | |
| z : Number
The z position of the graphic element. | GraphicElement | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Rect()
Constructor. | Rect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Returns true if this IGraphicElement is compatible and can
share display objects with the next IGraphicElement
in the sequence. | GraphicElement | |
|
Returns true if this IGraphicElement is compatible and can
share display objects with the previous IGraphicElement
in the sequence. | GraphicElement | |
|
Creates a new DisplayObject where this IGraphicElement
is drawn. | GraphicElement | |
|
Dispatches an event into the event flow. | EventDispatcher | |
[override]
Returns the x coordinate of the element's bounds at the specified element size. | Rect | ||
[override]
Returns the y coordinate of the element's bounds at the specified element size. | Rect | ||
|
Returns the element's layout height. | GraphicElement | |
|
Returns the element's layout width. | GraphicElement | |
|
Returns the x coordinate that the element uses to draw on screen. | GraphicElement | |
|
Returns the y coordinate that the element uses to draw on screen. | GraphicElement | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | GraphicElement | |
|
Returns the layout transform Matrix3D for this element. | GraphicElement | |
|
Returns the element's maximum height. | GraphicElement | |
|
Returns the element's maximum width. | GraphicElement | |
|
Returns the element's minimum height. | GraphicElement | |
|
Returns the element's minimum width. | GraphicElement | |
|
Returns the element's preferred height. | GraphicElement | |
|
Returns the element's preferred width. | GraphicElement | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Called automatically by the MXML compiler when the GraphicElement
is created using an MXML tag. | GraphicElement | |
|
Calling this method results in a call to the elements's
validateDisplayList() method
before the display list is rendered. | GraphicElement | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | GraphicElement | |
|
Calling this method results in a call to the elements's
validateProperties() method
before the display list is rendered. | GraphicElement | |
|
Calling this method results in a call to the elements's
validateSize() method
before the display list is rendered. | GraphicElement | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts the point object from the object's (local) coordinates
to the Stage (global) coordinates. | GraphicElement | |
|
Called by IGraphicElementContainer when an IGraphicElement
is added to or removed from the host component. | GraphicElement | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
| setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | GraphicElement | |
|
Sets the layout size of the element. | GraphicElement | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | GraphicElement | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | GraphicElement | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Determines whether this element can draw itself to the
sharedDisplayObject of the sequence. | GraphicElement | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
| 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. | GraphicElement | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | GraphicElement | |
|
Called by the IGraphicElementContainer to redraw this element
in its displayObject property. | GraphicElement | |
|
Validates and updates the properties and layout of this object
by immediately calling validateProperties(),
validateSize(), and validateDisplayList(),
if necessary. | GraphicElement | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | GraphicElement | |
|
Called by the IGraphicElementContainer to validate the size of
this element. | GraphicElement | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
| [override]
Set up the drawing for this element. | FilledElement | |
|
Determines if the call to the measure() method can be skipped. | GraphicElement | |
|
Processes the properties set on the element. | GraphicElement | |
[override]
Draw the element. | Rect | ||
| [override]
Finalize drawing for this element. | FilledElement | |
|
Returns the amount of pixels occupied by the stroke on each side
of the element's bounds. | GraphicElement | |
|
Utility method that notifies the host that this element has changed and needs
its layer to be updated. | GraphicElement | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | GraphicElement | |
|
Calculates the default size of the element. | GraphicElement | |
|
Used for the implementation of the ILayoutElement interface,
returns the explicit measured height pre-transform. | GraphicElement | |
|
Used for the implementation of the ILayoutElement interface,
returns the explicit of measured width pre-transform. | GraphicElement | |
|
Transform the element's size. | GraphicElement | |
|
Transform the element's size. | GraphicElement | |
| [override]
Draws the element and/or sizes and positions its content. | StrokedElement | |
Property Detail
bottomLeftRadiusX | property |
bottomLeftRadiusX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The x radius of the bottom left corner of the rectangle.
The default value is NaN.
Implementation
public function get bottomLeftRadiusX():Number public function set bottomLeftRadiusX(value:Number):voidbottomLeftRadiusY | property |
bottomLeftRadiusY:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The y radius of the bottom left corner of the rectangle.
The default value is NaN.
Implementation
public function get bottomLeftRadiusY():Number public function set bottomLeftRadiusY(value:Number):voidbottomRightRadiusX | property |
bottomRightRadiusX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The x radius of the bottom right corner of the rectangle.
The default value is NaN.
Implementation
public function get bottomRightRadiusX():Number public function set bottomRightRadiusX(value:Number):voidbottomRightRadiusY | property |
bottomRightRadiusY:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The y radius of the bottom right corner of the rectangle.
The default value is NaN.
Implementation
public function get bottomRightRadiusY():Number public function set bottomRightRadiusY(value:Number):voidradiusX | property |
radiusX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The default corner radius to use for the x axis on all corners. The
topLeftRadiusX, topRightRadiusX,
bottomLeftRadiusX, and bottomRightRadiusX
properties take precedence over this property.
Implementation
public function get radiusX():Number public function set radiusX(value:Number):voidradiusY | property |
radiusY:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The default corner radius to use for the y axis on all corners. The
topLeftRadiusY, topRightRadiusY,
bottomLeftRadiusY, and bottomRightRadiusY
properties take precedence over this property.
Implementation
public function get radiusY():Number public function set radiusY(value:Number):voidtopLeftRadiusX | property |
topLeftRadiusX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The x radius of the top left corner of the rectangle.
The default value is NaN.
Implementation
public function get topLeftRadiusX():Number public function set topLeftRadiusX(value:Number):voidtopLeftRadiusY | property |
topLeftRadiusY:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The y radius of the top left corner of the rectangle.
The default value is NaN.
Implementation
public function get topLeftRadiusY():Number public function set topLeftRadiusY(value:Number):voidtopRightRadiusX | property |
topRightRadiusX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The x radius of the top right corner of the rectangle.
The default value is NaN.
Implementation
public function get topRightRadiusX():Number public function set topRightRadiusX(value:Number):voidtopRightRadiusY | property |
topRightRadiusY:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The y radius of the top right corner of the rectangle.
The default value is NaN.
Implementation
public function get topRightRadiusY():Number public function set topRightRadiusY(value:Number):voidConstructor Detail
Rect | () | Constructor |
public function Rect()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Method Detail
draw | () | method |
override protected function draw(g:Graphics):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Draw the element. This is the second of three steps taken during the drawing
process. Override this method to implement your drawing. The stroke
(and fill, if applicable) have been set in the beginDraw() method.
Your override should only contain calls to drawing methods such as
moveTo(), curveTo(), and drawRect().
Parameters
g:Graphics — The graphic element to draw.
|
getBoundsXAtSize | () | method |
override public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
Parameters
width:Number — The element's bounds width, or NaN to use the preferred width.
| |
height:Number — The element's bounds height, or NaN to use the preferred height.
| |
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
x coordinate of the element's bounding box top-left corner.
The bounding box is in element's parent coordinate space and is calculated
from the specified bounds size, layout position and layout transform matrix.
|
Number — The x coordinate of the element's bounds at the specified element size.
|
getBoundsYAtSize | () | method |
override public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
Parameters
width:Number — The element's bounds width, or NaN to use the preferred width.
| |
height:Number — The element's bounds height, or NaN to use the preferred height.
| |
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
the y coordinate of the element's bounding box top-left corner.
The bounding box is in element's parent coordinate space and is calculated
from the specified bounds size, layout position and layout transform matrix.
|
Number — The y coordinate of the element's bounds at the specified element size.
|
Examples How to use this example
RectExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- RectExample.mxml -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark">
<s:Panel title="Rectangle Graphic Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:Group left="10" right="10" top="10" bottom="10">
<s:Graphic x="0" y="0">
<!-- Draw rectangle with square corners. -->
<s:Rect height="100" width="200">
<s:stroke>
<s:SolidColorStroke color="0x000000" weight="2"/>
</s:stroke>
<s:fill>
<s:RadialGradient>
<s:entries>
<s:GradientEntry color="0x0056FF" ratio="0.00" alpha="0.5"/>
<s:GradientEntry color="0x00CC99" ratio="0.33" alpha="0.5"/>
<s:GradientEntry color="0xECEC21" ratio="0.66" alpha="0.5"/>
</s:entries>
</s:RadialGradient>
</s:fill>
</s:Rect>
</s:Graphic>
<s:Graphic x="250" y="0">
<!-- Draw rectangle with rounded corners. -->
<s:Rect height="100" width="200" radiusX="25" radiusY="25">
<s:stroke>
<s:SolidColorStroke color="0x000000" weight="2"/>
</s:stroke>
<s:fill>
<s:RadialGradient>
<s:entries>
<s:GradientEntry color="0x0056FF" ratio="0.00" alpha="0.5"/>
<s:GradientEntry color="0x00CC99" ratio="0.33" alpha="0.5"/>
<s:GradientEntry color="0xECEC21" ratio="0.66" alpha="0.5"/>
</s:entries>
</s:RadialGradient>
</s:fill>
</s:Rect>
</s:Graphic>
</s:Group>
</s:Panel>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00