Packagefr.kapit.base
Classpublic class KapSkinnableContainer
InheritanceKapSkinnableContainer Inheritance spark.components.SkinnableContainer

Default MXML PropertymxmlContentFactory



Public Properties
 PropertyDefined By
  analysisPath : Object
An array used for CSV and General ICollectionView files and enables data source analysis with a given logic.
KapSkinnableContainer
  attributesDescriptor : AttributesDescriptor
It assigns to each column reference in the analysisPath its attributes.
KapSkinnableContainer
  csvDelimiter : String
CSV delimiter used for csv source parsing.
KapSkinnableContainer
  customTreeDataDescriptor : ITreeDataDescriptor
Custom Tree Data descriptor for navigating inside data provider object.
KapSkinnableContainer
  dataProvider : Object
Visualizer Data provider.
KapSkinnableContainer
  groupProperty : String
Property in a node data object (XML node for example) which value refers to the group dependency.The value is considered as the unique id of the group.
KapSkinnableContainer
  idProperty : String
For any data item in any ICollectionView dataProvider (XML, array collection containing objects with children property), The idProperty is the property which value is considered as the unique id of the item (node, group or link).
KapSkinnableContainer
  ignoreRoot : Boolean
Indicator if common root node of ICollectionView should be ignored.
KapSkinnableContainer
  kData : KData
[read-only] private
KapSkinnableContainer
  linkProperty : String
Property in a node data object depending to an ICollectionView dataProvider which value will be assigned to the created link.
KapSkinnableContainer
  mergeDescriptor : MergeDescriptor
Descriptor defining merging tasks that must be applied on a CSV source before displaying it.
KapSkinnableContainer
  recordDelimiter : String
Record delimiter of CSV fields.
KapSkinnableContainer
  reportingFunctions : Dictionary
Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment.
KapSkinnableContainer
  typesDescriptor : Dictionary
Column types descriptor.
KapSkinnableContainer
  withHeaders : Boolean
Indicator if the CSV data provider first row are headers or not.
KapSkinnableContainer
Protected Properties
 PropertyDefined By
  _analysisPath : Array
private
KapSkinnableContainer
  _attributesDescriptor : AttributesDescriptor
private
KapSkinnableContainer
  _csvDelimiter : String = ;
private
KapSkinnableContainer
  _customTreeDataDescriptor : ITreeDataDescriptor
private
KapSkinnableContainer
  _dataProvider : Object
private
KapSkinnableContainer
  _dataProviderChanged : Boolean
private
KapSkinnableContainer
  _dataProviderType : int
private
KapSkinnableContainer
  _groupProperty : String
private
KapSkinnableContainer
  _idProperty : String
private
KapSkinnableContainer
  _ignoreRoot : Boolean
private
KapSkinnableContainer
  _kData : KData
KapSkinnableContainer
  _linkProperty : String
private
KapSkinnableContainer
  _mergeDescriptor : MergeDescriptor
private
KapSkinnableContainer
  _recordDelimiter : String
private
KapSkinnableContainer
  _reportingFunctions : Dictionary
private
KapSkinnableContainer
  _reportingFunctionsChanged : Boolean
private
KapSkinnableContainer
  _typesDescriptor : Dictionary
private
KapSkinnableContainer
  _useMultiLink : Boolean = true
private
KapSkinnableContainer
  _withHeaders : Boolean = true
private
KapSkinnableContainer
Public Methods
 MethodDefined By
  
KapSkinnableContainer
  
addElement(element:IVisualElement):IVisualElement
[override]
KapSkinnableContainer
  
addElementAt(element:IVisualElement, index:int):IVisualElement
[override]
KapSkinnableContainer
  
setElementIndex(element:IVisualElement, index:int):void
[override]
KapSkinnableContainer
Protected Methods
 MethodDefined By
  
loadKData():void
Generate a common data descriptor from the dataProvider and other data manipulation options.
KapSkinnableContainer
Public Constants
 ConstantDefined By
  BICHROMATIC_COLORING : String = bichromatic
[static]
KapSkinnableContainer
  DEFAULT_COLORING : String = none
[static]
KapSkinnableContainer
  MONOCHROMATIC_COLORING : String = monochromatic
[static]
KapSkinnableContainer
  UNIFORM_COLORING : String = uniform
[static]
KapSkinnableContainer
Property Detail
_analysisPathproperty
protected var _analysisPath:Array

private

_attributesDescriptorproperty 
protected var _attributesDescriptor:AttributesDescriptor

private

_computeExtractedHierarchiesproperty 
base_internal var _computeExtractedHierarchies:Boolean = false

_computeHierarchiesproperty 
base_internal var _computeHierarchies:Boolean = true

_computeSubGraphsproperty 
base_internal var _computeSubGraphs:Boolean = true

_considerSingleNodeAsHierarchyproperty 
base_internal var _considerSingleNodeAsHierarchy:Boolean = true

_csvDelimiterproperty 
protected var _csvDelimiter:String = ;

