Packagefr.kapit.pictogram.base
Classpublic class PictogramCell
InheritancePictogramCell Inheritance spark.components.supportClasses.SkinnableComponent

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

PictogramCell is a base component that displays the content of any data entry on the Pictogram component. In the Pictogram, there is one cell per data entry. Each cell handles its appearence via its skin.

A default skin is provided. It contains a group with the pictogram elements, the cell value, the cell description and its pictorial symbol. Theses elements are layouted via a specific layout and can be visible or not according to the parameters specified in the Pictogram

Any skin for each cell, must contain a unitsGrid where the pictogram elements are added and layouted. other skin parts are optional and can be visually modified according to the data content and to the skin specifications.

See also

fr.kapit.pictogram.Pictogram
fr.kapit.pictogram.skins.PictogramCellSkin


Public Properties
 PropertyDefined By
  cellLayoutChanged : Boolean
Flag indicating that cell grid layout should be updated.
PictogramCell
  dataChanged : Boolean
Flag indicating that cell data has been changed and skin parts should be updated.
PictogramCell
  gridChanged : Boolean
Flag indicating that cell grid rendering should be updated.
PictogramCell
  gridManager : PictogramManager
Manager of this cell performing update and logic operations.
PictogramCell
  height : Number
[override] [write-only]
PictogramCell
  item : Object
Cell data containing the statistic value and other information.
PictogramCell
  percentageChanged : Boolean
Flag indicating that cell percentage has changed and grid units should be updated accordingly.
PictogramCell
  pictogramChart : PictogramChart
The Pictogram instance, owner of this cell.
PictogramCell
  ratioX : Number
Cell ratio at X.
PictogramCell
  ratioY : Number
Cell ratio at Y.
PictogramCell
  unitStyleChanged : Boolean
Flag indicating that cell units style has been invalidated and should be updated.
PictogramCell
  width : Number
[override] [write-only]
PictogramCell
Protected Properties
 PropertyDefined By
  _gridInitialized : Boolean = false
Flag indicating of the unitsGrid skin part has been initialized.
PictogramCell
Public Methods
 MethodDefined By
  
Constructor.
PictogramCell
Protected Methods
 MethodDefined By
  
Updates unitsGrid layout in the case where no custom skin is used.
PictogramCell
  
commitData():void
Injects information on the different skin parts via data mapping pictogramChart properties.
PictogramCell
  
commitGrid():void
Handles grid units creation and rendering.
PictogramCell
  
Handles grid units percentage visual coding.
PictogramCell
  
[override]
PictogramCell
  
Updates cell units visual styles.
PictogramCell
  
[override]
PictogramCell
  
Inits grid manager leading with all update and logic operations.
PictogramCell
  
partAdded(partName:String, instance:Object):void
[override]
PictogramCell
  
unitsGrid_creationCompleteHandler(event:FlexEvent):void
Handles unitsGrid skin part creation by creating units, adding them to it and validating all visual aspects from which it depends.
PictogramCell
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
PictogramCell
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
metaDataLabel:spark.components.supportClasses.TextBase
Required: false Part Type: Static
A skin part where a label, with a description of the cell, is displayed. In the default cell Skin PictogramCellSkin, the label is placed at the bottom right of the units grid, just below the symbol area and scaled to fit the left space by the units grid and the bottom space left by the units grid . This skin part is hidden if no metaDataField in the Pictogram is displayed.
PictogramCell
  
symbolArea:spark.primitives.BitmapImage
Required: false Part Type: Static
A skin part where an image, explaining the cell data type, is displayed. In the default cell Skin PictogramCellSkin, the image is placed at the top right of the units grid and scaled to fit the left space by the units grid and to meet the units grid height. This skin part is hidden if no symbolField in the Pictogram is displayed.
PictogramCell
  
unitsGrid:spark.components.Group
Required: true Part Type: Static
A skin part that defines a group where unit elements, coding the cell percentage, are added. The group should be able to support any spark layout. The unitMinSize style property is provided in the Pictogram to support layouts like HorizontalLayout and VerticalLayout that don't deal with computing units dimensions. The dimension of the unitsGrid in the default cell Skin PictogramCellSkin is determined by the style values cellGridPercentWidth and cellGridPercentHeight.
PictogramCell
  
