Packagecom.kapit.diagram.controls
Classpublic class GriddedButton
InheritanceGriddedButton Inheritance mx.core.UIComponent



Public Properties
 PropertyDefined by
  cellmargin : Number
A number indicating the GriddedButton cell margin.
GriddedButton
  cellsize : Number
A number indicating the GriddedButton cell size.
GriddedButton
  collapsed : Boolean
A boolean value indicating whether the Gridded button is collapsed or not.
GriddedButton
  data : Array
an array containing all the GriddedButton children of this GriddedButton.
GriddedButton
  icon : Class
Name of the class to be used as default icon.
GriddedButton
  index : int
Index of this GriddedButton.
GriddedButton
  selectedindex : int
[read-only] Index of the selected GriddedButton.
GriddedButton
  selecteditem : *
[read-only] The selected GriddedButton.
GriddedButton
Protected Properties
 PropertyDefined by
  _activated : Boolean = false
GriddedButton
  _cellmargin : Number = 2
GriddedButton
  _cellsize : Number = 20
GriddedButton
  _collapsed : Boolean = true
GriddedButton
  _data : Array
GriddedButton
  _delayedrollout : uint = 0
GriddedButton
  _delayedrollover : uint = 0
GriddedButton
  _iconclass : Class
GriddedButton
  _icons : Array = null
GriddedButton
  _index : int = -1
GriddedButton
  _mousecatcher : Sprite = null
GriddedButton
  _ncolumns : uint
GriddedButton
  _nrows : uint
GriddedButton
  _pushedicon : IFlexDisplayObject = null
GriddedButton
  _rollouteffect : MaskFX
GriddedButton
  _rollovereffect : MaskFX
GriddedButton
  _selectedindex : int = -1
GriddedButton
Public Methods
 MethodDefined by
  
Creates a new GriddedButton instance.
GriddedButton
  
activate(a:Boolean):void
Activates or deactivates the GriddedButton object.
GriddedButton
Protected Methods
 MethodDefined by
  
_drawSelection(sel:Object, s:Boolean):void
GriddedButton
  
changeSelection(idx:int):void
GriddedButton
  
clear():void
GriddedButton
  
collapse(c:Boolean):void
Collapses or expands the GriddedButton playing the roll out and roll over effects if they are defined.
GriddedButton
  
Creates child objects of the component.
GriddedButton
  
createMask():FlexShape
GriddedButton
  
GriddedButton
  
drawSelection(s:Boolean):void
GriddedButton
  
effectEndHandler(event:EffectEvent):void
GriddedButton
  
effectStartHandler(event:EffectEvent):void
GriddedButton
  
getMask(targ:Object, bounds:Rectangle):Shape
GriddedButton
  
getSelection(x:Number, y:Number):Object
GriddedButton
  
initEffects():void
GriddedButton
  
initGrid():void
Initializes the GriddedButton and adds its GriddedButton children.
GriddedButton
  
measure():void
Calculates the default size of the GriddedButton.
GriddedButton
  
mouseDownHandler(event:MouseEvent):void
GriddedButton
  
mouseMoveHandler(event:MouseEvent):void
GriddedButton
  
mouseUpHandler(event:MouseEvent):void
GriddedButton
  
pushIcon():void
GriddedButton
  
releaseIcon():void
GriddedButton
  
rollOutHandler(event:MouseEvent):void
GriddedButton
  
rollOverHandler(event:MouseEvent):void
GriddedButton
Property detail
_activatedproperty
protected var _activated:Boolean = false
_cellmarginproperty 
protected var _cellmargin:Number = 2
cellmarginproperty 
cellmargin:Number  [read-write]

A number indicating the GriddedButton cell margin.

Implementation
    public function get cellmargin():Number
    public function set cellmargin(value:Number):void
_cellsizeproperty 
protected var _cellsize:Number = 20
cellsizeproperty 
cellsize:Number  [read-write]

A number indicating the GriddedButton cell size.

Implementation
    public function get cellsize():Number
    public function set cellsize(value:Number):void
_collapsedproperty 
protected var _collapsed:Boolean = true
collapsedproperty 
collapsed:Boolean  [read-write]

A boolean value indicating whether the Gridded button is collapsed or not.

Implementation
    public function get collapsed():Boolean
    public function set collapsed(value:Boolean):void