private

_customTreeDataDescriptorproperty 
protected var _customTreeDataDescriptor:ITreeDataDescriptor

private

_dataProviderproperty 
protected var _dataProvider:Object

private

_dataProviderChangedproperty 
protected var _dataProviderChanged:Boolean

private

_dataProviderTypeproperty 
protected var _dataProviderType:int

private

_groupPropertyproperty 
protected var _groupProperty:String

private

_idPropertyproperty 
protected var _idProperty:String

private

_ignoreRootproperty 
protected var _ignoreRoot:Boolean

private

_kDataproperty 
protected var _kData:KData

_linkPropertyproperty 
protected var _linkProperty:String

private

_mergeDescriptorproperty 
protected var _mergeDescriptor:MergeDescriptor

private

_recordDelimiterproperty 
protected var _recordDelimiter:String

private

_reportingFunctionsproperty 
protected var _reportingFunctions:Dictionary

private

_reportingFunctionsChangedproperty 
protected var _reportingFunctionsChanged:Boolean

private

_supportGMLproperty 
base_internal var _supportGML:Boolean = true

_typesDescriptorproperty 
protected var _typesDescriptor:Dictionary

private

_useMultiLinkproperty 
protected var _useMultiLink:Boolean = true

private

_withHeadersproperty 
protected var _withHeaders:Boolean = true

private

analysisPathproperty 
analysisPath:Object

An array used for CSV and General ICollectionView files and enables data source analysis with a given logic. For CSV files, the analysis path is an Array containing the considered columns headers in the same order of the required analysis logic. For ICollectionView instances and Objects with children property, the analysis path is an Array containing the considered attributes in the same order of the required analysis logic. The String representation of that Array is also handled (visualizer.analysisPath=prop1;prop2).

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


Implementation
    public function get analysisPath():Object
    public function set analysisPath(value:Object):void
attributesDescriptorproperty 
attributesDescriptor:AttributesDescriptor

It assigns to each column reference in the analysisPath its attributes. By default, Each field of an analysisPath column header have as attributes the other column headers of the CSV input. attributesDescriptor specifies the content and properties of extracted data sets.

The default value is null.

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


Implementation
    public function get attributesDescriptor():AttributesDescriptor
    public function set attributesDescriptor(value:AttributesDescriptor):void
csvDelimiterproperty 
csvDelimiter:String

CSV delimiter used for csv source parsing.

The default value is ;.

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


Implementation
    public function get csvDelimiter():String
    public function set csvDelimiter(value:String):void
customTreeDataDescriptorproperty 
customTreeDataDescriptor:ITreeDataDescriptor

Custom Tree Data descriptor for navigating inside data provider object.

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


Implementation
    public function get customTreeDataDescriptor():ITreeDataDescriptor
    public function set customTreeDataDescriptor(value:ITreeDataDescriptor):void
dataProviderproperty 
dataProvider:Object

Visualizer Data provider. It can be a :

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


Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void

See also

groupPropertyproperty 
groupProperty:String

Property in a node data object (XML node for example) which value refers to the group dependency.The value is considered as the unique id of the group. Using the groupProperty, each node will be depending to a given group according to the groupProperty value. If the value is null or the data unit does not contain the referred property, the node won't be depending to any group. Note : The groupProperty won't work without the idPropert set.

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


Implementation
    public function get groupProperty():String
    public function set groupProperty(value:String):void
idPropertyproperty 
idProperty:String

For any data item in any ICollectionView dataProvider (XML, array collection containing objects with children property), The idProperty is the property which value is considered as the unique id of the item (node, group or link). It enables extracting general graphs from hierarchical ICollectionView data providers.

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


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

See also

ignoreRootproperty 
ignoreRoot:Boolean

Indicator if common root node of ICollectionView should be ignored. This property should be used when manipulating ICollectionView instances or Object with children property or customTreeDataDescritor.

If set to True, the generated output of the visualizer will be a disconnected graph showing the generated subGraphs from all direct input children.

The default value is false.

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


Implementation
    public function get ignoreRoot():Boolean
    public function set ignoreRoot(value:Boolean):void
kDataproperty 
kData:KData  [read-only]

private


Implementation
    public function get kData():KData
linkPropertyproperty 
linkProperty:String

Property in a node data object depending to an ICollectionView dataProvider which value will be assigned to the created link. The value is affected to the link created between the node data object and its parent in the data provider structure.

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


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

