Packagecom.kapit.visualizer.renderer
Classpublic class GenericObject
InheritanceGenericObject Inheritance mx.core.UIComponent
ImplementsIGenericItem
SubclassesGenericLink, GenericSprite

GenericObject is the basic visual type of any IGenericItem containng basic parameters and information. It holds behavoural information about any IGenericItem (Events sensitivity, expand/collapse behaviour, control managers, selection status) and its basic attributes (data, parent, UI...).


Public Properties
 PropertyDefined by
  allowCollapseExpand : Boolean
Indicator if the Visualizer element should have an Expand/Collapse behaviour.
GenericObject
  buttonPlacement : String
Expand Collapse Button Placement.
GenericObject
  clickFilters : Array
GenericObject
  collapseButtonClass : Class
Collapse Icon shown when the node is expanded.
GenericObject
  COLLAPSE_GROUP : uint = 3
[static] "Group children are collapsed" Flag.
GenericObject
  collapseParent : GenericObject
Parent of the Visualizer element if there is any.
GenericObject
  COLLAPSE_SPRITE : uint = 0
[static] "Sprite children are collapsed" Flag.
GenericObject
  collpaseOverButtonClass : Class
Collapse Icon shown when the node is expanded and the Expand/Collapse Button is rolled over.
GenericObject
  connectedElements : Dictionary
GenericObject
  considerClick : Boolean
Indicator if Click events should be listened
GenericObject
  considerDoubleClick : Boolean
Indicator if Double Click events should be listened
GenericObject
  considerRollOut : Boolean
Indicator if Roll Out events should be listened
GenericObject
  considerRollOver : Boolean
Indicator if Roll Over events should be listened
GenericObject
  data : Object
GenericObject
  decorator : Sprite
Visualizer element decorator (Image, TextField, animation....)
GenericObject
  expandButtonClass : Class
Expand Icon shown when the node is collapsed.
GenericObject
  expandCollapseElements : Array
Visualizer element collapse/expand children.
GenericObject
  EXPAND_GROUP : uint = 4
[static] "Group children are expanded" Flag.
GenericObject
  expandOverButtonClass : Class
Expand Icon shown when the node is collapsed and the Expand/Collapse Button is rolled over.
GenericObject
  EXPAND_SPRITE : uint = 1
[static] "Sprite children are expanded" Flag.
GenericObject
  highlightFilters : Array
GenericObject
  idleFilers : Array
GenericObject
  IDLE_GROUP : uint = 5
[static] "Group with no Expand/Collapse functionality" Flag..
GenericObject
  IDLE_SPRITE : uint = 2
[static] "Sprite with no Expand/Collapse functionality" Flag.
GenericObject
  isSelected : Boolean
Indicator if Visualizer element is selected.
GenericObject
  kDataItem : KDataItem
GenericObject
  LINK : uint = 6
[static] Link Flag.
GenericObject
  links : Array
[read-only] Links to which a GenericSprite or a GenericGroup is connected.
GenericObject
  lock : Boolean
GenericObject
  manager : IManager
Visualizer element manager.
GenericObject
  showExpandCollapseButton : Boolean
GenericObject
  type : uint
Visualizer element type indicating behavioural state.
GenericObject
  UID : String
Visualizer element Unique ID.
GenericObject
  view : GenericView
[read-only] Viewer to which the Visualizer element belongs
GenericObject
Protected Properties
 PropertyDefined by
  _decoratorLayer : UIComponent
GenericObject
  _expandButton : Button
GenericObject
Public Methods
 MethodDefined by
  
GenericObject(view:GenericView)
Constructor
GenericObject
  
initListeners(considerCLICK:Boolean = true, considerDoubleCLICK:Boolean = true, considerRollOUT:Boolean = true, considerRollOVER:Boolean = true, allowCollapseEXPAND:Boolean = true):void
nitialises and registers Visualizer element listeners.
GenericObject
  
setPlacement(rectangle:Rectangle, updateReferences:Boolean = false):void
Sets the Visualizer element spatial parameters and updates its environment (links, decorators...).
GenericObject
  
updateExpandButtonPlacement():void
GenericObject
  
updateLinks():void
GenericObject
Protected Methods
 MethodDefined by
  
