Packagecom.kapit.diagram.layers
Classpublic class DiagramColumnCaption
InheritanceDiagramColumnCaption Inheritance mx.core.UIComponent
ImplementsISVGExportable



Public Properties
 PropertyDefined by
  bordercolor : uint
[read-only]
DiagramColumnCaption
  borderwidth : Number
[read-only]
DiagramColumnCaption
  collapsed : Boolean
[read-only] Indicates whether the DiagramColumnCaption is currently collapsed.
DiagramColumnCaption
  collapsedsize : Number
The DiagramColumn component size (Width) at collapsed status.
DiagramColumnCaption
  column : DiagramColumn
[read-only] The parent DiagramColumn component to which this DiagramColumnCaption depends.
DiagramColumnCaption
  container : DiagramColumnContainer
[read-only] Returns DiagramColumnsContainer containing this DiagramColumnCaption.
DiagramColumnCaption
  expandedsize : Number
The DiagramColumn component size (Width) at expanded status.
DiagramColumnCaption
  fontcolor : Number
The font color used by this DiagramColumnCaption.
DiagramColumnCaption
  title : String
DiagramColumnCaption Title (title of the DiagramColumn component) displayed in the Label field of this DiagramColumnCaption.
DiagramColumnCaption
  view : DiagramView
[read-only] The Diagram View Container.
DiagramColumnCaption
Protected Properties
 PropertyDefined by
  _addbut : CaptionButton = null
Add button.
DiagramColumnCaption
  arrowwidth : Number = 20
DiagramColumnCaption
  _bordercolor : uint
This DiagramColumnCaption border color.
DiagramColumnCaption
  _borderwidth : Number
This DiagramColumnCaption border width.
DiagramColumnCaption
  _closebut : CaptionButton = null
Close button.
DiagramColumnCaption
  _collapsebut : CaptionButton = null
Collapse button.
DiagramColumnCaption
  _collapsedsize : Number
This DiagramColumnCaption collapsed size (Height).
DiagramColumnCaption
  _expandbut : CaptionButton = null
Expand button.
DiagramColumnCaption
  _expandedsize : Number
This DiagramColumnCaption expanded size (Height).
DiagramColumnCaption
  _fontcolor : Number
Used Font Color in TextField.
DiagramColumnCaption
  _fontsize : Number
Used Font size in TextField.
DiagramColumnCaption
  _format : TextFormat
Used TextFormat
DiagramColumnCaption
  _label : TextField
Title TextField.
DiagramColumnCaption
  _printcolor : Number
Used Print Color in TextField.
DiagramColumnCaption
  _title : String = "null"
DiagramColumnCaption title that can be set by the user.
DiagramColumnCaption
  _view : DiagramView
The Diagram View in which this DiagramPanelCaption is embedded.
DiagramColumnCaption
Public Methods
 MethodDefined by
  
Creates a new DiagramColumnCaption instance.
DiagramColumnCaption
  
appendToSVGDocument(doc:SVGSVGElement):void
Adds this DiagramColumnCaption instance in an SVG description to an SVGSVGElement (SVG document).
DiagramColumnCaption
  
draw():void
Draws this DiagramColumnCaption according to its status (collapsed or expanded).
DiagramColumnCaption
  
DiagramColumnCaption
Protected Methods
 MethodDefined by
  
addSiblingHandler(event:MouseEvent):void
Handles interaction with the "Add" button and creates a new DiagramPanel component inside the DiagramPanelsContainer containing this DiagramPanelCaption.
DiagramColumnCaption
  
closeHandler(event:MouseEvent):void
Handles interaction with the "Close" button and removes the DiagramColumn component "panel" from its container.
DiagramColumnCaption
  
collapseHandler(event:MouseEvent):void
Handles interaction with the "Expand" button and collapses the DiagramColumn component "panel".
DiagramColumnCaption
  
Creates DiagramColumnCaption children.
DiagramColumnCaption
  
expandHandler(event:MouseEvent):void
Handles interaction with the "Expand" button and expands the DiagramColumn component "panel".
DiagramColumnCaption
  
measure():void
Calculates the default size (width and height), and optionally the default minimum size, of this DiagramColumnCaption.
DiagramColumnCaption
  
updateDisplayList(w:Number, h:Number):void
Draws this DiagramColumnCaption and/or sizes and positions its children.
DiagramColumnCaption
Property detail
_addbutproperty
protected var _addbut:CaptionButton = null

Add button.

arrowwidthproperty 
protected var arrowwidth:Number = 20
_bordercolorproperty 
protected var _bordercolor:uint

This DiagramColumnCaption border color.

bordercolorproperty 
bordercolor:uint  [read-only]

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

This DiagramColumnCaption border width.

borderwidthproperty 
borderwidth:Number  [read-only]

Implementation
    public function get borderwidth():Number
_closebutproperty 
protected var _closebut:CaptionButton = null

Close button.

_collapsebutproperty 
protected var _collapsebut:CaptionButton = null

