Packagecom.degrafa.geometry
Classpublic class Polyline
InheritancePolyline Inheritance Geometry Inheritance DegrafaObject
ImplementsIGeometry

The Polyline element draws a polyline using the specified points.

Default MXML Propertypoints

See also

http://degrafa.com/samples/Polyline_Element.html


Public Properties
 PropertyDefined by
 InheritedautoClearGraphicsTarget : Boolean
When using a graphicsTarget and if this property is set to true the draw phase will clear the graphics context before drawing.
Geometry
  autoClose : Boolean
Specifies if this polyline is to be automatically closed.
Polyline
  bounds : Rectangle
[read-only] The tight bounds of this element as represented by a Rectangle object.
Polyline
  data : String
Polyline short hand data value.
Polyline
  derive : Polyline
[write-only] An object to derive this objects properties from.
Polyline
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
 Inheritedfill : IGraphicsFill
Defines the fill object that will be used for rendering this geometry object.
Geometry
 Inheritedgeometry : Array
A array of IGeometryComposition objects.
Geometry
 InheritedgeometryCollection : GeometryCollection
Access to the Degrafa geometry collection object for this geometry object.
Geometry
 InheritedgraphicsTarget : Array
One or more display object's that this Geometry is to be drawn to.
Geometry
 InheritedgraphicsTargetCollection : DisplayObjectCollection
Access to the Degrafa target collection object for this geometry object.
Geometry
 InheritedhasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
DegrafaObject
 Inheritedid : String
The identifier used by document to refer to this object.
DegrafaObject
 Inheritedinvalidated : Boolean
Specifies whether this object is to be re calculated on the next cycle.
Geometry
 Inheritedname : String
The name that refers to this object.
DegrafaObject
  pointCollection : GraphicPointCollection
[read-only] Access to the Degrafa point collection object for this polyline.
Polyline
  points : Array
A array of points that describe this polyline.
Polyline
 Inheritedstate : String
The state at which to draw this object
Geometry
 InheritedstateEvent : String
The state event at which to draw this object
Geometry
 Inheritedstroke : IGraphicsStroke
Defines the stroke object that will be used for rendering this geometry object.
Geometry
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
  x : Number
The x-coordinate of the upper left point to begin drawing from.
Polyline
  y : Number
The y-coordinate of the upper left point to begin drawing from.
Polyline
Protected Properties
 PropertyDefined by
  commandStack : Array
An Array of flash rendering commands that make up this element.
Polyline
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
Public Methods
 MethodDefined by
  
Polyline(points:Array = null)
Constructor.
Polyline
 Inherited
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.
DegrafaObject
 Inherited
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
DegrafaObject
 Inherited
dispatchPropertyChange(bubbles:Boolean = false, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null):Boolean
Dispatches an property change event into the event flow.
DegrafaObject
  
draw(graphics:Graphics, rc:Rectangle):void
Begins the draw phase for geometry objects.
Polyline
 Inherited
endDraw(graphics:Graphics):void
Ends the draw phase for geometry objects.
Geometry
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
DegrafaObject
 Inherited
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
DegrafaObject
 Inherited
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
DegrafaObject
  
preDraw():void
Performs any pre calculation that is required to successfully render this element.
Polyline
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DegrafaObject
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
DegrafaObject
Events
 EventSummaryDefined by
 Inherited  DegrafaObject
 Inherited  DegrafaObject
Property detail
autoCloseproperty
autoClose:Boolean  [read-write]

Specifies if this polyline is to be automatically closed. If true a line is drawn to the first point.

This property can be used as the source for data binding.

Implementation
    public function get autoClose():Boolean
    public function set autoClose(value:Boolean):void
boundsproperty 
bounds:Rectangle  [read-only]

The tight bounds of this element as represented by a Rectangle object.

This property can be used as the source for data binding.

Implementation
    public function get bounds():Rectangle
commandStackproperty 
protected var commandStack:Array

An Array of flash rendering commands that make up this element.

dataproperty 
data:String  [read-write]

Polyline short hand data value.

The polyline data property expects a list of space seperated points. For example "10,20 30,35".

This property can be used as the source for data binding.

Implementation
    public function get data():String
    public function set data(value:String):void

See also

deriveproperty 
derive:Polyline  [write-only]

An object to derive this objects properties from. When specified this object will derive it's unspecified properties from the passed object.

This property can be used as the source for data binding.

Implementation
    public function set derive(value:Polyline):void
pointCollectionproperty 
pointCollection:GraphicPointCollection  [read-only]

Access to the Degrafa point collection object for this polyline.

This property can be used as the source for data binding.

Implementation
    public function get pointCollection():GraphicPointCollection
pointsproperty 
points:Array  [read-write]

A array of points that describe this polyline.

This property can be used as the source for data binding.

Implementation
    public function get points():Array
    public function set points(value:Array):void
xproperty 
x:Number  [read-write]

The x-coordinate of the upper left point to begin drawing from. If not specified a default value of 0 is used.

This property can be used as the source for data binding.

Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]

The y-coordinate of the upper left point to begin drawing from. If not specified a default value of 0 is used.

This property can be used as the source for data binding.

Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor detail
Polyline()constructor
public function Polyline(points:Array = null)

Constructor.

The polyline constructor accepts 1 optional argument that describes it's points.

Parameters
points:Array (default = null) — An array of points describing this polyline.
Method detail
draw()method
public override function draw(graphics:Graphics, rc:Rectangle):void

Begins the draw phase for geometry objects. All geometry objects override this to do their specific rendering.

Parameters
graphics:Graphics — The current context to draw to.
 
rc:Rectangle — A Rectangle object used for fill bounds.
preDraw()method 
public override function preDraw():void

Performs any pre calculation that is required to successfully render this element. Including bounds calculations and lower level drawing command storage. Each geometry object overrides this and is responsible for it's own pre calculation cycle.