Packagecom.kapit.diagram.layers
Classpublic class DiagramPanelCaption
InheritanceDiagramPanelCaption Inheritance mx.core.UIComponent
ImplementsISVGExportable



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

Add button.

_bordercolorproperty 
protected var _bordercolor:uint

This DiagramPanelCaption border color.

bordercolorproperty 
bordercolor:uint  [read-only]

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

This DiagramPanelCaption 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 DiagramPanelCaption is currently collapsed.

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

This DiagramPanelCaption collapsed size (Height).

collapsedsizeproperty 
collapsedsize:Number  [read-write]

The DiagramPanel component size (Height) at collapsed status.

Implementation
    public function get collapsedsize():Number
    public function set collapsedsize(value:Number):void
containerproperty 
container:DiagramPanelsContainer  [read-only]

Returns DiagramPanelsContainer containing this DiagramPanelCaption.

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

Expand button.

_expandedsizeproperty 
protected var _expandedsize:Number

This DiagramPanelCaption expanded size (Height).

expandedsizeproperty 
expandedsize:Number  [read-write]

The DiagramPanel component size (Height) 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 DiagramPanelCaption.

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.

panelproperty 
panel:DiagramPanel  [read-only]

The parent DiagramPanel component to which this DiagramPanelCaption depends.

Implementation
    public function get panel():DiagramPanel
_printcolorproperty 
protected var _printcolor:Number

Used Print Color in TextField.

_titleproperty 
protected var _title:String = "null"

DiagramLaneCaption (also DiagramLane) title that can be set by the user.

titleproperty 
title:String  [read-write]

DiagramPanelCaption Title (title of the DiagramPanel component) displayed in the Label field of this DiagramPanelCaption.

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
DiagramPanelCaption()constructor
public function DiagramPanelCaption(view:DiagramView)

Creates a new DiagramPanelCaption instance.

Parameters
view:DiagramView — DiagramView that contains this DiagramPanelCaption.
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 DiagramPanelCaption instance in an SVG description to an SVGSVGElement (SVG document).

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

Handles interaction with the "Close" button and removes the DiagramPanel 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 DiagramPanel component "panel".

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

Creates DiagramPanelCaption children. They can be listed as follows:

draw()method 
public function draw():void

Draws this DiagramPanelCaption 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.

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

Handles interaction with the "Expand" button and expands the DiagramPanel 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 DiagramPanelCaption.

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

Draws this DiagramPanelCaption and/or sizes and positions its children. This method is called when this DiagramPanelCaption 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 DiagramPanelCaption, in pixels, in the component's coordinates, regardless of the value of the scaleX property of this DiagramPanelCaption.
 
h:Number — Specifies the height of this DiagramPanelCaption, in pixels, in the component's coordinates, regardless of the value of the scaleY property of this DiagramPanelCaption.