com.kapit.diagram.layers.DiagramColumn

	Property	Defined by
		caption : DiagramColumnCaption [read-only]	DiagramColumn
		closeable : Boolean [read-only] Indicates whether this DiagramPanel can be closed according to its dragging status and DiagramPanelsContainer children number.	DiagramColumn
		collapsable : Boolean [read-only] Indicates whether this DiagramPanel can be collapsed according to its dragging status and DiagramPanelsContainer children number.	DiagramColumn
		collapsed : Boolean [read-only] Indicates whether this DiagramPanel component is currently collapsed .	DiagramColumn
		collapsedWidth : Number Collapsed width of this DiagramColumn	DiagramColumn
		columnIndex : int [read-only] The index of this column.	DiagramColumn
		container : DiagramColumnContainer [read-only] Returns the parent DiagramColumnContainer instance containing this DiagramColumn.	DiagramColumn
		dataobjectid : String	DiagramColumn
		defaultHeight : Number Default height of this DiagramColumn	DiagramColumn
		defaultWidth : Number Default width of this DiagramColumn	DiagramColumn
		diagramGroupChildren : Array [read-only] Diagram Groups affiliated to this column	DiagramColumn
		diagramLinkChildren : Array [read-only] Diagram Links affiliated to this column	DiagramColumn
		_diagramOutLinks : Array	DiagramColumn
		diagramSpriteChildren : Array [read-only] Diagram Sprites affiliated to this column	DiagramColumn
		did : String 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).	DiagramColumn
		dragging : Boolean [read-only] Indicates whether this DiagramPanel component is currently being dragged.	DiagramColumn
		expandable : Boolean [read-only] Indicates whether this DiagramPanel can be expanded according to its dragging status and DiagramPanelsContainer children number.	DiagramColumn
		expandedwidth : Number Expanded width of this DiagramColumn	DiagramColumn
		isFirstColumn : Boolean [read-only] true if this column is the first one.	DiagramColumn
		isHighlighted : Boolean	DiagramColumn
		isLastColumn : Boolean [read-only] true if this column is the last or the only one.	DiagramColumn
		storedWidth : Number The stored DiagramColumn Width (generally used when exapnding a collapsed DiagramColumn).	DiagramColumn
		title : String	DiagramColumn
		view : DiagramView [read-only] The Diagram View Container.	DiagramColumn
		visiblecaption : Boolean Indicates whether this Diagram Column Caption is visible.	DiagramColumn

	Property	Defined by
		_alpha : uint Alpha percentage.	DiagramColumn
		_caption : DiagramColumnCaption = null Used DiagramColumnCaption.	DiagramColumn
		_collapsedwidth : Number ollapsed Width.	DiagramColumn
		_color : uint Background Color.	DiagramColumn
		_defaultheight : Number = 20 Default DiagramColumn height.	DiagramColumn
		_defaultwidth : Number Default DiagramColumn width.	DiagramColumn
		_dragging : Boolean = false Drag status of this DiagramPanel.	DiagramColumn
		_expandedwidth : Number xpanded Width.	DiagramColumn
		_height : Number = 0 Actual Height of this DiagramPanel component	DiagramColumn
		_resizeeffect : Resize = null Used resize effect for DiagramLane children.	DiagramColumn
		_storedwidth : Number Stored DiagramColumn width.	DiagramColumn
		_view : DiagramView = null The Diagram View in which this DiagramPanel is embedded.	DiagramColumn
		_width : Number = 0 Actual Width of this DiagramPanel component(gaps are counted)	DiagramColumn

	Method	Defined by
		DiagramColumn(view:DiagramView)	DiagramColumn
		activateUI(a:Boolean):void Activates or deactivates this DiagramColumn.	DiagramColumn
		addSibling():void Adds a new DiagramColumn to the parent DiagramColumnContainer component and updates the parent DiagramColumnContainer size.	DiagramColumn
		appendToSVGDocument(doc:SVGSVGElement):void Adds this Diagram Column in an SVG description to an SVGSVGElement (SVG document).	DiagramColumn
		checkTagName(xml:XML):Boolean Checks if an XML description is adequate to this DiagramLane instance by checking the tag name property.	DiagramColumn
		cleanup():void Cleans up listeners.	DiagramColumn
		clear():void	DiagramColumn
		close():void Removes Diagram Lane from its parent DiagramPanel component and resizes both.	DiagramColumn
		collapse():void Collapses this DiagramLane (resizing it to a collapsed size).	DiagramColumn
		computeContentDisplacement(offset:Number = 10):Number	DiagramColumn
		computeWidth(offset:Number = 10):Number	DiagramColumn
		disableListeners():void	DiagramColumn
		draw():void	DiagramColumn
		expand():void Expands this DiagramLane (resizing it to an expanded size).	DiagramColumn
		fitToContent(withAnimation:Boolean = true, customWidth:Number):void	DiagramColumn
		fromXML(xml:XML):void Parses this DiagramColumn (including the different layers) from an XML object.	DiagramColumn
		getTagName():String Returns this DiagramPanel tag name ("panel").	DiagramColumn
		initListeners():void	DiagramColumn
		libraryStylesChanged(event:SVGAssetLibraryEvent):void Redraws this DiagramColumn and its children when library styles and assets change given a SVGAssetLibraryEvent.	DiagramColumn
		panContent(displacementX:Number, displacementY:Number = 0, withAnimation:Boolean = true):void	DiagramColumn
		registerDiagramObject(object:DiagramObject):void	DiagramColumn
		registerDiagramOutLink(link:DiagramObject):void	DiagramColumn
		setActualSize(w:Number, h:Number):void	DiagramColumn
		styleChanged(prop:String):void Detects changes to style properties and handle the change accordingly.	DiagramColumn
		syncReferences():void Synchronize references when loading this DiagramColumn from a page.	DiagramColumn
		toXML():XML Writes this DiagramLane into an XML object.	DiagramColumn
		unRegisterDiagramObject(object:DiagramObject):DiagramObject	DiagramColumn
		updateGlobalLinksPlacement():void	DiagramColumn

	Method	Defined by
		clearChrome():void Removes the Chrome elements of this Diagram Panel.	DiagramColumn
		createChildren():void Creates DiagramColumn children.	DiagramColumn
		createChrome():void Creates the Chrome elements of this DiagramColumn component by defining the DiagramLaneCaption and listeners.	DiagramColumn
		endCloseEffectHandler(event:TweenEvent):void Removes this Diagram Lane from its parent Diagram Lane given a TweenEvent (generated by the `close` method).	DiagramColumn
		measure():void Calculates the default size (width and height), and optionally the default minimum size, of the Diagram Lane.	DiagramColumn
		moveHandler(event:MoveEvent):void	DiagramColumn
		removeHandler(event:FlexEvent):void Removes all listeners given a FlexEvent.	DiagramColumn
		resizeHandler(event:ResizeEvent):void	DiagramColumn
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void	DiagramColumn

