Packagecom.degrafa.paint
Classpublic class VectorFill
InheritanceVectorFill Inheritance DegrafaObject
ImplementsIBlend, IGraphicsFill, ITransformablePaint

Used to fill one Geometry Object with other Degrafa-defined Geometry Objects or compositions

Default MXML Propertysource



Public Properties
 PropertyDefined by
  blendMode : String
VectorFill
  clipSource : Object
Specifies a Geometry object to use as a clipping area for the fill's source geometry when determining the region to be used for the fill.
VectorFill
  disposalLimit : uint
VectorFill
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
  enableBackground : Boolean
Specifies whether to use the solidFillBackGround SolidFill (if set) when rendering
VectorFill
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
  enableFilters : Boolean
Specifies whether to use enable any filters assigned to this Fill
VectorFill
  enableSourceClipping : Boolean
Specifies whether to use a the bounds of the clipSource Geometry object to clip the bounds of the fill from the rendered version of the source Geometry.
VectorFill
  filters : Array
A collection of filters to apply to the geometry source being used for the fill.
VectorFill
 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
  insetFromStroke : Boolean
whether the fillrendering bounds are determined by insetting from half the stroke width of the target or not.
VectorFill
 InheritedisInitialized : Boolean
DegrafaObject
  lastArgs : Array
[read-only] Provide access to the lastArgs array
VectorFill
  lastRectangle : Rectangle
[read-only] Provides access to the last rectangle that was relevant for this fill.
VectorFill
 Inheritedname : String
The name that refers to this object.
DegrafaObject
 InheritedobjectBindings : Array
DegrafaObject
  offsetX : Number
How far the VectorFill is horizontally offset from the origin.
VectorFill
  offsetXUnit : String
The unit of measure corresponding to offsetX.
VectorFill
  offsetY : Number
How far the Geometry is vertically offset from the origin.
VectorFill
  offsetYUnit : String
The unit of measure corresponding to offsetY.
VectorFill
  originX : Number
The horizontal origin for the VectorFill.
VectorFill
  originY : Number
The vertical origin for the VectorFill.
VectorFill
 Inheritedparent : IDegrafaObject
The current degrafa object parent.
DegrafaObject
  repeatX : String
How the Geometry repeats horizontally.
VectorFill
  repeatY : String
How the Geometry repeats vertically.
VectorFill
  requester : IGeometryComposition
[write-only] Used to set a temporary reference to the requesting geometry.
VectorFill
  restartFunction : Function
[read-only] Provides quick access to a cached function for restarting the last used fill either in the last used context, or, if a context is provided as an argument, then to an alternate context.
VectorFill
  rotation : Number
The number of degrees to rotate the Geometry.
VectorFill
  scaleX : Number
The percent to horizontally scale the Geometry when filling, from 0.0 to 1.0.
VectorFill
  scaleY : Number
The percent to vertically scale the Geometry when filling, from 0.0 to 1.0.
VectorFill
  smooth : Boolean
A flag indicating whether to smooth the bitmap data when filling with it.
VectorFill
  solidFillBackground : SolidFill
A SolidFill instance to use when rendering
VectorFill
  source : IGeometryComposition
The source used for the VectorFill.
VectorFill
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
  targetSetting : String
A 'smart'/quick setting for matching fill rendering between source and target.
VectorFill
  targetSettingOptions : Array
[static][read-only] targetSetting options, avalailable as a convenience.
VectorFill
  transform : ITransform
Defines the transform object that will be used for altering this VectorFill object.
VectorFill
Protected Properties
 PropertyDefined by
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
Public Methods
 MethodDefined by
  
Constructor.
VectorFill
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
DegrafaObject
  
begin(graphics:Graphics, rc:Rectangle):void
begins the VectorFill
VectorFill
 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
  
end(graphics:Graphics):void
Ends the Vectorfill for the graphics context.
VectorFill
 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
 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
Protected Methods
 MethodDefined by
  
disposes of older bitmapData generated by this fill, depending on the limit set by disposalLimit
VectorFill
  
geomListener(event:PropertyChangeEvent):void
listener to handle the property changes from the source geometry
VectorFill
Events
 EventSummaryDefined by
 Inherited  DegrafaObject
 Inherited  DegrafaObject
Public Constants
 ConstantDefined by
  CENTER_TO_TARGET : String = "centerToTarget"
[static]
VectorFill
  MATCH_BOUNDS : String = "matchTargetBounds"
