Packagecom.degrafa.paint
Classpublic class BitmapFill
InheritanceBitmapFill Inheritance DegrafaObject
ImplementsIBlend, IGraphicsFill, ITransformablePaint

Used to fill an area on screen with a bitmap or other DisplayObject.

Default MXML Propertysource



Public Properties
 PropertyDefined by
  blendMode : String
BitmapFill
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
 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
 InheritedisInitialized : Boolean
DegrafaObject
  lastArgs : Array
[read-only] Provide access to the lastArgs array
BitmapFill
  lastRectangle : Rectangle
[read-only] Provides access to the last rectangle that was relevant for this fill.
BitmapFill
  loadingLocation : LoadingLocation
Optional loadingLocation reference.
BitmapFill
 Inheritedname : String
The name that refers to this object.
DegrafaObject
 InheritedobjectBindings : Array
DegrafaObject
  offsetX : Number
BitmapFill
  offsetXUnit : String
The unit of measure corresponding to offsetX.
BitmapFill
  offsetY : Number
BitmapFill
  offsetYUnit : String
The unit of measure corresponding to offsetY.
BitmapFill
  originX : Number
BitmapFill
  originY : Number
BitmapFill
 Inheritedparent : IDegrafaObject
The current degrafa object parent.
DegrafaObject
  repeatX : String
How the bitmap repeats horizontally.
BitmapFill
  repeatY : String
How the bitmap repeats vertically.
BitmapFill
  requester : IGeometryComposition
[write-only] reference to the requesting geometry
BitmapFill
  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.
BitmapFill
  rotation : Number
The number of degrees to rotate the bitmap.
BitmapFill
  scaleX : Number
The percent to horizontally scale the bitmap when filling, from 0.0 to 1.0.
BitmapFill
  scaleY : Number
The percent to vertically scale the bitmap when filling, from 0.0 to 1.0.
BitmapFill
  smooth : Boolean
A flag indicating whether to smooth the bitmap data when filling with it.
BitmapFill
  source : Object
The source used for the bitmap fill.
BitmapFill
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
  transform : ITransform
Defines the transform object that will be used for altering this bitmapfill object.
BitmapFill
  waiting : Boolean
A support property for binding to in the event of an external loading wait.
BitmapFill
Protected Properties
 PropertyDefined by
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
Public Methods
 MethodDefined by
  
BitmapFill(source:Object = null, loc:LoadingLocation = null)
BitmapFill
 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 bitmap fill.
BitmapFill
 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 bitmap fill.
BitmapFill
 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
Events
 EventSummaryDefined by
 Inherited  DegrafaObject
 Inherited  DegrafaObject
Public Constants
 ConstantDefined by
  NONE : String = "none"
[static]
BitmapFill
  REPEAT : String = "repeat"
[static]
BitmapFill
  SPACE : String = "space"
[static]
BitmapFill
  STRETCH : String = "stretch"
[static]
BitmapFill
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
lastArgsproperty 
lastArgs:Array  [read-only]

Provide access to the lastArgs array

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

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

Implementation
    public function get lastRectangle():Rectangle
loadingLocationproperty 
loadingLocation:LoadingLocation  [read-write]

Optional loadingLocation reference. Only relevant when a subsequent source assignment is made as a url string. Using a LoadingLocation simplifies management of loading from external domains and is required if a crossdomain policy file is not in the default location (web root) and with the default name (crossdomain.xml) In actionscript, a loadingLocation assignment MUST precede a change in the url assigned to the source property If a LoadingLocation is being used, the url assigned to the source property MUST be relative to the base path defined in the LoadingLocation, otherwise loading will fail. If a LoadingLocation is NOT used and the source property assignment is an external domain url, then the crossdomain permissions must exist in the default location and with the default name crossdomain.xml, otherwise loading will fail.

Implementation
    public function get loadingLocation():LoadingLocation
    public function set loadingLocation(value:LoadingLocation):void
offsetXproperty 
offsetX:Number  [read-write]

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]

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.

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

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]

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 bitmap 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 bitmap 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]

reference to the requesting geometry

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;

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

The number of degrees to rotate the bitmap. 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 bitmap when filling, from 0.0 to 1.0. If 1.0, the bitmap 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 bitmap when filling, from 0.0 to 1.0. If 1.0, the bitmap 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 false.

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

Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
sourceproperty 
source:Object  [read-write]

The source used for the bitmap fill. The fill can render from various graphical sources, including the following: A Bitmap or BitmapData instance. A class representing a subclass of DisplayObject. The BitmapFill instantiates the class and creates a bitmap rendering of it. An instance of a DisplayObject. The BitmapFill copies it into a Bitmap for filling. The name of a subclass of DisplayObject. The BitmapFill loads the class, instantiates it, and creates a bitmap rendering of it. An instance of an ExternalBitmapData to be loaded at runtime. A url string to either as a relative url (local domain or with a LoadingLocation) or absolute with no LoadingLocation (see loadingLocation property)

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

Implementation
    public function get source():Object
    public function set source(value:Object):void
transformproperty 
transform:ITransform  [read-write]

Defines the transform object that will be used for altering this bitmapfill 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
waitingproperty 
waiting:Boolean  [read-write]

A support property for binding to in the event of an external loading wait. permits a simple binding to indicate that the wait is over

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

Implementation
    public function get waiting():Boolean
    public function set waiting(value:Boolean):void
Constructor detail
BitmapFill()constructor
public function BitmapFill(source:Object = null, loc:LoadingLocation = null)Parameters
source:Object (default = null)
 
loc:LoadingLocation (default = null)
Method detail
begin()method
public function begin(graphics:Graphics, rc:Rectangle):void

Begins the bitmap fill.

Parameters
graphics:Graphics
 
rc:Rectangle
end()method 
public function end(graphics:Graphics):void

Ends the bitmap fill.

Parameters
graphics:Graphics
Constant detail
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"