Property detail

_alpha

property

protected var _alpha:uint

Alpha percentage.

_caption

property

protected var _caption:DiagramColumnCaption = null

Used DiagramColumnCaption.

caption

property

caption:DiagramColumnCaption [read-only]Implementation
public function get caption():DiagramColumnCaption

closeable

property

closeable:Boolean [read-only]

Indicates whether this DiagramPanel can be closed according to its dragging status and DiagramPanelsContainer children number.

Implementation
public function get closeable():Boolean

collapsable

property

collapsable:Boolean [read-only]

Indicates whether this DiagramPanel can be collapsed according to its dragging status and DiagramPanelsContainer children number.

Implementation
public function get collapsable():Boolean

collapsed

property

collapsed:Boolean [read-only]

Indicates whether this DiagramPanel component is currently collapsed .

Implementation
public function get collapsed():Boolean

_collapsedwidth

property

protected var _collapsedwidth:Number

ollapsed Width.

collapsedWidth

property

collapsedWidth:Number [read-write]

Collapsed width of this DiagramColumn

Implementation
public function get collapsedWidth():Number
public function set collapsedWidth(value:Number):void

_color

property

protected var _color:uint

Background Color.

columnIndex

property

columnIndex:int [read-only]

The index of this column.

Implementation
public function get columnIndex():int

container

property

container:DiagramColumnContainer [read-only]

Returns the parent DiagramColumnContainer instance containing this DiagramColumn.

Implementation
public function get container():DiagramColumnContainer

dataobjectid

property

dataobjectid:String  [read-write]Implementation
    public function get dataobjectid():String
    public function set dataobjectid(value:String):void

_defaultheight

property

