Package | spark.components.itemRenderers |
Class | public class MobileGridBitmapCellRenderer |
Inheritance | MobileGridBitmapCellRenderer BitmapImage GraphicElement 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. |
Property | Defined By | ||
---|---|---|---|
alpha : Number
The level of transparency of the graphic element. | GraphicElement | ||
alwaysCreateDisplayObject : Boolean
Specifies that this GraphicElement is to be associated with and be rendered
to its own DisplayObject. | GraphicElement | ||
baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | GraphicElement | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | GraphicElement | ||
bitmapData : BitmapData [read-only]
Returns a copy of the BitmapData object representing
the currently loaded image content (unscaled). | BitmapImage | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | GraphicElement | ||
bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | GraphicElement | ||
bytesLoaded : Number [read-only]
The number of bytes of the image already loaded. | BitmapImage | ||
bytesTotal : 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 | ||
clearOnLoad : Boolean
Denotes whether or not to clear previous
image content prior to loading new content. | BitmapImage | ||
contentLoader : IContentLoader
Optional custom image loader (e.g. | BitmapImage | ||
contentLoaderGrouping : 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 | ||
depth : Number
Determines the order in which items inside of containers
are rendered. | GraphicElement | ||
designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | GraphicElement | ||
displayObject : DisplayObject [read-only]
The shared DisplayObject where this
IGraphicElement is drawn. | GraphicElement | ||
displayObjectSharingMode : String
Indicates the association between this IGraphicElement and its
display objects. | GraphicElement | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | GraphicElement | ||
explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | GraphicElement | ||
explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | GraphicElement | ||
explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | GraphicElement | ||
explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | GraphicElement | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | GraphicElement | ||
fillMode : String
Determines how the bitmap fills in the dimensions. | BitmapImage | ||
filters : Array
An indexed array that contains each filter object currently associated with the graphic element. | GraphicElement | ||
hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | GraphicElement | ||
height : Number
The height of the graphic element. | GraphicElement | ||
horizontalAlign : 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 | ||
horizontalCenter : 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 | ||
id : String
The identity of the component. | GraphicElement | ||
imageDecodingPolicy : String = onDemand
The image decoding policy, set to ON_DEMAND or ON_LOAD. | BitmapImage | ||
includeInLayout : Boolean
Specifies whether this element is included in the layout of the parent. | GraphicElement | ||
is3D : Boolean [read-only]
Contains true when the element is in 3D. | GraphicElement | ||
layoutDirection : 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 | ||
left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | GraphicElement | ||
luminosityClip : Boolean
A property that controls whether the luminosity
mask clips the masked content. | GraphicElement | ||
luminosityInvert : Boolean
A property that controls the calculation of the RGB
color value of a graphic element being masked by
a luminosity mask. | GraphicElement | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | GraphicElement | ||
maskType : 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 | ||
maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | GraphicElement | ||
maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | GraphicElement | ||
measuredHeight : Number
The default height of the component, in pixels. | GraphicElement | ||
measuredWidth : Number
The default width of the component, in pixels. | GraphicElement | ||
measuredX : Number
The default measured bounds top-left corner relative to the origin of the element. | GraphicElement | ||
measuredY : Number
The default measured bounds top-left corner relative to the origin of the element. | GraphicElement | ||
minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | GraphicElement | ||
minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | GraphicElement | ||
MXMLDescriptor : Array [read-only] | GraphicElement | ||
MXMLProperties : Array [read-only] | GraphicElement | ||
owner : DisplayObjectContainer
The owner of this IVisualElement object. | GraphicElement | ||
parent : DisplayObjectContainer [read-only]
The parent container or component for this component. | GraphicElement | ||
percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | GraphicElement | ||
percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | GraphicElement | ||
postLayoutTransformOffsets : 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 | ||
preliminaryHeight : 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 | ||
preliminaryWidth : 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 | ||
right : Object
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | GraphicElement | ||
rotation : Number
Indicates the rotation of the element, in degrees,
from the transform point. | GraphicElement | ||
rotationX : Number
Indicates the x-axis rotation of the element instance, in degrees, from its original orientation
relative to the 3D parent container. | GraphicElement | ||
rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | GraphicElement | ||
rotationZ : Number
Indicates the rotation of the element, in degrees,
from the transform point. | GraphicElement | ||
scaleMode : String
Determines how the image is scaled when fillMode is set to
mx.graphics.BitmapFillMode.SCALE. | BitmapImage | ||
scaleX : Number
The horizontal scale (percentage) of the element
as applied from the transform point. | GraphicElement | ||
scaleY : Number
The vertical scale (percentage) of the element
as applied from the transform point. | GraphicElement | ||
scaleZ : Number
The z scale (percentage) of the element
as applied from the transform point. | GraphicElement | ||
smooth : Boolean | BitmapImage | ||
smoothingQuality : String
Determines how the image is down-scaled. | BitmapImage | ||
source : Object
The source used for the bitmap fill. | BitmapImage | ||
sourceHeight : Number [read-only]
Provides the unscaled height of the original image data. | BitmapImage | ||
sourceWidth : Number [read-only]
Provides the unscaled width of the original image data. | BitmapImage | ||
styleProvider : IStyleClient [write-only]
| MobileGridBitmapCellRenderer | ||
top : Object
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | GraphicElement | ||
transform : Transform | GraphicElement | ||
transformX : Number
The x position transform point of the element. | GraphicElement | ||
transformY : Number
The y position transform point of the element. | GraphicElement | ||
transformZ : Number
The z position transform point of the element. | GraphicElement | ||
trustedSource : 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 | ||
verticalAlign : 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 | ||
verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | GraphicElement | ||
visible : Boolean
Controls the visibility of this visual element. | GraphicElement | ||
width : Number
The width of the graphic element. | GraphicElement | ||
x : Number
The x position of the graphic element. | GraphicElement | ||
y : Number
The y position of the graphic element. | GraphicElement | ||
z : Number
The z position of the graphic element. | GraphicElement |
Property | Defined By | ||
---|---|---|---|
_data : Object | MobileGridBitmapCellRenderer | ||
drawnDisplayObject : DisplayObject [read-only]
The actual DisplayObject that is drawn into by the GraphicElement. | GraphicElement | ||
drawX : Number [read-only]
The x position where the element should be drawn. | GraphicElement | ||
drawY : Number [read-only]
The y position where the element should be drawn. | GraphicElement | ||
hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the GraphicElement has any non-translation (x,y) transform properties
| GraphicElement | ||
layoutFeatures : AdvancedLayoutFeatures
Contain all of the implementation details of how the GraphicElement implements
transform and layering support. | GraphicElement | ||
needsDisplayObject : Boolean [read-only]
True if the element requires an exclusive DisplayObject. | GraphicElement |
Method | Defined By | ||
---|---|---|---|
MobileGridBitmapCellRenderer | |||
canShareWithNext(element:IGraphicElement):Boolean
Returns true if this IGraphicElement is compatible and can
share display objects with the next IGraphicElement
in the sequence. | GraphicElement | ||
canShareWithPrevious(element:IGraphicElement):Boolean
Returns true if this IGraphicElement is compatible and can
share display objects with the previous IGraphicElement
in the sequence. | GraphicElement | ||
createDisplayObject():DisplayObject
Creates a new DisplayObject where this IGraphicElement
is drawn. | GraphicElement | ||
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | GraphicElement | ||
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | GraphicElement | ||
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | GraphicElement | ||
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | GraphicElement | ||
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | GraphicElement | ||
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | GraphicElement | ||
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | GraphicElement | ||
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | GraphicElement | ||
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | GraphicElement | ||
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | GraphicElement | ||
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | GraphicElement | ||
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | GraphicElement | ||
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | GraphicElement | ||
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | GraphicElement | ||
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | GraphicElement | ||
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | GraphicElement | ||
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the GraphicElement
is created using an MXML tag. | GraphicElement | ||
invalidateDisplayList():void
Calling this method results in a call to the elements's
validateDisplayList() method
before the display list is rendered. | GraphicElement | ||
invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | GraphicElement | ||
invalidateProperties():void
Calling this method results in a call to the elements's
validateProperties() method
before the display list is rendered. | GraphicElement | ||
invalidateSize():void
Calling this method results in a call to the elements's
validateSize() method
before the display list is rendered. | GraphicElement | ||
localToGlobal(point:Point):Point
Converts the point object from the object's (local) coordinates
to the Stage (global) coordinates. | GraphicElement | ||
parentChanged(value:IGraphicElementContainer):void
Called by IGraphicElementContainer when an IGraphicElement
is added to or removed from the host component. | GraphicElement | ||
setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | GraphicElement | ||
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | GraphicElement | ||
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 | ||
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 | ||
setMXMLDescriptor(value:Array):void | GraphicElement | ||
setMXMLProperties(value:Array):void | GraphicElement | ||
setSharedDisplayObject(sharedDisplayObject:DisplayObject):Boolean
Determines whether this element can draw itself to the
sharedDisplayObject of the sequence. | GraphicElement | ||
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 | ||
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 | ||
validateDisplayList():void
Called by the IGraphicElementContainer to redraw this element
in its displayObject property. | GraphicElement | ||
validateNow():void
Validates and updates the properties and layout of this object
by immediately calling validateProperties(),
validateSize(), and validateDisplayList(),
if necessary. | GraphicElement | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | GraphicElement | ||
validateSize():void
Called by the IGraphicElementContainer to validate the size of
this element. | GraphicElement |
_data | property |
protected var _data:Object
canSetContentHeight | property |
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
public function get canSetContentHeight():Boolean
canSetContentWidth | property |
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
public function get canSetContentWidth():Boolean
cssStyleName | property |
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.
public function set cssStyleName(value:String):void
data | property |
data:Object
The data to render or edit.
public function get data():Object
public function set data(value:Object):void
iconField | property |
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
.
public function get iconField():String
public function set iconField(value:String):void
See also
iconFunction | property |
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
.
public function get iconFunction():Function
public function set iconFunction(value:Function):void
See also
styleProvider | property |
styleProvider:IStyleClient
[write-only]
public function set styleProvider(value:IStyleClient):void
MobileGridBitmapCellRenderer | () | Constructor |
public function MobileGridBitmapCellRenderer()