Packagecom.degrafa.geometry
Classpublic class RasterImage
InheritanceRasterImage Inheritance Geometry Inheritance DegrafaObject
ImplementsIDisplayObjectProxy

The RasterImage element draws a Bitmap Rectangle to the drawing target.

RasterImage represents a bitmap image that can be part of a geometry composition with behavior similar to a regular geometry object. The source of the image mirrors the flexibility provided by the paint BitmapFill object, including the possibility of externally loaded iamges.



Public Properties
 PropertyDefined by
 Inheritedalpha : Number
The alpha setting that applies to this object.
Geometry
 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
 Inheritedbottom : Number
When set, the bottom of the layout will be located offset from the bottom of it's parent.
Geometry
  bounds : Rectangle
[read-only] The tight bounds of this element as represented by a Rectangle object.
RasterImage
 InheritedclippingRectangle : Rectangle
A clipping rectangle to use when rendering this geometry.
Geometry
 InheritedcommandStack : CommandStack
Provides access to the command stack.
Geometry
 InheritedcurrentState : String
The current view state.
Geometry
 InheriteddecoratorCollection : DecoratorCollection
Access to the Decorator collection object for this Geometry object.
Geometry
 Inheriteddecorators : Array
A array of IDecorator objects to be applied on this Geometry.
Geometry
  displayObject : DisplayObject
[read-only] Returns this objects displayObject.
RasterImage
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
 Inheritedfilters : Array
An array of BitmapFilter objects applied to this Geometry.
Geometry
 InheritedgeometricLength : Number
Returns geometric length of this 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
 InheritedhasDecorators : Boolean
Returns true if this Geometry has decorators.
Geometry
 InheritedhasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
DegrafaObject
 InheritedhasFilters : Boolean
Returns true if this Geometry has filters.
Geometry
 InheritedhasLayout : Boolean
Returns true if this Geometry has layout.
Geometry
 InheritedhasStates : Boolean
Returns true if this Geometry has states.
Geometry
 InheritedhasTriggers : Boolean
Returns true if this Geometry has triggers.
Geometry
  height : Number
The height of the regular rectangle.
RasterImage
 InheritedhorizontalCenter : Number
When set, if left or right is not set, the layout will be centered horizontally offset by the numeric value of this property.
Geometry
 Inheritedid : String
The identifier used by document to refer to this object.
DegrafaObject
 InheritedIGraphicParent : IGraphic
Geometry
 InheritedinheritFill : Boolean
If set to true and no fill is defined and there is a parent object then this object will walk up through the parents to retrive a fill object.
Geometry
 InheritedinheritStroke : Boolean
If set to true and no stroke is defined and there is a parent object then this object will walk up through the parents to retrive a stroke object.
Geometry
 Inheritedinvalidated : Boolean
Specifies whether this object is to be re calculated on the next cycle.
Geometry
 InheritedisInitialized : Boolean
DegrafaObject
 InheritedisInvalidated : Boolean
Returns true if this Geometry object is invalidated
Geometry
 InheritedisRootGeometry : Boolean
Returns true if this Geometry object is a root Geometry Object.
Geometry
 InheritedlayoutConstraint : LayoutConstraint
The layout constraint that is used for positioning/sizing this geometry object.
Geometry
 Inherited_layoutMatrix : Matrix
Access to the layout matrix if this Geometry has layout.
Geometry
  layoutMode : String
[read-only] The layout mode associated with this IDisplayObjectProxy.
RasterImage
 InheritedlayoutRectangle : Rectangle
Returns the constraint based layout rectangle for this object or bounds if no layout constraint is specified.
Geometry
 Inheritedleft : Number
When set, the left of the layout will be located offset by the value of this property multiplied by the containing width.
Geometry
  loadingLocation : LoadingLocation
Optional loadingLocation reference.
RasterImage
 InheritedmaintainAspectRatio : Boolean
When true, the size of the layout will always maintain an aspect ratio relative to the ratio of the current width and height properties, even if those properties are not in control of the height and width of the layout.
Geometry
 Inheritedmask : IGeometryComposition
A separate geometry object to use as a mask when rendering this geometry.
Geometry
 InheritedmaskMode : String
The mode used when this object is being masked by the geometry assigned to the mask property.
Geometry
 InheritedmaskSpace : String
The coordinate space within which the referenced mask geometry is rendered before being applied as a mask (respecting maskMode) to this object.
Geometry
 InheritedmaxHeight : Number
The maximum height that can be applied to the layout.
Geometry
 InheritedmaxWidth : Number
The maximum width that can be applied to the layout.
Geometry
 InheritedmaxX : Number
The maximum x location that can be applied to the layout.
Geometry
 InheritedmaxY : Number
The maximum y location that can be applied to the layout.
Geometry
 InheritedminHeight : Number
The minimum height that can be applied to the layout.
Geometry
 InheritedminWidth : Number
The minimum width that can be applied to the layout.
Geometry
 InheritedminX : Number
The minimum x location that can be applied to the layout.
Geometry
 InheritedminY : Number
The minimum y location that can be applied to the layout.
Geometry
 Inheritedname : String
The name that refers to this object.
DegrafaObject
 InheritedobjectBindings : Array
DegrafaObject
 Inheritedparent : IDegrafaObject
The current degrafa object parent.
DegrafaObject
 InheritedpercentHeight : Number
When set, the height of the layout will be set as the value of this property multiplied by the containing height.
Geometry
 InheritedpercentWidth : Number
When set, the width of the layout will be set as the value of this property multiplied by the containing width.
Geometry
 Inheritedright : Number
When set, the right of the layout will be located offset by the value of this property multiplied by the containing width.
Geometry
 InheritedscaleOnLayout : Boolean