valueLabel:spark.components.supportClasses.TextBase
Required: false Part Type: Static
A skin part where a label, with the interesting value in the cell, is displayed. In the default cell Skin PictogramCellSkin, the label is placed at the bottom left of the units grid, just below the units grid and scaled to fit at right the units grid width and the bottom space left by the units container. This skin part is hidden if no valueField in the Pictogram is displayed.
PictogramCell
Property Detail
_gridInitializedproperty
protected var _gridInitialized:Boolean = false

Flag indicating of the unitsGrid skin part has been initialized.

cellLayoutChangedproperty 
cellLayoutChanged:Boolean

Flag indicating that cell grid layout should be updated. It is taken into account at invalidation process.


Implementation
    public function get cellLayoutChanged():Boolean
    public function set cellLayoutChanged(value:Boolean):void
dataChangedproperty 
dataChanged:Boolean

Flag indicating that cell data has been changed and skin parts should be updated. It is taken into account at invalidation process.


Implementation
    public function get dataChanged():Boolean
    public function set dataChanged(value:Boolean):void
gridChangedproperty 
gridChanged:Boolean

Flag indicating that cell grid rendering should be updated. It is taken into account at invalidation process.


Implementation
    public function get gridChanged():Boolean
    public function set gridChanged(value:Boolean):void
gridManagerproperty 
public var gridManager:PictogramManager

Manager of this cell performing update and logic operations.

heightproperty 
height:Number  [write-only] [override]


Implementation
    public function set height(value:Number):void
itemproperty 
item:Object

Cell data containing the statistic value and other information. It is injected by the Pictogram at invalidation process and corresponds to a data entry from its dataProvider.


Implementation
    public function get item():Object
    public function set item(value:Object):void
percentageChangedproperty 
percentageChanged:Boolean

Flag indicating that cell percentage has changed and grid units should be updated accordingly. It is taken into account at invalidation process.


Implementation
    public function get percentageChanged():Boolean
    public function set percentageChanged(value:Boolean):void
pictogramChartproperty 
public var pictogramChart:PictogramChart

The Pictogram instance, owner of this cell. This value is used to get style and to perform some invalidation operations on the component.

ratioXproperty 
ratioX:Number

Cell ratio at X. The ratio is computed by dividing the columnCountReference style value by the columnCount style value. According to this value, the skin can adapt its content (Font and graphical artefacts) to meet aesthetical aspects.

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


Implementation
    public function get ratioX():Number
    public function set ratioX(value:Number):void
ratioYproperty 
ratioY:Number

Cell ratio at Y. The ratio is computed by dividing the rowCountReference style value by the rowCount style value. According to this value, the skin can adapt its content (Font and graphical artefacts) to meet aesthetical aspects.

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


Implementation
    public function get ratioY():Number
    public function set ratioY(value:Number):void
unitStyleChangedproperty 
unitStyleChanged:Boolean

Flag indicating that cell units style has been invalidated and should be updated. It is taken into account at invalidation process.


Implementation
    public function get unitStyleChanged():Boolean
    public function set unitStyleChanged(value:Boolean):void
widthproperty 
width:Number  [write-only] [override]


Implementation
    public function set width(value:Number):void
Constructor Detail
PictogramCell()Constructor
public function PictogramCell()

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Method Detail
commitCellLayout()method
protected function commitCellLayout():void

Updates unitsGrid layout in the case where no custom skin is used.

commitData()method 
protected function commitData():void

Injects information on the different skin parts via data mapping pictogramChart properties.

In the case where the skin implements the IDataRenderer interface, the data get injected.

commitGrid()method 
protected function commitGrid():void

Handles grid units creation and rendering.

commitPercentage()method 
protected function commitPercentage():void

Handles grid units percentage visual coding.

commitProperties()method 
override protected function commitProperties():void

commitUnitStyles()method 
protected function commitUnitStyles():void

Updates cell units visual styles.

createChildren()method 
override protected function createChildren():void

initManagers()method 
protected function initManagers():void

Inits grid manager leading with all update and logic operations.

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

unitsGrid_creationCompleteHandler()method 
protected function unitsGrid_creationCompleteHandler(event:FlexEvent):void

Handles unitsGrid skin part creation by creating units, adding them to it and validating all visual aspects from which it depends.

Parameters

event:FlexEvent

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number