Packagespark.components.itemRenderers
Classpublic class MobileGridBitmapCellRenderer
InheritanceMobileGridBitmapCellRenderer Inheritance BitmapImage Inheritance GraphicElement Inheritance flash.events.EventDispatcher
Implements IMobileGridCellRenderer

Language Version : ActionScript 3.0
Product Version : Flex 4.11
Runtime Versions : AIR 3.8

This class is experimental, which means it has not been tested or documented as thoroughly as other core Apache Flex classes.

Default lightweight class for rendering embedded Bitmaps or Multi-DPI Bitmaps in a MobileGrid cell . ou define the icon to be used in each cell by setting either iconField or iconFunction properties.



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
 InheritedbitmapData : BitmapData
[read-only] Returns a copy of the BitmapData object representing the currently loaded image content (unscaled).
BitmapImage
 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
 InheritedbytesLoaded : Number
[read-only] The number of bytes of the image already loaded.
BitmapImage
 InheritedbytesTotal : Number
[read-only] The total image data in bytes loaded or pending load.
BitmapImage
  canSetContentHeight : Boolean
[read-only] Returns false to avoid any density scaling artifacts.
MobileGridBitmapCellRenderer
  canSetContentWidth : Boolean
[read-only] Returns false to avoid any density scaling artifacts.
MobileGridBitmapCellRenderer
 InheritedclearOnLoad : Boolean
Denotes whether or not to clear previous image content prior to loading new content.
BitmapImage
 InheritedcontentLoader : IContentLoader
Optional custom image loader (e.g.
BitmapImage
 InheritedcontentLoaderGrouping : String
Optional content grouping identifier to pass to the an associated IContentLoader instance's load() method.
BitmapImage
  cssStyleName : String
[write-only] this property is set with the GridColumn's styleName property.
MobileGridBitmapCellRenderer
  data : Object
The data to render or edit.
MobileGridBitmapCellRenderer
 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
 InheritedfillMode : String
Determines how the bitmap fills in the dimensions.
BitmapImage
 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
 InheritedhorizontalAlign : String
The horizontal alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to mx.graphics.BitmapScaleMode.LETTERBOX.
BitmapImage
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
GraphicElement
  iconField : String
The name of the field or property in the DataGrid's dataProvider item that defines the icon to display for this renderer's column.
MobileGridBitmapCellRenderer
  iconFunction : Function
An user-provided function that converts a data provider item into an icon to display in each cell for this renderer's column.
MobileGridBitmapCellRenderer
 Inheritedid : String
The identity of the component.
GraphicElement
 InheritedAIR-only imageDecodingPolicy : String = onDemand
The image decoding policy, set to ON_DEMAND or ON_LOAD.
BitmapImage
 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
 InheritedpreliminaryHeight : Number
Provides an estimate to use for height when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading.
BitmapImage
 InheritedpreliminaryWidth : Number
Provides an estimate to use for width when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading.
BitmapImage
 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
 InheritedscaleMode : String
Determines how the image is scaled when fillMode is set to mx.graphics.BitmapFillMode.SCALE.
BitmapImage
 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
 Inheritedsmooth : Boolean
BitmapImage
 InheritedsmoothingQuality : String
Determines how the image is down-scaled.
BitmapImage
 Inheritedsource : Object
The source used for the bitmap fill.
BitmapImage
 InheritedsourceHeight : Number
[read-only] Provides the unscaled height of the original image data.
BitmapImage
 InheritedsourceWidth : Number
[read-only] Provides the unscaled width of the original image data.
BitmapImage
  styleProvider : IStyleClient
[write-only]
MobileGridBitmapCellRenderer
 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
 InheritedtrustedSource : Boolean
[read-only] A read-only flag denoting whether the currently loaded content is considered loaded form a source whose security policy allows for cross domain image access.
BitmapImage
 InheritedverticalAlign : String
The vertical alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to mx.graphics.BitmapScaleMode.LETTERBOX.
BitmapImage
 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
  _data : Object
MobileGridBitmapCellRenderer
 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
  
MobileGridBitmapCellRenderer
 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
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
GraphicElement
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
GraphicElement
 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
Determines if the call to the measure() method can be skipped.
GraphicElement
 Inherited
[override] Processes the properties set on the element.
BitmapImage
 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
[override] Calculates the default size of the element.
BitmapImage
 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.
BitmapImage
Events
 Event Summary Defined By
 InheritedDispatched when content loading is complete.BitmapImage
 InheritedDispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code.BitmapImage
 InheritedDispatched when an input/output error occurs.BitmapImage
 InheritedDispatched when content is loading.BitmapImage
 InheritedDispatched when content loading is complete.BitmapImage
 InheritedDispatched when a security error occurs.BitmapImage
Public Constants
 ConstantDefined By
 InheritedON_DEMAND : String = onDemand
[static] Specifies that the image being loaded will be decoded when needed.
BitmapImage
 InheritedON_LOAD : String = onLoad
[static] Specifies that the image being loaded will be decoded on load.
BitmapImage
Property Detail
_dataproperty
protected var _data:Object

canSetContentHeightproperty 
canSetContentHeight:Boolean  [read-only]

Returns false to avoid any density scaling artifacts. Flag indicating whether the layout manager can stretch the height of this renderer to match the column's height.

default value is false. Override the getter to return a difference value


Implementation
    public function get canSetContentHeight():Boolean
canSetContentWidthproperty 
canSetContentWidth:Boolean  [read-only]

Returns false to avoid any density scaling artifacts. Flag indicating whether the layout manager can stretch the width of this renderer to match the column's width.

default value is false. Override the getter to return a difference value


Implementation
    public function get canSetContentWidth():Boolean
cssStyleNameproperty 
cssStyleName:String  [write-only]

this property is set with the GridColumn's styleName property.

you can override it to extract information from the style and pass them to this renderer.


Implementation
    public function set cssStyleName(value:String):void
dataproperty 
data:Object

The data to render or edit.


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

The name of the field or property in the DataGrid's dataProvider item that defines the icon to display for this renderer's column.

The field value must be either an embedded bitmap's class, or a MultiBitmapSource object.

If not set, then iconFunction will be used.

The default value is null.


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

See also

iconFunctionproperty 
iconFunction:Function

An user-provided function that converts a data provider item into an icon to display in each cell for this renderer's column.

if set, this property is used even if iconField is also set.

The function specified to the iconFunction property must have the following signature:

iconFunction(item:Object):Object

The item parameter is the data provider item for an entire row.

The function must return either an embedded bitmap's class, or a MultiBitmapSource object .

The default value is null.


Implementation
    public function get iconFunction():Function
    public function set iconFunction(value:Function):void

See also

styleProviderproperty 
styleProvider:IStyleClient  [write-only]


Implementation
    public function set styleProvider(value:IStyleClient):void
Constructor Detail
MobileGridBitmapCellRenderer()Constructor
public function MobileGridBitmapCellRenderer()