Packagecom.kapit.diagram.layers
Classpublic class DiagramColumnContainer
InheritanceDiagramColumnContainer Inheritance mx.containers.HDividedBox
ImplementsIDiagramElement, ISVGExportable



Public Properties
 PropertyDefined by
  bordercolor : uint
[read-only] private Border column color.
DiagramColumnContainer
  columnbackground : BitmapAsset
[read-only] private Column default background.
DiagramColumnContainer
  dataobjectid : String
DiagramColumnContainer
  defaultHeight : Number
Default height of this DiagramColumnContainer
DiagramColumnContainer
  did : String
[read-only] Diagram Unique ID that defines the Unique reference of this layer in order to enable fast access to different layers (by simply providing the correspondant ID).
DiagramColumnContainer
  draggingcolumn : DiagramColumn
The DiagramColumn, contained in this DiagramColumnContainer, that is currently being dragged.
DiagramColumnContainer
  printcolor : uint
[read-only] private Print color background used for SVG export.
DiagramColumnContainer
  scaleX : Number
[write-only]
DiagramColumnContainer
  scaleY : Number
[write-only]
DiagramColumnContainer
  view : DiagramView
[read-only] The Diagram View Container.
DiagramColumnContainer
Protected Properties
 PropertyDefined by
  _bordercolor : uint
This DiagramColumnContainer border color.
DiagramColumnContainer
  _borderwidth : Number
This DiagramColumnContainer border width.
DiagramColumnContainer
  _draggingcolumn : DiagramColumn = null
The DiagramColumn currently being dragged.
DiagramColumnContainer
  _highlightedColumn : DiagramColumn
Highlighted Column.
DiagramColumnContainer
  _resizeeffect : Resize = null
Used resize effect for DiagramLane children.
DiagramColumnContainer
  _topleftHeader : DiagramColumnHeader = null
DiagramColumnContainer
  _totalwidth : Number = 0
Actual width of this DiagramColumnContainer component
DiagramColumnContainer
  _view : DiagramView = null
The Diagram View in which this DiagramPanel is embedded.
DiagramColumnContainer
Public Methods
 MethodDefined by
  
Constructor.
DiagramColumnContainer
  
activateUI(a:Boolean):void
DiagramColumnContainer
  
addChildAt(child:DisplayObject, idx:int):DisplayObject
DiagramColumnContainer
  
appendToSVGDocument(doc:SVGSVGElement):void
Adds this Diagram Column Container in an SVG description to an SVGSVGElement (SVG document).
DiagramColumnContainer
  
checkTagName(xml:XML):Boolean
Checks if an XML description is adequate to this DiagramColumnContainer instance by checking the tag name property.
DiagramColumnContainer
  
clear():void
DiagramColumnContainer
  
computeMeasuredWidth(limit:int = -1):Number
DiagramColumnContainer
  
fromXML(xml:XML):void
Parses this DiagramColumnContainer from an XML object.
DiagramColumnContainer
  
DiagramColumnContainer
  
DiagramColumnContainer
  
getTagName():String
Returns the diagramColumnContainer tag name ("columns").
DiagramColumnContainer
  
DiagramColumnContainer
  
DiagramColumnContainer
  
Redraws this DiagramColumnContainer and its children when library styles and assets change given a SVGAssetLibraryEvent.
DiagramColumnContainer
  
registerDiagramObject(object:DiagramObject, point:Point):void
DiagramColumnContainer
  
removeAll():void
DiagramColumnContainer
  
removeChild(child:DisplayObject):DisplayObject
DiagramColumnContainer
  
DiagramColumnContainer
  
reset():void
DiagramColumnContainer
  
resizeColumn(column:DiagramColumn, widthfrom:Number, widthto:Number, endeffectlistener:Function = null, updateeffectlistener:Function = null, withAnimation:Boolean = true):void
DiagramColumnContainer
  
scrollHandler(event:ScrollEvent):void
Enables scrolling inside the DiagramPanelsContainer component (for viewing children Diagram Panels).
DiagramColumnContainer
  
styleChanged(prop:String):void
Detects changes to style properties and handle the change accordingly.
DiagramColumnContainer
  