When using layout this flag will determine if you want Scale to be applied to fit layout rules
Geometry
  source : Object
[write-only]
RasterImage
  sprite : Sprite
RasterImage
 Inheritedstate : String
The state at which to draw this object.
Geometry
 InheritedstateEvent : String
The state event at which to draw this object.
Geometry
 Inheritedstates : Array
An array of states defined for this Geometry.
Geometry
 Inheritedstroke : IGraphicsStroke
Defines the stroke object that will be used for rendering this geometry object.
Geometry
 InheritedstyleName : Object
The css style name associated with this Geometry.
Geometry
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
 InheritedtargetCoordinateSpace : DisplayObject
The display object that defines the coordinate system to use.
Geometry
 Inheritedtop : Number
When set, the top of the layout will be located offset from the top of it's parent.
Geometry
 Inheritedtransform : ITransform
Defines the transform object that will be used for rendering this geometry object.
Geometry
  transformBeforeRender : Boolean
A setting to determine at what point transforms are performed when capturing the bitmap representation of this object internally before final rendering.
RasterImage
 InheritedtransformBounds : Rectangle
Returns a transformed version of this objects bounds as represented by a Rectangle.
Geometry
 InheritedtransformContext : Matrix
A reference to the transformation matrix context within which local transforms will be applied.
Geometry
 Inheritedtriggers : Array
An array of ITrigger objects that this Geometry object will use.
Geometry
 InheritedverticalCenter : Number
When set, if top or bottom is not set, the layout will be centered vertically offset by the numeric value of this property.
Geometry
 Inheritedvisible : Boolean
Controls the visibility of this geometry object.
Geometry
  waiting : Boolean
RasterImage
  width : Number
The width of the regular rectangle.
RasterImage
  x : Number
The x-axis coordinate of the upper left point of the regular rectangle.
RasterImage
  y : Number
The y-axis coordinate of the upper left point of the regular rectangle.
RasterImage
Protected Properties
 PropertyDefined by
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
 Inherited_fill : IGraphicsFill
Geometry
 Inherited_stroke : IGraphicsStroke
Geometry
Public Methods
 MethodDefined by
  
Constructor.
RasterImage
 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
 Inherited
angleAt(t:Number):Number
Returns the angle of a point t(0-1) on the path.
Geometry
  
calculateLayout(childBounds:Rectangle = null):void
Performs the specific layout work required by this Geometry.
RasterImage
 Inherited
Clears all graphics targets specified in the graphicsTarget array.
Geometry
 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/IDisplayObjectProxy objects.
RasterImage
 Inherited
Requests a draw for each graphics target specified in the graphicsTarget array.
Geometry
 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
initFill(graphics:Graphics, rc:Rectangle):void
Initialise the fill for this geometry object.
Geometry
 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
initStroke(graphics:Graphics, rc:Rectangle):void
Initialise the stroke for this geometry object.
Geometry
 Inherited
pointAt(t:Number):Point
Returns the point at t(0-1) on this object.
Geometry
  
preDraw():void
Performs any pre calculation that is required to successfully render this element.
RasterImage
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DegrafaObject
 Inherited
styleChanged(styleProp:String):void
Called when the value of a style property is changed.
Geometry
 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
 Inherited
propertyChangeHandler(event:PropertyChangeEvent):void
Principle event handler for any property changes to a geometry object or it's child objects.
Geometry
Events
 EventSummaryDefined by
 Inherited  DegrafaObject
 Inherited  DegrafaObject
Property detail
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
displayObjectproperty 
displayObject:DisplayObject  [read-only]

Returns this objects displayObject.

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

Implementation
    public function get displayObject():DisplayObject
heightproperty 
height:Number  [read-write]

The height of the regular rectangle.

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

Implementation
    public function get height():Number
    public function set height(value:Number):void
layoutModeproperty 
layoutMode:String  [read-only]

The layout mode associated with this IDisplayObjectProxy. For an image this is always scale only.

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

Implementation
    public function get layoutMode():String
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.

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

Implementation
    public function get loadingLocation():LoadingLocation
    public function set loadingLocation(value:LoadingLocation):void
sourceproperty 
source:Object  [write-only]

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

Implementation
    public function set source(value:Object):void
spriteproperty 
public var sprite:Sprite
transformBeforeRenderproperty 
transformBeforeRender:Boolean  [read-write]

A setting to determine at what point transforms are performed when capturing the bitmap representation of this object internally before final rendering. Unless otherwise needed, the default setting of false uses less memory.

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

Implementation
    public function get transformBeforeRender():Boolean
    public function set transformBeforeRender(value:Boolean):void
waitingproperty 
waiting:Boolean  [read-write]

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

Implementation
    public function get waiting():Boolean
    public function set waiting(value:Boolean):void
widthproperty 
width:Number  [read-write]

The width of the regular rectangle.

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

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

The x-axis coordinate of the upper left point of the regular rectangle. 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-axis coordinate of the upper left point of the regular rectangle. 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
RasterImage()constructor
public function RasterImage()

Constructor.

The RasterImage constructor has no arguments . RasterImage does not inherit stroke by default unlike other Geometry items.

Method detail
calculateLayout()method
public override function calculateLayout(childBounds:Rectangle = null):void

Performs the specific layout work required by this Geometry.

Parameters
childBounds:Rectangle (default = null) — the bounds to be layed out. If not specified a rectangle of (0,0,1,1) is used or the most appropriate size is calculated.
draw()method 
public override function draw(graphics:Graphics, rc:Rectangle):void

Begins the draw phase for geometry/IDisplayObjectProxy 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.