commitProperties():void
GenericObject
  
handleClickEvent(event:Event):void
Handles click event if considered.
GenericObject
  
handleDoubleClickEvent(event:Event):void
Handles double click event if considered.
GenericObject
  
handleRollOutEvent(event:Event):void
Handles roll out event if considered.
GenericObject
  
handleRollOverEvent(event:Event):void
Handles roll over event if considered.
GenericObject
Public Constants
 ConstantDefined by
  BUTTON_AT_BOTTOM_LEFT : String = "bottomLeft"
[static] xpand/Collapse Button placed at the bottom-left.
GenericObject
  BUTTON_AT_BOTTOM_RIGHT : String = "bottomRight"
[static] xpand/Collapse Button placed at the bottom-right.
GenericObject
  BUTTON_AT_MID_BOTTOM : String = "midBottom"
[static] xpand/Collapse Button placed at the bottom and X centered.
GenericObject
  BUTTON_AT_MID_LEFT : String = "midLeft"
[static] xpand/Collapse Button placed at the left and Y centered.
GenericObject
  BUTTON_AT_MID_RIGHT : String = "midRight"
[static] xpand/Collapse Button placed at the right and Y centered.
GenericObject
  BUTTON_AT_MID_TOP : String = "midTOP"
[static] xpand/Collapse Button placed at the top and X centered.
GenericObject
  BUTTON_AT_TOP_LEFT : String = "topLeft"
[static] xpand/Collapse Button placed at the top-left.
GenericObject
  BUTTON_AT_TOP_Right : String = "topRight"
[static] xpand/Collapse Button placed at the top-right.
GenericObject
Property detail
allowCollapseExpandproperty
allowCollapseExpand:Boolean  [read-write]

Indicator if the Visualizer element should have an Expand/Collapse behaviour.

Implementation
    public function get allowCollapseExpand():Boolean
    public function set allowCollapseExpand(value:Boolean):void
buttonPlacementproperty 
buttonPlacement:String  [read-write]