[static]
VectorFill
  MATCH_BOUNDS_MAINTAIN_AR : String = "matchTargetBoundsMaintainAspectRatio"
[static]
VectorFill
  NONE : String = "none"
[static]
VectorFill
  REPEAT : String = "repeat"
[static]
VectorFill
  SPACE : String = "space"
[static]
VectorFill
  STRETCH : String = "stretch"
[static]
VectorFill
Property detail
blendModeproperty
blendMode:String  [read-write]

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

Implementation
    public function get blendMode():String
    public function set blendMode(value:String):void
clipSourceproperty 
clipSource:Object  [read-write]

Specifies a Geometry object to use as a clipping area for the fill's source geometry when determining the region to be used for the fill. Requires the enableSourceClipping setting to be enabled to have effect. Accepts a GeometryGroup (DisplayObject) as an alternate source for bounds detection.

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

Implementation
    public function get clipSource():Object
    public function set clipSource(value:Object):void
disposalLimitproperty 
disposalLimit:uint  [read-write]

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

Implementation
    public function get disposalLimit():uint
    public function set disposalLimit(value:uint):void
enableBackgroundproperty 
enableBackground:Boolean  [read-write]

Specifies whether to use the solidFillBackGround SolidFill (if set) when rendering

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

Implementation
    public function get enableBackground():Boolean
    public function set enableBackground(value:Boolean):void
enableFiltersproperty 
enableFilters:Boolean  [read-write]

Specifies whether to use enable any filters assigned to this Fill

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

Implementation
    public function get enableFilters():Boolean
    public function set enableFilters(value:Boolean):void
enableSourceClippingproperty 
enableSourceClipping:Boolean  [read-write]

Specifies whether to use a the bounds of the clipSource Geometry object to clip the bounds of the fill from the rendered version of the source Geometry. If set to true and no clipSource has been assigned to this fill, then this setting is of no effect.

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

Implementation
    public function get enableSourceClipping():Boolean
    public function set enableSourceClipping(value:Boolean):void
filtersproperty 
filters:Array  [read-write]

A collection of filters to apply to the geometry source being used for the fill.

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

Implementation
    public function get filters():Array
    public function set filters(value:Array):void
insetFromStrokeproperty 
insetFromStroke:Boolean  [read-write]

whether the fillrendering bounds are determined by insetting from half the stroke width of the target or not. this setting only has effect when used to fill degrafa target geometry otherwise it is ignored.

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

Implementation
    public function get insetFromStroke():Boolean
    public function set insetFromStroke(value:Boolean):void
lastArgsproperty 
lastArgs:Array  [read-only]

Provide access to the lastArgs array

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

Implementation
    public function get lastArgs():Array
lastRectangleproperty 
lastRectangle:Rectangle  [read-only]

Provides access to the last rectangle that was relevant for this fill.

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

Implementation
    public function get lastRectangle():Rectangle
offsetXproperty 
offsetX:Number  [read-write]

How far the VectorFill is horizontally offset from the origin. This adjustment is performed after rotation and scaling.

The default value is 0.

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

Implementation
    public function get offsetX():Number
    public function set offsetX(value:Number):void
offsetXUnitproperty 
offsetXUnit:String  [read-write]

The unit of measure corresponding to offsetX.

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

Implementation
    public function get offsetXUnit():String
    public function set offsetXUnit(value:String):void
offsetYproperty 
offsetY:Number  [read-write]

How far the Geometry is vertically offset from the origin. This adjustment is performed after rotation and scaling.

The default value is 0.

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

Implementation
    public function get offsetY():Number
    public function set offsetY(value:Number):void
offsetYUnitproperty 
offsetYUnit:String  [read-write]

The unit of measure corresponding to offsetY.

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

Implementation
    public function get offsetYUnit():String
    public function set offsetYUnit(value:String):void
originXproperty 
originX:Number  [read-write]

The horizontal origin for the VectorFill. The VectorFill is offset so that this point appears at the origin. Scaling and rotation of the VectorFill are performed around this point.

The default value is 0.

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

Implementation
    public function get originX():Number
    public function set originX(value:Number):void
originYproperty 
originY:Number  [read-write]

The vertical origin for the VectorFill. The VectorFill is offset so that this point appears at the origin. Scaling and rotation of the rendered Geometry are performed around this point.

The default value is 0.

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

Implementation
    public function get originY():Number
    public function set originY(value:Number):void
repeatXproperty 
repeatX:String  [read-write]