protected var _defaultheight:Number = 20

Default DiagramColumn height.

defaultHeight

property

defaultHeight:Number [read-write]

Default height of this DiagramColumn

Implementation
public function get defaultHeight():Number
public function set defaultHeight(value:Number):void

_defaultwidth

property

protected var _defaultwidth:Number

Default DiagramColumn width.

defaultWidth

property

defaultWidth:Number [read-write]

Default width of this DiagramColumn

Implementation
public function get defaultWidth():Number
public function set defaultWidth(value:Number):void

diagramGroupChildren

property

diagramGroupChildren:Array [read-only]

Diagram Groups affiliated to this column

Implementation
public function get diagramGroupChildren():Array

diagramLinkChildren

property

diagramLinkChildren:Array [read-only]

Diagram Links affiliated to this column

Implementation
public function get diagramLinkChildren():Array

_diagramOutLinks

property

public var _diagramOutLinks:Array

diagramSpriteChildren

property

diagramSpriteChildren:Array [read-only]

Diagram Sprites affiliated to this column

Implementation
public function get diagramSpriteChildren():Array

did

property

did:String [read-write]

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
public function set did(value:String):void

_dragging

property

protected var _dragging:Boolean = false

Drag status of this DiagramPanel.

dragging

property

dragging:Boolean [read-only]

Indicates whether this DiagramPanel component is currently being dragged.

Implementation
public function get dragging():Boolean

expandable

property

expandable:Boolean [read-only]

Indicates whether this DiagramPanel can be expanded according to its dragging status and DiagramPanelsContainer children number.

Implementation
public function get expandable():Boolean

_expandedwidth

property

protected var _expandedwidth:Number

xpanded Width.

expandedwidth

property

expandedwidth:Number [read-write]

Expanded width of this DiagramColumn

Implementation
public function get expandedwidth():Number
public function set expandedwidth(value:Number):void

_height

property

protected var _height:Number = 0

Actual Height of this DiagramPanel component

isFirstColumn

property

isFirstColumn:Boolean [read-only]

true if this column is the first one.

Implementation
public function get isFirstColumn():Boolean

isHighlighted

property

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

isLastColumn

property

isLastColumn:Boolean [read-only]

true if this column is the last or the only one.

Implementation
public function get isLastColumn():Boolean

_resizeeffect

property

protected var _resizeeffect:Resize = null

Used resize effect for DiagramLane children.

_storedwidth

property

protected var _storedwidth:Number

Stored DiagramColumn width.

storedWidth

property

storedWidth:Number [read-write]

The stored DiagramColumn Width (generally used when exapnding a collapsed DiagramColumn).

Implementation
public function get storedWidth():Number
public function set storedWidth(value:Number):void

title

property

title:String  [read-write]Implementation
    public function get title():String
    public function set title(value:String):void

_view

property

protected var _view:DiagramView = null

The Diagram View in which this DiagramPanel is embedded.

view

property

view:DiagramView [read-only]

The Diagram View Container.

Implementation
public function get view():DiagramView

visiblecaption

property

visiblecaption:Boolean [read-write]

Indicates whether this Diagram Column Caption is visible.

Implementation
public function get visiblecaption():Boolean
public function set visiblecaption(value:Boolean):void

_width

property

protected var _width:Number = 0

Actual Width of this DiagramPanel component(gaps are counted)

Constructor detail

DiagramColumn

()

constructor

public function DiagramColumn(view:DiagramView)Parameters

view:DiagramView

Method detail

activateUI

()

method

public function activateUI(a:Boolean):void

Activates or deactivates this DiagramColumn. An activated DiagramColumn component interacts with mouse events and a deactivated one doesn't.

Parameters

a:Boolean — The desired value of the DiagramColumn active status.

addSibling

()

method

public function addSibling():void

Adds a new DiagramColumn to the parent DiagramColumnContainer component and updates the parent DiagramColumnContainer size.

appendToSVGDocument

()

method

public function appendToSVGDocument(doc:SVGSVGElement):void

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

Parameters

doc:SVGSVGElement — SVGSVGElement (SVG document) to be updated by adding this DiagramColumn.

checkTagName

()

method

public function checkTagName(xml:XML):Boolean

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

Parameters

xml:XML — Provided DiagramColumn Description

Returns

Boolean — Validity of the XML description (partial verification as it only checks the Tag Name).