Expand Collapse Button Placement. The possible values are :

    • midRight : button placed at the right of the node and Y centered
      midLeft : button placed at the left of the node and Y centered
      midTop : button placed at the top of the node and X centered
      midBottom : button placed at the bottom of the node and X centered
      topLeft : button placed at the top-left of the node
      topRight : button placed at the top-right of the node
      bottomleft : button placed at the bottom-left of the nod
      bottomRight : button placed at the bottom-right of the node

    • Implementation
        public function get buttonPlacement():String
        public function set buttonPlacement(value:String):void
    clickFiltersproperty 
    clickFilters:Array  [read-write]Implementation
        public function get clickFilters():Array
        public function set clickFilters(value:Array):void
    collapseButtonClassproperty 
    collapseButtonClass:Class  [read-write]

    Collapse Icon shown when the node is expanded.

    Implementation
        public function get collapseButtonClass():Class
        public function set collapseButtonClass(value:Class):void
    COLLAPSE_GROUPproperty 
    public static var COLLAPSE_GROUP:uint = 3

    "Group children are collapsed" Flag. It indicates that the Visualizer element children must be / are collapsed.

    collapseParentproperty 
    collapseParent:GenericObject  [read-write]

    Parent of the Visualizer element if there is any.

    Implementation
        public function get collapseParent():GenericObject
        public function set collapseParent(value:GenericObject):void
    COLLAPSE_SPRITEproperty 
    public static var COLLAPSE_SPRITE:uint = 0

    "Sprite children are collapsed" Flag. It indicates that the Visualizer element children must be / are collapsed.

    collpaseOverButtonClassproperty 
    collpaseOverButtonClass:Class  [read-write]

    Collapse Icon shown when the node is expanded and the Expand/Collapse Button is rolled over.

    Implementation
        public function get collpaseOverButtonClass():Class
        public function set collpaseOverButtonClass(value:Class):void
    connectedElementsproperty 
    connectedElements:Dictionary  [read-write]Implementation
        public function get connectedElements():Dictionary
        public function set connectedElements(value:Dictionary):void
    considerClickproperty 
    considerClick:Boolean  [read-write]

    Indicator if Click events should be listened

    Implementation
        public function get considerClick():Boolean
        public function set considerClick(value:Boolean):void
    considerDoubleClickproperty 
    considerDoubleClick:Boolean  [read-write]

    Indicator if Double Click events should be listened

    Implementation
        public function get considerDoubleClick():Boolean
        public function set considerDoubleClick(value:Boolean):void
    considerRollOutproperty 
    considerRollOut:Boolean  [read-write]

    Indicator if Roll Out events should be listened

    Implementation
        public function get considerRollOut():Boolean
        public function set considerRollOut(value:Boolean):void
    considerRollOverproperty 
    considerRollOver:Boolean  [read-write]

    Indicator if Roll Over events should be listened

    Implementation
        public function get considerRollOver():Boolean
        public function set considerRollOver(value:Boolean):void
    dataproperty 
    data:Object  [read-write]Implementation
        public function get data():Object
        public function set data(value:Object):void
    decoratorproperty 
    decorator:Sprite  [read-write]

    Visualizer element decorator (Image, TextField, animation....)

    Implementation
        public function get decorator():Sprite
        public function set decorator(value:Sprite):void
    _decoratorLayerproperty 
    protected var _decoratorLayer:UIComponent
    _expandButtonproperty 
    protected var _expandButton:Button
    expandButtonClassproperty 
    expandButtonClass:Class  [read-write]

    Expand Icon shown when the node is collapsed.

    Implementation
        public function get expandButtonClass():Class
        public function set expandButtonClass(value:Class):void
    expandCollapseElementsproperty 
    expandCollapseElements:Array  [read-write]

    Visualizer element collapse/expand children.

    Implementation
        public function get expandCollapseElements():Array
        public function set expandCollapseElements(value:Array):void
    EXPAND_GROUPproperty 
    public static var EXPAND_GROUP:uint = 4

    "Group children are expanded" Flag. It indicates that the Visualizer element children must be / are expanded.

    expandOverButtonClassproperty 
    expandOverButtonClass:Class  [read-write]

    Expand Icon shown when the node is collapsed and the Expand/Collapse Button is rolled over.

    Implementation
        public function get expandOverButtonClass():Class
        public function set expandOverButtonClass(value:Class):void
    EXPAND_SPRITEproperty 
    public static var EXPAND_SPRITE:uint = 1

    "Sprite children are expanded" Flag. It indicates that the Visualizer element children must be / are expanded.

    highlightFiltersproperty 
    highlightFilters:Array  [read-write]Implementation
        public function get highlightFilters():Array
        public function set highlightFilters(value:Array):void
    idleFilersproperty 
    idleFilers:Array  [read-write]Implementation
        public function get idleFilers():Array
        public function set idleFilers(value:Array):void
    IDLE_GROUPproperty 
    public static var IDLE_GROUP:uint = 5

    "Group with no Expand/Collapse functionality" Flag..

    IDLE_SPRITEproperty 
    public static var IDLE_SPRITE:uint = 2

    "Sprite with no Expand/Collapse functionality" Flag.

    isSelectedproperty 
    isSelected:Boolean  [read-write]

    Indicator if Visualizer element is selected.

    Implementation
        public function get isSelected():Boolean
        public function set isSelected(value:Boolean):void
    kDataItemproperty 
    kDataItem:KDataItem  [read-write]Implementation
        public function get kDataItem():KDataItem
        public function set kDataItem(value:KDataItem):void
    LINKproperty 
    public static var LINK:uint = 6

    Link Flag.

    linksproperty 
    links:Array  [read-only]

    Links to which a GenericSprite or a GenericGroup is connected.

    Implementation
        public function get links():Array
    lockproperty 
    lock:Boolean  [read-write]Implementation
        public function get lock():Boolean
        public function set lock(value:Boolean):void
    managerproperty 
    manager:IManager  [read-write]

    Visualizer element manager. It controls user interaction and dispatches Visualizer event.

    Implementation
        public function get manager():IManager
        public function set manager(value:IManager):void
    showExpandCollapseButtonproperty 
    showExpandCollapseButton:Boolean  [read-write]Implementation
        public function get showExpandCollapseButton():Boolean
        public function set showExpandCollapseButton(value:Boolean):void
    typeproperty 
    type:uint  [read-write]

    Visualizer element type indicating behavioural state.

    Implementation
        public function get type():uint
        public function set type(value:uint):void
    UIDproperty 
    UID:String  [read-write]

    Visualizer element Unique ID.

    Implementation
        public function get UID():String
        public function set UID(value:String):void
    viewproperty 
    view:GenericView  [read-only]

    Viewer to which the Visualizer element belongs

    Implementation
        public function get view():GenericView
    Constructor detail
    GenericObject()constructor
    public function GenericObject(view:GenericView)

    Constructor

    Parameters
    view:GenericView — Viewer to which the Visualizer element belongs.
    Method detail
    commitProperties()method
    protected override function commitProperties():void
    handleClickEvent()method 
    protected function handleClickEvent(event:Event):void

    Handles click event if considered.

    Parameters
    event:Event — Detected click event
    handleDoubleClickEvent()method 
    protected function handleDoubleClickEvent(event:Event):void

    Handles double click event if considered.

    Parameters
    event:Event — Detected double click event
    handleRollOutEvent()method 
    protected function handleRollOutEvent(event:Event):void

    Handles roll out event if considered.

    Parameters
    event:Event — Detected roll out event
    handleRollOverEvent()method 
    protected function handleRollOverEvent(event:Event):void

    Handles roll over event if considered.

    Parameters
    event:Event — Detected roll over event
    initListeners()method 
    public function initListeners(considerCLICK:Boolean = true, considerDoubleCLICK:Boolean = true, considerRollOUT:Boolean = true, considerRollOVER:Boolean = true, allowCollapseEXPAND:Boolean = true):void

    nitialises and registers Visualizer element listeners.

    Parameters
    considerCLICK:Boolean (default = true) — Indicator if Click events should be listened.
     
    considerDoubleCLICK:Boolean (default = true) — Indicator if DoubleClick events should be listened.
     
    considerRollOUT:Boolean (default = true) — Indicator if RollOut events should be listened.
     
    considerRollOVER:Boolean (default = true) — Indicator if RollOver events should be listened.
     
    allowCollapseEXPAND:Boolean (default = true) — Indicator if Expand events should be listened.
    setPlacement()method 
    public function setPlacement(rectangle:Rectangle, updateReferences:Boolean = false):void

    Sets the Visualizer element spatial parameters and updates its environment (links, decorators...).

    Parameters
    rectangle:Rectangle — Spatial parameters : position and size.
     
    updateReferences:Boolean (default = false) — Indicator if the references to the Visualizer element should be updated.
    updateExpandButtonPlacement()method 
    public function updateExpandButtonPlacement():void
    updateLinks()method 
    public function updateLinks():void
    Constant detail
    BUTTON_AT_BOTTOM_LEFTconstant
    public static const BUTTON_AT_BOTTOM_LEFT:String = "bottomLeft"

    xpand/Collapse Button placed at the bottom-left.

    BUTTON_AT_BOTTOM_RIGHTconstant 
    public static const BUTTON_AT_BOTTOM_RIGHT:String = "bottomRight"

    xpand/Collapse Button placed at the bottom-right.

    BUTTON_AT_MID_BOTTOMconstant 
    public static const BUTTON_AT_MID_BOTTOM:String = "midBottom"

    xpand/Collapse Button placed at the bottom and X centered.

    BUTTON_AT_MID_LEFTconstant 
    public static const BUTTON_AT_MID_LEFT:String = "midLeft"

    xpand/Collapse Button placed at the left and Y centered.

    BUTTON_AT_MID_RIGHTconstant 
    public static const BUTTON_AT_MID_RIGHT:String = "midRight"

    xpand/Collapse Button placed at the right and Y centered.

    BUTTON_AT_MID_TOPconstant 
    public static const BUTTON_AT_MID_TOP:String = "midTOP"

    xpand/Collapse Button placed at the top and X centered.

    BUTTON_AT_TOP_LEFTconstant 
    public static const BUTTON_AT_TOP_LEFT:String = "topLeft"

    xpand/Collapse Button placed at the top-left.

    BUTTON_AT_TOP_Rightconstant 
    public static const BUTTON_AT_TOP_Right:String = "topRight"

    xpand/Collapse Button placed at the top-right.