Packagespark.primitives
Classpublic class Ellipse
InheritanceEllipse Inheritance FilledElement Inheritance StrokedElement Inheritance GraphicElement Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The Ellipse class is a filled graphic element that draws an ellipse. To draw the ellipse, this class calls the Graphics.drawEllipse() method.

View the examples

See also

flash.display.Graphics


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The level of transparency of the graphic element.
GraphicElement
 InheritedalwaysCreateDisplayObject : Boolean
Specifies that this GraphicElement is to be associated with and be rendered to its own DisplayObject.
GraphicElement
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
GraphicElement
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
GraphicElement
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
GraphicElement
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
GraphicElement
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
GraphicElement
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
GraphicElement
 InheriteddisplayObject : DisplayObject
[read-only] The shared DisplayObject where this IGraphicElement is drawn.
GraphicElement
 InheriteddisplayObjectSharingMode : String
Indicates the association between this IGraphicElement and its display objects.
GraphicElement
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
GraphicElement
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
GraphicElement
 Inheritedfill : IFill
The object that defines the properties of the fill.
FilledElement
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the graphic element.
GraphicElement
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
GraphicElement
 Inheritedheight : Number
The height of the graphic element.
GraphicElement
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
GraphicElement
 Inheritedid : String
The identity of the component.
GraphicElement
 InheritedincludeInLayout : Boolean
Specifies whether this element is included in the layout of the parent.
GraphicElement
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
GraphicElement
 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).
GraphicElement
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
GraphicElement
 InheritedluminosityClip : Boolean
A property that controls whether the luminosity mask clips the masked content.
GraphicElement
 InheritedluminosityInvert : Boolean
A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask.
GraphicElement
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
GraphicElement
 InheritedmaskType : 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
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
GraphicElement
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
GraphicElement
 InheritedmeasuredX : Number
The default measured bounds top-left corner relative to the origin of the element.
GraphicElement
 InheritedmeasuredY : Number
The default measured bounds top-left corner relative to the origin of the element.
GraphicElement
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedMXMLDescriptor : Array
[read-only]
GraphicElement
 InheritedMXMLProperties : Array
[read-only]
GraphicElement
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
GraphicElement
 Inheritedparent : DisplayObjectContainer
[read-only] The parent container or component for this component.
GraphicElement
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
GraphicElement
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
GraphicElement
 InheritedpostLayoutTransformOffsets : 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
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
GraphicElement
 Inheritedrotation : Number
Indicates the rotation of the element, in degrees, from the transform point.
GraphicElement
 InheritedrotationX : Number
Indicates the x-axis rotation of the element instance, in degrees, from its original orientation relative to the 3D parent container.
GraphicElement
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
GraphicElement
 InheritedrotationZ : Number
Indicates the rotation of the element, in degrees, from the transform point.
GraphicElement
 InheritedscaleX : Number
The horizontal scale (percentage) of the element as applied from the transform point.
GraphicElement
 InheritedscaleY : Number
The vertical scale (percentage) of the element as applied from the transform point.
GraphicElement
 InheritedscaleZ : Number
The z scale (percentage) of the element as applied from the transform point.
GraphicElement
 Inheritedstroke : IStroke
The stroke used by this element.
StrokedElement
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
GraphicElement
 Inheritedtransform : Transform
GraphicElement
 InheritedtransformX : Number
The x position transform point of the element.
GraphicElement
 InheritedtransformY : Number
The y position transform point of the element.
GraphicElement
 InheritedtransformZ : Number
The z position transform point of the element.
GraphicElement
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
GraphicElement
 Inheritedvisible : Boolean
Controls the visibility of this visual element.
GraphicElement
 Inheritedwidth : Number
The width of the graphic element.
GraphicElement
 Inheritedx : Number
The x position of the graphic element.
GraphicElement
 Inheritedy : Number
The y position of the graphic element.
GraphicElement
 Inheritedz : Number
The z position of the graphic element.
GraphicElement
Protected Properties
 PropertyDefined By
 InheriteddrawnDisplayObject : DisplayObject
[read-only] The actual DisplayObject that is drawn into by the GraphicElement.
GraphicElement
 InheriteddrawX : Number
[read-only] The x position where the element should be drawn.
GraphicElement
 InheriteddrawY : Number
[read-only] The y position where the element should be drawn.
GraphicElement
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the GraphicElement has any non-translation (x,y) transform properties
GraphicElement
 InheritedlayoutFeatures : AdvancedLayoutFeatures
Contain all of the implementation details of how the GraphicElement implements transform and layering support.
GraphicElement
 InheritedneedsDisplayObject : Boolean