cleanup

()

method

public function cleanup():void

Cleans up listeners.

clear

()

method

public function clear():void

clearChrome

()

method

protected function clearChrome():void

Removes the Chrome elements of this Diagram Panel.

()

method

public function close():void

Removes Diagram Lane from its parent DiagramPanel component and resizes both.

collapse

()

method

public function collapse():void

Collapses this DiagramLane (resizing it to a collapsed size). The operation affects the Panel container size.

computeContentDisplacement

()

method

public function computeContentDisplacement(offset:Number = 10):NumberParameters

offset:Number (default = 10)

Returns

Number

computeWidth

()

method

public function computeWidth(offset:Number = 10):NumberParameters

offset:Number (default = 10)

Returns

Number

createChildren

()

method

protected override function createChildren():void

Creates DiagramColumn children. They are listed as follows:

Links layer (as a lane element can be connected to another one)
Chrome: Mask, Caption(DiagramPanelCaption component), Border (Diagram Lane Border)
Listeners: resize, move, scroll, close and divide handlers.

createChrome

()

method

protected function createChrome():void

Creates the Chrome elements of this DiagramColumn component by defining the DiagramLaneCaption and listeners.

disableListeners

()

method

public function disableListeners():void

draw

()

method

public function draw():void

endCloseEffectHandler

()

method

protected function endCloseEffectHandler(event:TweenEvent):void

Removes this Diagram Lane from its parent Diagram Lane given a TweenEvent (generated by the close method).

Parameters

event:TweenEvent — Detected Tween Event.

expand

()

method

public function expand():void

Expands this DiagramLane (resizing it to an expanded size). The operation affects the Panel container size.

fitToContent

()

method

public function fitToContent(withAnimation:Boolean = true, customWidth:Number):voidParameters

	`withAnimation:Boolean` (default = `true`)

	`customWidth:Number`

fromXML

()

method

public function fromXML(xml:XML):void

Parses this DiagramColumn (including the different layers) from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramColumn.

getTagName

()

method

public function getTagName():String

Returns this DiagramPanel tag name ("panel").

Returns

String — Diagram Panel Tag Name.

initListeners

()

method

public function initListeners():void

libraryStylesChanged

()

method

public function libraryStylesChanged(event:SVGAssetLibraryEvent):void

Redraws this DiagramColumn 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

Calculates the default size (width and height), and optionally the default minimum size, of the Diagram Lane.

moveHandler

()

method

protected function moveHandler(event:MoveEvent):voidParameters

event:MoveEvent

panContent

()

method

public function panContent(displacementX:Number, displacementY:Number = 0, withAnimation:Boolean = true):voidParameters

	`displacementX:Number`

	`displacementY:Number` (default = `0`)

	`withAnimation:Boolean` (default = `true`)

registerDiagramObject

()

method

public function registerDiagramObject(object:DiagramObject):voidParameters

object:DiagramObject

registerDiagramOutLink

()

method

public function registerDiagramOutLink(link:DiagramObject):voidParameters

link:DiagramObject

removeHandler

()

method

protected function removeHandler(event:FlexEvent):void

Removes all listeners given a FlexEvent.

Parameters

event:FlexEvent — Detected Flex Event.

resizeHandler

()

method

protected function resizeHandler(event:ResizeEvent):voidParameters

event:ResizeEvent

setActualSize

()

method

public override function setActualSize(w:Number, h:Number):voidParameters

	`w:Number`

	`h:Number`

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 DiagramColumn have changed.

syncReferences

()

method

public function syncReferences():void

Synchronize references when loading this DiagramColumn from a page.

toXML

()

method

public function toXML():XML

Writes this DiagramLane into an XML object.

Returns

XML — An XML object representing this DiagramLane.

unRegisterDiagramObject

()

method

public function unRegisterDiagramObject(object:DiagramObject):DiagramObjectParameters

object:DiagramObject

Returns

DiagramObject

updateDisplayList

()

method

protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters

	`unscaledWidth:Number`

	`unscaledHeight:Number`

updateGlobalLinksPlacement

()

method

public function updateGlobalLinksPlacement():void

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class DiagramColumn	Properties \| Methods

Package	com.kapit.diagram.layers
Class	public class DiagramColumn
Inheritance	DiagramColumn mx.core.UIComponent
Implements	IDiagramElement, ISVGExportable