Packagedigicrafts.flash.controls
Classpublic class DockMenu3D
InheritanceDockMenu3D Inheritance AlbumComponentBase Inheritance digicrafts.flash.core.UIComponentBase



Public Properties
 PropertyDefined by
  allowMutipleSelection : Boolean
Gets or sets the allowMutipleSelection property.
DockMenu3D
 Inheritedautostart : Boolean
AlbumComponentBase
 InheritedbufferCount : Number
Gets or sets the bufferCount property.
AlbumComponentBase
  cameraAngle : Number
Gets or sets the cameraAngle property.
DockMenu3D
 InheriteddataProvider : Array
DataProvider
AlbumComponentBase
  defaultMaterialColor : Number
Gets or sets the defaultMaterialColor property.
DockMenu3D
  defaultTooltipFormat : Object
Gets or sets the tooltipDistance property.
DockMenu3D
  dockAutoSize : Boolean
Gets or sets the dockEnabled property.
DockMenu3D
  dockBackground : *
[write-only]
DockMenu3D
  dockColor : uint
Gets or sets the dockColor property.
DockMenu3D
  dockEnabled : Boolean
Gets or sets the dockEnabled property.
DockMenu3D
  dockSelectedIndicator : *
[write-only]
DockMenu3D
  dockSideColor : uint
Gets or sets the dockSideColor property.
DockMenu3D
  dockThickness : Number
Gets or sets the dockThickness property.
DockMenu3D
  dockWidth : Number
Gets or sets the dockWidth property.
DockMenu3D
  focusDistance : Number
Gets or sets the focusDistance property.
DockMenu3D
  indicatorPosition : Object
DockMenu3D
  itemAnimationType : Number
Gets or sets the itemAnimationType property.
DockMenu3D
  itemClickLinkEnabled : Boolean
Gets or sets the itemClickLinkEnabled property.
DockMenu3D
  itemClickSelectionEnabled : Boolean
Gets or sets the itemClickSelectionEnabled property.
DockMenu3D
  itemDepth : Number
Gets or sets the itemDepth property.
DockMenu3D
  itemDistance : Number
Gets or sets the itemScaleRatio property.
DockMenu3D
  itemHeight : Number
Gets or sets the itemHeight property.
DockMenu3D
  itemOverColor : Number
Gets or sets the itemOverColor property.
DockMenu3D
  itemOverColorSize : Number
Gets or sets the itemOverColorSize property.
DockMenu3D
  itemOverGlowEnabled : Boolean
Gets or sets the itemOverGlowEnabled property.
DockMenu3D
  itemWidth : Number
Gets or sets the itemWidth property.
DockMenu3D
 InheritedloaderSkin : String
Gets or sets the defaultLoaderSkin property.
AlbumComponentBase
  magnification : Number
Gets or sets the magnification property.
DockMenu3D
 Inheritedproxy : String
Gets or sets the proxy property.
AlbumComponentBase
 Inheritedquality : uint
Gets or sets the quality property.
AlbumComponentBase
  radius : Number
Gets or sets the radius property.
DockMenu3D
  reflection : Number
Gets or sets the itemAlpha property.
DockMenu3D
  scale : Number
Gets or sets the scale property.
DockMenu3D
  selectedItem : Object
[read-only] Return the data of selected item
DockMenu3D
  selectedItemIndex : Number
Gets or sets the selectedItemIndex property.
DockMenu3D
  selectedItems : Array
[read-only] Return the array of data for mutiple selected item.
DockMenu3D
  shadow : Number
Gets or sets the shadow property.
DockMenu3D
 Inheritedsmoothing : Boolean
Gets or sets the smoothing property.
AlbumComponentBase
 Inheritedsource : Object
Gets or sets the source property.
AlbumComponentBase
  tooltip : Tooltip
[read-only] Gets or sets the tooltip property.
DockMenu3D
  tooltipAlign : String
Gets or sets the tooltipAlign property.
DockMenu3D
  tooltipDistance : Number
Gets or sets the tooltipDistance property.
DockMenu3D
  tooltipMode : uint
Gets or sets the tooltipMode property.
DockMenu3D
  UI_NAME : String
DockMenu3D
 InheriteduseThumbnail : Boolean
Gets or sets the useThumbnail property.
AlbumComponentBase
Public Methods
 MethodDefined by
  
DockMenu3D
 Inherited