[read-only] True if the element requires an exclusive DisplayObject.
GraphicElement
Public Methods
 MethodDefined By
  
Constructor.
Ellipse
 Inherited
Returns true if this IGraphicElement is compatible and can share display objects with the next IGraphicElement in the sequence.
GraphicElement
 Inherited
Returns true if this IGraphicElement is compatible and can share display objects with the previous IGraphicElement in the sequence.
GraphicElement
 Inherited
createDisplayObject():DisplayObject
Creates a new DisplayObject where this IGraphicElement is drawn.
GraphicElement
 Inherited
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array
GraphicElement
 Inherited
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*
GraphicElement
  
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
[override] Returns the x coordinate of the element's bounds at the specified element size.
Ellipse
  
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
[override] Returns the y coordinate of the element's bounds at the specified element size.
Ellipse
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
GraphicElement
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
GraphicElement
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
GraphicElement
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
GraphicElement
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
GraphicElement
 Inherited
Returns the layout transform Matrix3D for this element.
GraphicElement
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
GraphicElement
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
GraphicElement
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
GraphicElement
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
GraphicElement
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
GraphicElement
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
GraphicElement
 Inherited
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the GraphicElement is created using an MXML tag.
GraphicElement
 Inherited
Calling this method results in a call to the elements's validateDisplayList() method before the display list is rendered.
GraphicElement
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
GraphicElement
 Inherited
Calling this method results in a call to the elements's validateProperties() method before the display list is rendered.
GraphicElement
 Inherited
Calling this method results in a call to the elements's validateSize() method before the display list is rendered.
GraphicElement
 Inherited
localToGlobal(point:Point):Point
Converts the point object from the object's (local) coordinates to the Stage (global) coordinates.
GraphicElement
 Inherited
Called by IGraphicElementContainer when an IGraphicElement is added to or removed from the host component.
GraphicElement
 Inherited
setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
GraphicElement
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
GraphicElement
 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.
GraphicElement
 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.
GraphicElement
 Inherited
setMXMLDescriptor(value:Array):void
GraphicElement
 Inherited
setMXMLProperties(value:Array):void
GraphicElement
 Inherited
setSharedDisplayObject(sharedDisplayObject:DisplayObject):Boolean
Determines whether this element can draw itself to the sharedDisplayObject of the sequence.
GraphicElement
 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.
GraphicElement
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
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
 Inherited
Called by the IGraphicElementContainer to redraw this element in its displayObject property.
GraphicElement
 Inherited
Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary.
GraphicElement
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
GraphicElement
 Inherited
Called by the IGraphicElementContainer to validate the size of this element.
GraphicElement
Protected Methods
 MethodDefined By
 Inherited
beginDraw(g:Graphics):void
[override] Set up the drawing for this element.
FilledElement
 Inherited
Determines if the call to the measure() method can be skipped.
GraphicElement
 Inherited
Processes the properties set on the element.
GraphicElement
  
draw(g:Graphics):void
[override] Draw the element.
Ellipse
 Inherited
endDraw(g:Graphics):void
[override] Finalize drawing for this element.
FilledElement
 Inherited
generateMXMLAttributes(data:Array):void
GraphicElement
 Inherited
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void
GraphicElement
 Inherited
generateMXMLObject(document:Object, data:Array):Object
GraphicElement
 Inherited
getStrokeExtents(postLayoutTransform:Boolean = true):Rectangle
Returns the amount of pixels occupied by the stroke on each side of the element's bounds.
GraphicElement
 Inherited
Utility method that notifies the host that this element has changed and needs its layer to be updated.
GraphicElement
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
GraphicElement
 Inherited
measure():void
Calculates the default size of the element.
GraphicElement
 Inherited
Used for the implementation of the ILayoutElement interface, returns the explicit measured height pre-transform.
GraphicElement
 Inherited
Used for the implementation of the ILayoutElement interface, returns the explicit of measured width pre-transform.
GraphicElement
 Inherited
transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Transform the element's size.
GraphicElement
 Inherited
transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Transform the element's size.
GraphicElement
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Draws the element and/or sizes and positions its content.
StrokedElement
Constructor Detail
Ellipse()Constructor
public function Ellipse()

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) — When 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.

Returns
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) — When 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.

Returns
Number — The y coordinate of the element's bounds at the specified element size.
Examples
EllipseExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- EllipseExample.mxml -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark">

    <s:Panel title="Ellipse Graphic Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <s:Graphic horizontalCenter="0" verticalCenter="0">
            <s:Ellipse height="100" width="250">
                <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:Ellipse>
        </s:Graphic>
    </s:Panel>

</s:Application>