Example
     <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
        xmlns:s="library://ns.adobe.com/flex/spark" 
        xmlns:mx="library://ns.adobe.com/flex/mx" minWidth="955" minHeight="600" xmlns:visualizer="fr.kapit.visualizer.>
     <fx:Script>
         <![CDATA[
             private function linkLabelFieldFunction(data:Object):Array
             {
                 return [data[0].toString()];
             }
         ]]>
     </fx:Script>
         <fx:Declarations>
     <fx:XML id="xmlDataProvider" xmlns="">
             <node id="0">
                 <node id="1" link="1 to 0">
                     <node id="2" link="1 to 2"/>
                     <node id="3" link="1 to 3"/>
                     <node id="4" link="1 to 4"/>
                 </node>
                 <node id="2" link="0 to 2">
                     <node id="3" link="2 to 3"/>
                 </node>
             </node>
         </fx:XML>
     </fx:Declarations>
     <visualizer:Visualizer 
         width="100%" height="100%" 
         dataProvider="{xmlDataProvider}"
         nodeLabelFields="@id"
         idProperty="@id"
         linkDecoratorLabelFieldFunction="linkLabelFieldFunction"
         layout="hierarchicalCyclic">
     </visualizer:Visualizer>
 </s:Application>
 
mergeDescriptorproperty 
mergeDescriptor:MergeDescriptor

Descriptor defining merging tasks that must be applied on a CSV source before displaying it. In fact, a MergeDescriptor object is a set of MergeEntity instances, each one defines columns to be merged in one column according to a merging function. A MergeEntity instance is created by defining :

A MergeEntity is a unit merging task that must be added to the MergeDescriptor to be taken into account using the addMergeDescription(mergeEntity) method. When merging, the developer can choose between leaving the content of merged columns to be taken into account when performing data processing and adding the merging column or replacing them by the resulting column. This can be accomplished by setting to true or false the leaveMergeColumns of the MergeDescriptor instance. The mergingDescriptor should be used only with CSV files.

The default value is null.

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


Implementation
    public function get mergeDescriptor():MergeDescriptor
    public function set mergeDescriptor(value:MergeDescriptor):void
recordDelimiterproperty 
recordDelimiter:String

Record delimiter of CSV fields.

The default value is null.

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


Implementation
    public function get recordDelimiter():String
    public function set recordDelimiter(value:String):void
reportingFunctionsproperty 
reportingFunctions:Dictionary

Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment. In fact, when building data sets and their corresponding data from a given column (or attribute), several rows are grouped into one row and each data field content (attribute column/attribute) is added to an array. Transforming the data fields arrays into a real data by applying standard or custom functions can be very important to have correct and coherent data for nodes data. The reportingFunctions property is a Dictionary that assigns to a given column key (column name for CSV) or attribute (for XML) its reporting function. This function should accept as parameters an array and a type class (uint for example). Actually, there are two standard functions that can be accessed statically from the ReportingUtils class:

The default value is null.

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


Implementation
    public function get reportingFunctions():Dictionary
    public function set reportingFunctions(value:Dictionary):void
typesDescriptorproperty 
typesDescriptor:Dictionary

Column types descriptor. This Object specifies the Class needed to parse the content of a column fields. By default, the Visualizer component recognize Data Types of columns content (String, Number, Date....). But in some cases, especially when dealing with IDs, Numbers, for example, must be considered as String and we need to specify this for the Visualizer. The solution is to specify the Type of the column fields where bypassing the automatic type assignment is needed. The Types Descripor is a Dictionary that allows to assign a Type Class to a given column data and thus giving the Visualizer integrator the possibility to correctly describe the content of his data source columns.

The default value is null;.

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


Implementation
    public function get typesDescriptor():Dictionary
    public function set typesDescriptor(value:Dictionary):void
withHeadersproperty 
withHeaders:Boolean

Indicator if the CSV data provider first row are headers or not.

The default value is true.

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


Implementation
    public function get withHeaders():Boolean
    public function set withHeaders(value:Boolean):void
Constructor Detail
KapSkinnableContainer()Constructor
public function KapSkinnableContainer()



Method Detail
addElement()method
override public function addElement(element:IVisualElement):IVisualElement

Parameters

element:IVisualElement

Returns
IVisualElement
addElementAt()method 
override public function addElementAt(element:IVisualElement, index:int):IVisualElement

Parameters

element:IVisualElement
 
index:int

Returns
IVisualElement
loadKData()method 
protected function loadKData():void

Generate a common data descriptor from the dataProvider and other data manipulation options.

setElementIndex()method 
override public function setElementIndex(element:IVisualElement, index:int):void

Parameters

element:IVisualElement
 
index:int

Constant Detail
BICHROMATIC_COLORINGConstant
public static const BICHROMATIC_COLORING:String = bichromatic

COLLECTION_DATA_SOURCEConstant 
base_internal static const COLLECTION_DATA_SOURCE:uint = 0

CSV_DATA_SOURCEConstant 
base_internal static const CSV_DATA_SOURCE:uint = 2

DEFAULT_COLORINGConstant 
public static const DEFAULT_COLORING:String = none

GML_DATA_SOURCEConstant 
base_internal static const GML_DATA_SOURCE:uint = 1

MONOCHROMATIC_COLORINGConstant 
public static const MONOCHROMATIC_COLORING:String = monochromatic

UNDEFINED_COLORINGConstant 
base_internal static const UNDEFINED_COLORING:String = undefined

UNIFORM_COLORINGConstant 
public static const UNIFORM_COLORING:String = uniform