load(source:*):void
Load source and start the component
AlbumComponentBase
 Inherited
unload():void
Unload the items and delete all object
AlbumComponentBase
Events
 EventSummaryDefined by
   Dispatched when the animation of the item completed.DockMenu3D
   Dispatched when the animation of the item started..DockMenu3D
 Inherited Dispatched when the buffering of resource completed This event will dispatch just after all resource buffereing completed.AlbumComponentBase
 Inherited Dispatched when error occured during buffering resource This event will dispatch if any error occur during the buffering process e.g.AlbumComponentBase
 Inherited Dispatched when the component start buffering resource.AlbumComponentBase
   Dispatched when mouse click on the item.DockMenu3D
   Dispatched when the item deselected This event will dispatch after the item is set to not selected.DockMenu3D
   Dispatched when mouse double click on the item.DockMenu3D
   Dispatched when mouse down inside an item.DockMenu3D
   Dispatched when mouse mouse outside an item.DockMenu3D
   Dispatched when mouse move inside an item.DockMenu3D
   Dispatched when mouse up occur after mouse down inside an item..DockMenu3D
   Dispatched when the item selected.DockMenu3D
 Inherited Dispatched when the source xml load complete.AlbumComponentBase
 Inherited Dispatched when error occur when loading xml.AlbumComponentBase
Property detail
allowMutipleSelectionproperty
allowMutipleSelection:Boolean  [read-write]

Gets or sets the allowMutipleSelection property. allowMutipleSelection property determine if it is allow mutiple selection.

The default value is true.

Implementation
    public function get allowMutipleSelection():Boolean
    public function set allowMutipleSelection(value:Boolean):void
cameraAngleproperty 
cameraAngle:Number  [read-write]

Gets or sets the cameraAngle property. cameraAngle property determine the camera view angle to the dock. Valid value between 0 - 90.

The default value is 30.

Implementation
    public function get cameraAngle():Number
    public function set cameraAngle(value:Number):void
defaultMaterialColorproperty 
defaultMaterialColor:Number  [read-write]

Gets or sets the defaultMaterialColor property. defaultMaterialColor property contain the color value of defaultitem material. The value should be int value.

The default value is 0x999999.

Implementation
    public function get defaultMaterialColor():Number
    public function set defaultMaterialColor(value:Number):void
defaultTooltipFormatproperty 
defaultTooltipFormat:Object  [read-write]

Gets or sets the tooltipDistance property. tooltipDistance property contain the object which set the default style of tooltip. { widthLimit:-1, tipSize:5, cornerRadius:10, padding:10, border:1.5, backgroundColor:'000000', backgroundAlpha:0.8, backgroundColor:'000000', borderColor:'FFFFFF', textColor:'FFFFFF' }

The default value is Object.

Implementation
    public function get defaultTooltipFormat():Object
    public function set defaultTooltipFormat(value:Object):void
dockAutoSizeproperty 
dockAutoSize:Boolean  [read-write]

Gets or sets the dockEnabled property. dockEnabled property determine the visibilty of dock panel.

The default value is true.

Implementation
    public function get dockAutoSize():Boolean
    public function set dockAutoSize(value:Boolean):void
dockBackgroundproperty 
dockBackground:*  [write-only]Implementation
    public function set dockBackground(value:*):void
dockColorproperty 
dockColor:uint  [read-write]

Gets or sets the dockColor property. dockColor property determine the color of the dock. The color will set only if dockBackground property is null.

The default value is 0xFFFFFF.

Implementation
    public function get dockColor():uint
    public function set dockColor(value:uint):void
dockEnabledproperty 
dockEnabled:Boolean  [read-write]

Gets or sets the dockEnabled property. dockEnabled property determine the visibilty of dock panel.

The default value is true.

Implementation
    public function get dockEnabled():Boolean
    public function set dockEnabled(value:Boolean):void
dockSelectedIndicatorproperty 
dockSelectedIndicator:*  [write-only]Implementation
    public function set dockSelectedIndicator(value:*):void
dockSideColorproperty 
dockSideColor:uint  [read-write]

Gets or sets the dockSideColor property. dockSideColor property determine the color of the dock's side

The default value is 0xFFFFFF.

Implementation
    public function get dockSideColor():uint
    public function set dockSideColor(value:uint):void
dockThicknessproperty 
dockThickness:Number  [read-write]

Gets or sets the dockThickness property. dockThickness property determine the thickness of the dock.

