| Package | com.kapit.diagram.layers |
| Class | public class DiagramColumnContainer |
| Inheritance | DiagramColumnContainer mx.containers.HDividedBox |
| Implements | IDiagramElement, ISVGExportable |
| Property | Defined 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 | ||
| Property | Defined 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 | ||
| Method | Defined 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 | ||
|
getColumnAt(idx:uint):DiagramColumn
| DiagramColumnContainer | ||
|
getColumnUnderPoint(point:Point):DiagramColumn
| DiagramColumnContainer | ||
|
getTagName():String
Returns the diagramColumnContainer tag name ("columns").
| DiagramColumnContainer | ||
|
handleColumnResizing(column:DiagramColumn):void
| DiagramColumnContainer | ||
|
highlightColumn(column:DiagramColumn):void
| DiagramColumnContainer | ||
|
libraryStylesChanged(event:SVGAssetLibraryEvent):void
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 | ||
|
removeColumn(idx:int):DiagramColumn
| 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 | ||
|
syncReferences():void
| DiagramColumnContainer | ||
|
toXML():XML
Writes this DiagramColumnContainer into an XML object.
| DiagramColumnContainer | ||
|
unRegisterDiagramObject(object:DiagramObject):void
| DiagramColumnContainer | ||
|
updateGlobalLinksPlacement():void
| DiagramColumnContainer | ||
| Method | Defined by | ||
|---|---|---|---|
|
createChildren():void
| DiagramColumnContainer | ||
|
dividerReleaseHandler(event:DividerEvent):void
| DiagramColumnContainer | ||
|
endResizeEffectHandler(event:TweenEvent):void
| DiagramColumnContainer | ||
|
inhibitPercentSizes():void
| DiagramColumnContainer | ||
|
measure():void
| DiagramColumnContainer | ||
|
removeHandler(event:FlexEvent):void
Removes all listeners given a FlexEvent.
| DiagramColumnContainer | ||
|
updateCaptionsVisibility():void
| DiagramColumnContainer | ||
|
updateDisplayList(w:Number, h:Number):void
| DiagramColumnContainer | ||
| _bordercolor | property |
protected var _bordercolor:uintThis DiagramColumnContainer border color.
| bordercolor | property |
bordercolor:uint [read-only]private Border column color.
Implementation public function get bordercolor():uint
| _borderwidth | property |
protected var _borderwidth:NumberThis DiagramColumnContainer border width.
| columnbackground | property |
columnbackground:BitmapAsset [read-only]private Column default background.
Implementation public function get columnbackground():BitmapAsset
| dataobjectid | property |
dataobjectid:String [read-write]Implementation
public function get dataobjectid():String
public function set dataobjectid(value:String):void
| defaultHeight | property |
defaultHeight:Number [read-write]Default height of this DiagramColumnContainer
Implementation public function get defaultHeight():Number
public function set defaultHeight(value:Number):void
| did | property |
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
| _draggingcolumn | property |
protected var _draggingcolumn:DiagramColumn = nullThe DiagramColumn currently being dragged.
| draggingcolumn | property |
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
| _highlightedColumn | property |
protected var _highlightedColumn:DiagramColumnHighlighted Column.
| printcolor | property |
printcolor:uint [read-only]
private
Print color background used for SVG export. It can be used when the columnbackground property is null.
public function get printcolor():uint
| _resizeeffect | property |
protected var _resizeeffect:Resize = nullUsed resize effect for DiagramLane children.
| scaleX | property |
scaleX:Number [write-only]Implementation
public function set scaleX(value:Number):void
| scaleY | property |
scaleY:Number [write-only]Implementation
public function set scaleY(value:Number):void
| _topleftHeader | property |
protected var _topleftHeader:DiagramColumnHeader = null
| _totalwidth | property |
protected var _totalwidth:Number = 0Actual width of this DiagramColumnContainer component
| _view | property |
protected var _view:DiagramView = nullThe Diagram View in which this DiagramPanel is embedded.
| view | property |
view:DiagramView [read-only]The Diagram View Container.
Implementation public function get view():DiagramView
| DiagramColumnContainer | () | constructor |
| 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 |
DisplayObject |
| appendToSVGDocument | () | method |
public function appendToSVGDocument(doc:SVGSVGElement):voidAdds this Diagram Column Container in an SVG description to an SVGSVGElement (SVG document).
Parametersdoc:SVGSVGElement — SVGSVGElement (SVG document) to be updated by adding this DiagramColumnContainer.
|
| checkTagName | () | method |
public function checkTagName(xml:XML):BooleanChecks if an XML description is adequate to this DiagramColumnContainer instance by checking the tag name property.
Parametersxml:XML — Provided DiagramColumnContainer description
|
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) |
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):voidParses this DiagramColumnContainer from an XML object.
Parametersxml:XML — An XML object represeting this DiagramColumnContainer.
|
| getColumnAt | () | method |
| getColumnUnderPoint | () | method |
public function getColumnUnderPoint(point:Point):DiagramColumnParameters
point:Point |
DiagramColumn |
| getTagName | () | method |
public function getTagName():StringReturns the diagramColumnContainer tag name ("columns").
ReturnsString — DiagramColumnContainer Tag Name.
|
| handleColumnResizing | () | method |
| highlightColumn | () | method |
| inhibitPercentSizes | () | method |
protected function inhibitPercentSizes():void
| libraryStylesChanged | () | method |
public function libraryStylesChanged(event:SVGAssetLibraryEvent):voidRedraws this DiagramColumnContainer and its children when library styles and assets change given a SVGAssetLibraryEvent.
Parametersevent: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 |
DisplayObject |
| removeColumn | () | method |
| removeHandler | () | method |
protected function removeHandler(event:FlexEvent):voidRemoves all listeners given a FlexEvent.
Parametersevent: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):voidEnables scrolling inside the DiagramPanelsContainer component (for viewing children Diagram Panels).
Parametersevent: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.
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():XMLWrites this DiagramColumnContainer into an XML object.
ReturnsXML — An XML object representing this DiagramColumnContainer.
|
| unRegisterDiagramObject | () | method |
| 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