DiagramColumnContainer
  
toXML():XML
Writes this DiagramColumnContainer into an XML object.
DiagramColumnContainer
  
DiagramColumnContainer
  
DiagramColumnContainer
Protected Methods
 MethodDefined by
  
DiagramColumnContainer
  
dividerReleaseHandler(event:DividerEvent):void
DiagramColumnContainer
  
endResizeEffectHandler(event:TweenEvent):void
DiagramColumnContainer
  
DiagramColumnContainer
  
measure():void
DiagramColumnContainer
  
removeHandler(event:FlexEvent):void
Removes all listeners given a FlexEvent.
DiagramColumnContainer
  
DiagramColumnContainer
  
updateDisplayList(w:Number, h:Number):void
DiagramColumnContainer
Property detail
_bordercolorproperty
protected var _bordercolor:uint

This DiagramColumnContainer border color.

bordercolorproperty 
bordercolor:uint  [read-only]

private Border column color.

Implementation
    public function get bordercolor():uint
_borderwidthproperty 
protected var _borderwidth:Number

This DiagramColumnContainer border width.

columnbackgroundproperty 
columnbackground:BitmapAsset  [read-only]

private Column default background.

Implementation
    public function get columnbackground():BitmapAsset
dataobjectidproperty 
dataobjectid:String  [read-write]Implementation
    public function get dataobjectid():String
    public function set dataobjectid(value:String):void
defaultHeightproperty 
defaultHeight:Number  [read-write]

Default height of this DiagramColumnContainer

Implementation
    public function get defaultHeight():Number
    public function set defaultHeight(value:Number):void
didproperty 
did:String  [read-only]

Diagram Unique ID that defines the Unique reference of this layer in order to enable fast access to different layers (by simply providing the correspondant ID).

Implementation
    public function get did():String
_draggingcolumnproperty 
protected var _draggingcolumn:DiagramColumn = null

The DiagramColumn currently being dragged.

draggingcolumnproperty 
draggingcolumn:DiagramColumn  [read-write]

The DiagramColumn, contained in this DiagramColumnContainer, that is currently being dragged.

Implementation
    public function get draggingcolumn():DiagramColumn
    public function set draggingcolumn(value:DiagramColumn):void
_highlightedColumnproperty 
protected var _highlightedColumn:DiagramColumn

Highlighted Column.

printcolorproperty 
printcolor:uint  [read-only]

private Print color background used for SVG export. It can be used when the columnbackground property is null.

Implementation
    public function get printcolor():uint
_resizeeffectproperty 
protected var _resizeeffect:Resize = null

Used resize effect for DiagramLane children.

scaleXproperty 
scaleX:Number  [write-only]Implementation
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [write-only]Implementation
    public function set scaleY(value:Number):void
_topleftHeaderproperty 
protected var _topleftHeader:DiagramColumnHeader = null
_totalwidthproperty 
protected var _totalwidth:Number = 0

Actual width of this DiagramColumnContainer component

_viewproperty 
protected var _view:DiagramView = null

The Diagram View in which this DiagramPanel is embedded.

viewproperty 
view:DiagramView  [read-only]

The Diagram View Container.

Implementation
    public function get view():DiagramView
Constructor detail
DiagramColumnContainer()constructor
public function DiagramColumnContainer(view:DiagramView)

Constructor.

Parameters
view:DiagramView
Method detail
activateUI()method
public function activateUI(a:Boolean):voidParameters
a:Boolean
addChildAt()method 
public override function addChildAt(child:DisplayObject, idx:int):DisplayObjectParameters
child:DisplayObject
 
idx:int

Returns
DisplayObject
appendToSVGDocument()method 
public function appendToSVGDocument(doc:SVGSVGElement):void

Adds this Diagram Column Container in an SVG description to an SVGSVGElement (SVG document).

Parameters
doc:SVGSVGElement — SVGSVGElement (SVG document) to be updated by adding this DiagramColumnContainer.
checkTagName()method 
public function checkTagName(xml:XML):Boolean

Checks if an XML description is adequate to this DiagramColumnContainer instance by checking the tag name property.

Parameters
xml:XML — Provided DiagramColumnContainer description