The default value is 3.

Implementation
    public function get dockThickness():Number
    public function set dockThickness(value:Number):void
dockWidthproperty 
dockWidth:Number  [read-write]

Gets or sets the dockWidth property. dockWidth property determine the width of the dock.

The default value is 100.

Implementation
    public function get dockWidth():Number
    public function set dockWidth(value:Number):void
focusDistanceproperty 
focusDistance:Number  [read-write]

Gets or sets the focusDistance property. focusDistance property determine the ditance between camera and dock.

The default value is 1000.

Implementation
    public function get focusDistance():Number
    public function set focusDistance(value:Number):void
indicatorPositionproperty 
indicatorPosition:Object  [read-write]Implementation
    public function get indicatorPosition():Object
    public function set indicatorPosition(value:Object):void
itemAnimationTypeproperty 
itemAnimationType:Number  [read-write]

Gets or sets the itemAnimationType property. itemAnimationType property determine the animation type of each item when selected. 0 : no animation 1: Bound 3 times 2: Bound infinity 3: Flip

The default value is 0.

Implementation
    public function get itemAnimationType():Number
    public function set itemAnimationType(value:Number):void
itemClickLinkEnabledproperty 
itemClickLinkEnabled:Boolean  [read-write]

Gets or sets the itemClickLinkEnabled property. itemClickLinkEnabled property determine if the item click to link action enabled.

The default value is false.

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

Gets or sets the itemClickSelectionEnabled property. itemClickSelectionEnabled property determine if the click to select item feature enabled.

The default value is true.

Implementation
    public function get itemClickSelectionEnabled():Boolean
    public function set itemClickSelectionEnabled(value:Boolean):void
itemDepthproperty 
itemDepth:Number  [read-write]

Gets or sets the itemDepth property. itemHeight property contain the value of item's prefered depth.

The default value is null.

Implementation
    public function get itemDepth():Number
    public function set itemDepth(value:Number):void
itemDistanceproperty 
itemDistance:Number  [read-write]

Gets or sets the itemScaleRatio property. itemHeight property contain the value of item's prefered height.

The default value is null.

Implementation
    public function get itemDistance():Number
    public function set itemDistance(value:Number):void
itemHeightproperty 
itemHeight:Number  [read-write]

Gets or sets the itemHeight property. itemHeight property contain the value of item's prefered height.

The default value is 50.

Implementation
    public function get itemHeight():Number
    public function set itemHeight(value:Number):void
itemOverColorproperty 
itemOverColor:Number  [read-write]

Gets or sets the itemOverColor property. itemOverColor property contain the color value of mouse over glow effect. The value should be int value.

The default value is 0xFFFFFF.

Implementation
    public function get itemOverColor():Number
    public function set itemOverColor(value:Number):void
itemOverColorSizeproperty 
itemOverColorSize:Number  [read-write]

Gets or sets the itemOverColorSize property. itemOverColorSize property determine the size of glow effect.

The default value is 10.

Implementation
    public function get itemOverColorSize():Number
    public function set itemOverColorSize(value:Number):void
itemOverGlowEnabledproperty 
itemOverGlowEnabled:Boolean  [read-write]

Gets or sets the itemOverGlowEnabled property. itemOverGlowEnabled property determine if the item over glow effect enabled.

The default value is true.

Implementation
    public function get itemOverGlowEnabled():Boolean
    public function set itemOverGlowEnabled(value:Boolean):void
itemWidthproperty 
itemWidth:Number  [read-write]

Gets or sets the itemWidth property. itemWidth property contain the value of item's prefered width.

The default value is 50.

Implementation
    public function get itemWidth():Number
    public function set itemWidth(value:Number):void
magnificationproperty 
magnification:Number  [read-write]

Gets or sets the magnification property. magnification property determine the maxinium scale of item for genie effect.

The default value is 2.

Implementation
    public function get magnification():Number
    public function set magnification(value:Number):void
radiusproperty 
radius:Number  [read-write]

Gets or sets the radius property. radius property determine the effect radius of genie effect.

The default value is 1.5.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
reflectionproperty 
reflection:Number  [read-write]

Gets or sets the itemAlpha property. itemHeight property detecmine the distance between each item.

The default value is 1.

Implementation
    public function get reflection():Number
    public function set reflection(value:Number):void
scaleproperty 
scale:Number  [read-write]