_dataproperty 
protected var _data:Array
dataproperty 
data:Array  [read-write]

an array containing all the GriddedButton children of this GriddedButton.

Implementation
    public function get data():Array
    public function set data(value:Array):void
_delayedrolloutproperty 
protected var _delayedrollout:uint = 0
_delayedrolloverproperty 
protected var _delayedrollover:uint = 0
iconproperty 
icon:Class  [read-write]

Name of the class to be used as default icon.

Implementation
    public function get icon():Class
    public function set icon(value:Class):void
_iconclassproperty 
protected var _iconclass:Class
_iconsproperty 
protected var _icons:Array = null
_indexproperty 
protected var _index:int = -1
indexproperty 
index:int  [read-write]

Index of this GriddedButton.

Implementation
    public function get index():int
    public function set index(value:int):void
_mousecatcherproperty 
protected var _mousecatcher:Sprite = null
_ncolumnsproperty 
protected var _ncolumns:uint
_nrowsproperty 
protected var _nrows:uint
_pushediconproperty 
protected var _pushedicon:IFlexDisplayObject = null
_rollouteffectproperty 
protected var _rollouteffect:MaskFX
_rollovereffectproperty 
protected var _rollovereffect:MaskFX
_selectedindexproperty 
protected var _selectedindex:int = -1
selectedindexproperty 
selectedindex:int  [read-only]

Index of the selected GriddedButton.

Implementation
    public function get selectedindex():int
selecteditemproperty 
selecteditem:*  [read-only]

The selected GriddedButton.

Implementation
    public function get selecteditem():*
Constructor detail
GriddedButton()constructor
public function GriddedButton()

Creates a new GriddedButton instance.

Method detail
_drawSelection()method
protected function _drawSelection(sel:Object, s:Boolean):voidParameters
sel:Object
 
s:Boolean
activate()method 
public function activate(a:Boolean):void

Activates or deactivates the GriddedButton object. An activated GriddedButton object interacts with mouse events and a deactivated GriddedButton object doesn't interact with mouse events.

Parameters
a:Boolean — The desired value of the GriddedButton active status.
changeSelection()method 
protected function changeSelection(idx:int):voidParameters
idx:int
clear()method 
protected function clear():void
collapse()method 
protected function collapse(c:Boolean):void

Collapses or expands the GriddedButton playing the roll out and roll over effects if they are defined.

Parameters
c:Boolean — If the parameter c is equal to true the the GriddedButton is collapsed. If it is equal to false the the GriddedButton is expanded.
createChildren()method 
protected override function createChildren():void

Creates child objects of the component.

createMask()method 
protected function createMask():FlexShape

Returns
FlexShape
createMouseCatcher()method 
protected function createMouseCatcher():void
drawSelection()method 
protected function drawSelection(s:Boolean):voidParameters
s:Boolean
effectEndHandler()method 
protected function effectEndHandler(event:EffectEvent):voidParameters
event:EffectEvent
effectStartHandler()method 
protected function effectStartHandler(event:EffectEvent):voidParameters
event:EffectEvent
getMask()method 
protected function getMask(targ:Object, bounds:Rectangle):ShapeParameters
targ:Object
 
bounds:Rectangle

Returns
Shape
getSelection()method 
protected function getSelection(x:Number, y:Number):ObjectParameters
x:Number
 
y:Number

Returns
Object
initEffects()method 
protected function initEffects():void
initGrid()method 
protected function initGrid():void

Initializes the GriddedButton and adds its GriddedButton children.

measure()method 
protected override function measure():void

Calculates the default size of the GriddedButton.

mouseDownHandler()method 
protected function mouseDownHandler(event:MouseEvent):voidParameters
event:MouseEvent
mouseMoveHandler()method 
protected function mouseMoveHandler(event:MouseEvent):voidParameters
event:MouseEvent
mouseUpHandler()method 
protected function mouseUpHandler(event:MouseEvent):voidParameters
event:MouseEvent
pushIcon()method 
protected function pushIcon():void
releaseIcon()method 
protected function releaseIcon():void
rollOutHandler()method 
protected function rollOutHandler(event:MouseEvent):voidParameters
event:MouseEvent
rollOverHandler()method 
protected function rollOverHandler(event:MouseEvent):voidParameters
event:MouseEvent