Returns
Boolean — Validity of the XML description (partial verification as it only checks the Tag Name).
clear()method 
public function clear():void
computeMeasuredWidth()method 
public function computeMeasuredWidth(limit:int = -1):NumberParameters
limit:int (default = -1)

Returns
Number
createChildren()method 
protected override function createChildren():void
dividerReleaseHandler()method 
protected function dividerReleaseHandler(event:DividerEvent):voidParameters
event:DividerEvent
endResizeEffectHandler()method 
protected function endResizeEffectHandler(event:TweenEvent):voidParameters
event:TweenEvent
fromXML()method 
public function fromXML(xml:XML):void

Parses this DiagramColumnContainer from an XML object.

Parameters
xml:XML — An XML object represeting this DiagramColumnContainer.
getColumnAt()method 
public function getColumnAt(idx:uint):DiagramColumnParameters
idx:uint

Returns
DiagramColumn
getColumnUnderPoint()method 
public function getColumnUnderPoint(point:Point):DiagramColumnParameters
point:Point

Returns
DiagramColumn
getTagName()method 
public function getTagName():String

Returns the diagramColumnContainer tag name ("columns").

Returns
String — DiagramColumnContainer Tag Name.
handleColumnResizing()method 
public function handleColumnResizing(column:DiagramColumn):voidParameters
column:DiagramColumn
highlightColumn()method 
public function highlightColumn(column:DiagramColumn):voidParameters
column:DiagramColumn
inhibitPercentSizes()method 
protected function inhibitPercentSizes():void
libraryStylesChanged()method 
public function libraryStylesChanged(event:SVGAssetLibraryEvent):void

Redraws this DiagramColumnContainer and its children when library styles and assets change given a SVGAssetLibraryEvent.

Parameters
event:SVGAssetLibraryEvent — SVGAssetLibraryEvent telling a change in asset library properties.
measure()method 
protected override function measure():void
registerDiagramObject()method 
public function registerDiagramObject(object:DiagramObject, point:Point):voidParameters
object:DiagramObject
 
point:Point
removeAll()method 
public function removeAll():void
removeChild()method 
public override function removeChild(child:DisplayObject):DisplayObjectParameters
child:DisplayObject

Returns
DisplayObject
removeColumn()method 
public function removeColumn(idx:int):DiagramColumnParameters
idx:int

Returns
DiagramColumn
removeHandler()method 
protected function removeHandler(event:FlexEvent):void

Removes all listeners given a FlexEvent.

Parameters
event:FlexEvent — Detected Flex Event.
reset()method 
public function reset():void
resizeColumn()method 
public function resizeColumn(column:DiagramColumn, widthfrom:Number, widthto:Number, endeffectlistener:Function = null, updateeffectlistener:Function = null, withAnimation:Boolean = true):voidParameters
column:DiagramColumn
 
widthfrom:Number
 
widthto:Number
 
endeffectlistener:Function (default = null)
 
updateeffectlistener:Function (default = null)
 
withAnimation:Boolean (default = true)
scrollHandler()method 
public function scrollHandler(event:ScrollEvent):void

Enables scrolling inside the DiagramPanelsContainer component (for viewing children Diagram Panels).

Parameters
event:ScrollEvent — Detected Scroll Event.
styleChanged()method 
public override function styleChanged(prop:String):void

Detects changes to style properties and handle the change accordingly. When any style property is set, Flex calls the styleChanged method, passing to it the name of the style being set.

Parameters
prop:String — The name of the style property, or null if all styles for this DiagramColumnContainer have changed.
syncReferences()method 
public function syncReferences():void
toXML()method 
public function toXML():XML

Writes this DiagramColumnContainer into an XML object.

Returns
XML — An XML object representing this DiagramColumnContainer.
unRegisterDiagramObject()method 
public function unRegisterDiagramObject(object:DiagramObject):voidParameters
object:DiagramObject
updateCaptionsVisibility()method 
protected function updateCaptionsVisibility():void
updateDisplayList()method 
protected override function updateDisplayList(w:Number, h:Number):voidParameters
w:Number
 
h:Number
updateGlobalLinksPlacement()method 
public function updateGlobalLinksPlacement():void