Gets or sets the scale property. scale property determine the normal scale of item for genie effect.

The default value is 1.

Implementation
    public function get scale():Number
    public function set scale(value:Number):void
selectedItemproperty 
selectedItem:Object  [read-only]

Return the data of selected item

Implementation
    public function get selectedItem():Object
selectedItemIndexproperty 
selectedItemIndex:Number  [read-write]

Gets or sets the selectedItemIndex property. selectedItemIndex property determine the current selected item index. Can set and make the item selected.

The default value is null.

Implementation
    public function get selectedItemIndex():Number
    public function set selectedItemIndex(value:Number):void
selectedItemsproperty 
selectedItems:Array  [read-only]

Return the array of data for mutiple selected item.

Implementation
    public function get selectedItems():Array
shadowproperty 
shadow:Number  [read-write]

Gets or sets the shadow property. reflection property determine the shadow effect apply to each item.

The default value is 0.5.

Implementation
    public function get shadow():Number
    public function set shadow(value:Number):void
tooltipproperty 
tooltip:Tooltip  [read-only]

Gets or sets the tooltip property. tooltip property contain tootip instance of the component. It can use to direct asset the current tooltip object.

The default value is Tooltip.

Implementation
    public function get tooltip():Tooltip
tooltipAlignproperty 
tooltipAlign:String  [read-write]

Gets or sets the tooltipAlign property. tooltipAlign property determinethe alignment of the tooltip. T: Top alignment B: Bottom alignment L: Left alignment R: Right alignment

The default value is T.

Implementation
    public function get tooltipAlign():String
    public function set tooltipAlign(value:String):void
tooltipDistanceproperty 
tooltipDistance:Number  [read-write]

Gets or sets the tooltipDistance property. tooltipDistance property determine the distance between item and tooltip.

The default value is 20.

Implementation
    public function get tooltipDistance():Number
    public function set tooltipDistance(value:Number):void
tooltipModeproperty 
tooltipMode:uint  [read-write]

Gets or sets the tooltipMode property. tooltipMode property determine the tooltip display mode. 0: no display 1: Show tooltip on mouseover

The default value is 1.

Implementation
    public function get tooltipMode():uint
    public function set tooltipMode(value:uint):void
UI_NAMEproperty 
UI_NAME:String  [read-write]Implementation
    public function get UI_NAME():String
    public function set UI_NAME(value:String):void
Constructor detail
DockMenu3D()constructor
public function DockMenu3D()
Event detail
animationCompleteevent 
Event object type: digicrafts.events.ItemEvent.ANIMATION_COMPLETE

Dispatched when the animation of the item completed. This event will dispatch after the animation of selected/deselected item have completed.

animationStartevent  
Event object type: digicrafts.events.ItemEvent.ANIMATION_START

Dispatched when the animation of the item started.. This event will dispatch if the item is selected/deselected and the animation of the item ready to start.

itemClickevent  
Event object type: digicrafts.events.ItemEvent.CLICK

Dispatched when mouse click on the item. This event will dispatch after the user perform mouse click on an item.

itemDeselectedevent  
Event object type: digicrafts.events.ItemEvent.DESELECTED

Dispatched when the item deselected This event will dispatch after the item is set to not selected.

itemDoubleClickevent  
Event object type: digicrafts.events.ItemEvent.DOUBLE_CLICK

Dispatched when mouse double click on the item. This event will dispatch after the user perform mouse double-click on an item.

itemMouseDownevent  
Event object type: digicrafts.events.ItemEvent.MOUSE_DOWN

Dispatched when mouse down inside an item. This event will dispatch after the mouse down perform inside an item.

itemMouseOutevent  
Event object type: digicrafts.events.ItemEvent.MOUSE_OUT

Dispatched when mouse mouse outside an item. This event will dispatch after the cusor move from inside to ouside of an item.

itemMouseOverevent  
Event object type: digicrafts.events.ItemEvent.MOUSE_OVER

Dispatched when mouse move inside an item. This event will dispatch after the cusor move from ouside to inside of an item.

itemMouseUpevent  
Event object type: digicrafts.events.ItemEvent.MOUSE_UP

Dispatched when mouse up occur after mouse down inside an item.. This event will dispatch after mouse release inside an item.

itemSelectedevent  
Event object type: digicrafts.events.ItemEvent.SELECTED

Dispatched when the item selected. This event will dispatch after the item is set to selected.