How the Geometry repeats horizontally. Valid values are "none", "repeat", "space", and "stretch".

The default value is "repeat".

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

Implementation
    public function get repeatX():String
    public function set repeatX(value:String):void
repeatYproperty 
repeatY:String  [read-write]

How the Geometry repeats vertically. Valid values are "none", "repeat", "space", and "stretch".

The default value is "repeat".

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

Implementation
    public function get repeatY():String
    public function set repeatY(value:String):void
requesterproperty 
requester:IGeometryComposition  [write-only]

Used to set a temporary reference to the requesting geometry. Mainly for internal use, for transform and layout 'inheritance' by this fill.

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

Implementation
    public function set requester(value:IGeometryComposition):void
restartFunctionproperty 
restartFunction:Function  [read-only]

Provides quick access to a cached function for restarting the last used fill either in the last used context, or, if a context is provided as an argument, then to an alternate context. If no last used context is available then this will do nothing;

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

Implementation
    public function get restartFunction():Function
rotationproperty 
rotation:Number  [read-write]

The number of degrees to rotate the Geometry. Valid values range from 0.0 to 360.0.

The default value is 0.

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

Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
scaleXproperty 
scaleX:Number  [read-write]

The percent to horizontally scale the Geometry when filling, from 0.0 to 1.0. If 1.0, the Geometry is filled at its natural size.

The default value is 1.0.

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

Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [read-write]

The percent to vertically scale the Geometry when filling, from 0.0 to 1.0. If 1.0, the Geometry is filled at its natural size.

The default value is 1.0.

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

Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
smoothproperty 
smooth:Boolean  [read-write]

A flag indicating whether to smooth the bitmap data when filling with it.

The default value is true.

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

Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
solidFillBackgroundproperty 
solidFillBackground:SolidFill  [read-write]

A SolidFill instance to use when rendering

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

Implementation
    public function get solidFillBackground():SolidFill
    public function set solidFillBackground(value:SolidFill):void
sourceproperty 
source:IGeometryComposition  [read-write]

The source used for the VectorFill. An IGeometryComposition object

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

Implementation
    public function get source():IGeometryComposition
    public function set source(value:IGeometryComposition):void
targetSettingproperty 
targetSetting:String  [read-write]

A 'smart'/quick setting for matching fill rendering between source and target. Using this setting overrides - or more precisely, ignores - most of the manual settings applied to the fill. Using 'none' enables all the regular manual settings

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

Implementation
    public function get targetSetting():String
    public function set targetSetting(value:String):void
targetSettingOptionsproperty 
targetSettingOptions:Array  [read-only]

targetSetting options, avalailable as a convenience.

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

Implementation
    public static function get targetSettingOptions():Array
transformproperty 
transform:ITransform  [read-write]

Defines the transform object that will be used for altering this VectorFill object.

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

Implementation
    public function get transform():ITransform
    public function set transform(value:ITransform):void
Constructor detail
VectorFill()constructor
public function VectorFill(source:IGeometryComposition = null)

Constructor. Accepts an optional reference to the source Geometry composition to be used to define what this VectorFill renders.

Parameters
source:IGeometryComposition (default = null)
Method detail
begin()method
public function begin(graphics:Graphics, rc:Rectangle):void

begins the VectorFill

Parameters
graphics:Graphics
 
rc:Rectangle
disposeBitmapData()method 
protected function disposeBitmapData():void

disposes of older bitmapData generated by this fill, depending on the limit set by disposalLimit

end()method 
public function end(graphics:Graphics):void

Ends the Vectorfill for the graphics context.

Parameters
graphics:Graphics
geomListener()method 
protected function geomListener(event:PropertyChangeEvent):void

listener to handle the property changes from the source geometry

Parameters
event:PropertyChangeEvent
Constant detail
CENTER_TO_TARGETconstant
public static const CENTER_TO_TARGET:String = "centerToTarget"
MATCH_BOUNDSconstant 
public static const MATCH_BOUNDS:String = "matchTargetBounds"
MATCH_BOUNDS_MAINTAIN_ARconstant 
public static const MATCH_BOUNDS_MAINTAIN_AR:String = "matchTargetBoundsMaintainAspectRatio"
NONEconstant 
public static const NONE:String = "none"
REPEATconstant 
public static const REPEAT:String = "repeat"
SPACEconstant 
public static const SPACE:String = "space"
STRETCHconstant 
public static const STRETCH:String = "stretch"