Collapse button.

collapsedproperty 
collapsed:Boolean  [read-only]

Indicates whether the DiagramColumnCaption is currently collapsed.

Implementation
    public function get collapsed():Boolean
_collapsedsizeproperty 
protected var _collapsedsize:Number

This DiagramColumnCaption collapsed size (Height).

collapsedsizeproperty 
collapsedsize:Number  [read-write]

The DiagramColumn component size (Width) at collapsed status.

Implementation
    public function get collapsedsize():Number
    public function set collapsedsize(value:Number):void
columnproperty 
column:DiagramColumn  [read-only]

The parent DiagramColumn component to which this DiagramColumnCaption depends.

Implementation
    public function get column():DiagramColumn
containerproperty 
container:DiagramColumnContainer  [read-only]

Returns DiagramColumnsContainer containing this DiagramColumnCaption.

Implementation
    public function get container():DiagramColumnContainer
_expandbutproperty 
protected var _expandbut:CaptionButton = null

Expand button.

_expandedsizeproperty 
protected var _expandedsize:Number

This DiagramColumnCaption expanded size (Height).

expandedsizeproperty 
expandedsize:Number  [read-write]

The DiagramColumn component size (Width) at expanded status.

Implementation
    public function get expandedsize():Number
    public function set expandedsize(value:Number):void
_fontcolorproperty 
protected var _fontcolor:Number

Used Font Color in TextField.

fontcolorproperty 
fontcolor:Number  [read-write]

The font color used by this DiagramColumnCaption.

Implementation
    public function get fontcolor():Number
    public function set fontcolor(value:Number):void
_fontsizeproperty 
protected var _fontsize:Number

Used Font size in TextField.

_formatproperty 
protected var _format:TextFormat

Used TextFormat

_labelproperty 
protected var _label:TextField

Title TextField.

_printcolorproperty 
protected var _printcolor:Number

Used Print Color in TextField.

_titleproperty 
protected var _title:String = "null"

DiagramColumnCaption title that can be set by the user.

titleproperty 
title:String  [read-write]

DiagramColumnCaption Title (title of the DiagramColumn component) displayed in the Label field of this DiagramColumnCaption.

Implementation
    public function get title():String
    public function set title(value:String):void
_viewproperty 
protected var _view:DiagramView

The Diagram View in which this DiagramPanelCaption is embedded.

viewproperty 
view:DiagramView  [read-only]

The Diagram View Container.

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

Creates a new DiagramColumnCaption instance.

Parameters
view:DiagramView — DiagramView that contains this DiagramColumnCaption.
Method detail
addSiblingHandler()method
protected function addSiblingHandler(event:MouseEvent):void

Handles interaction with the "Add" button and creates a new DiagramPanel component inside the DiagramPanelsContainer containing this DiagramPanelCaption.

Parameters
event:MouseEvent — Detected Mouse Event.
appendToSVGDocument()method 
public function appendToSVGDocument(doc:SVGSVGElement):void

Adds this DiagramColumnCaption instance in an SVG description to an SVGSVGElement (SVG document).

Parameters
doc:SVGSVGElement — SVGSVGElement (SVG document) to be updated by adding this DiagramColumnCaption.
closeHandler()method 
protected function closeHandler(event:MouseEvent):void

Handles interaction with the "Close" button and removes the DiagramColumn component "panel" from its container.

Parameters
event:MouseEvent — Detected Mouse Event.
collapseHandler()method 
protected function collapseHandler(event:MouseEvent):void

Handles interaction with the "Expand" button and collapses the DiagramColumn component "panel".

Parameters
event:MouseEvent — Detected Mouse Event.
createChildren()method 
protected override function createChildren():void

Creates DiagramColumnCaption children. They can be listed as follows:

draw()method 
public function draw():void

Draws this DiagramColumnCaption according to its status (collapsed or expanded). The call of the invalidateDisplayList() method is aimed at executing the component's updateDisplayList() method at the next screen update.

drawHighlight()method 
public function drawHighlight():void
expandHandler()method 
protected function expandHandler(event:MouseEvent):void

Handles interaction with the "Expand" button and expands the DiagramColumn component "panel".

Parameters
event:MouseEvent — Detected Mouse Event.
measure()method 
protected override function measure():void

Calculates the default size (width and height), and optionally the default minimum size, of this DiagramColumnCaption.

updateDisplayList()method 
protected override function updateDisplayList(w:Number, h:Number):void

Draws this DiagramColumnCaption and/or sizes and positions its children. This method is called when this DiagramColumnCaption is added to a container using the addChild method, and when the component's invalidateDisplayList method is called.

Parameters
w:Number — Specifies the width of this DiagramColumnCaption, in pixels, in the component's coordinates, regardless of the value of the scaleX property of this DiagramColumnCaption.
 
h:Number — Specifies the height of this DiagramColumnCaption, in pixels, in the component's coordinates, regardless of the value of the scaleY property of this DiagramColumnCaption.