Packagecom.gestureworks.cml.element
Classpublic class Dock
InheritanceDock Inheritance Drawer Inheritance Container Inheritance ContainerFactory Inheritance ElementFactory Inheritance flash.display.Sprite

Designed for the database version of the CollectionViewer, the Dock is a retractable control station intended to guide users through database query construction by vertically spinning a set of dials populated with predefined search terms. Each dial change submits a new query, as a combination of aligned dial terms, and can produce visual result set representations in its menu album. The album can be horizontally scrolled and images can be loaded to stage by either tapping a result or dragging a result to the stage.



Public Properties
 PropertyDefined By
  album : MenuAlbum
Dock
 Inheritedalpha : Number
[override] [write-only] sets the alpha for display objects
ElementFactory
  amountToShow : int = -1
Dock
 InheritedapplyMask : Boolean
Flag indicating the application of a mask to the drawer to prevent content from exceeding the drawer's boundaries
Drawer
  autoShuffle : int = -1
Dock
 Inheritedbackground : *
The DisplayObject representing the drawer's content area
Drawer
 InheritedbkgColor : uint
The color of the drawer's content area
Drawer
 Inheritedblur : Boolean
Sets the drop shadow effect
ElementFactory
 Inheritedbottom : Number
sets the bottom value
ElementFactory
 InheritedchildList : ChildList
[read-only] store the child list
ContainerFactory
 Inheritedclass_ : String
Object's css class;
ElementFactory
 InheritedclassName : String
sets the class name of displayobject
ElementFactory
 InheritedcmlIndex : int
sets the cml index
ElementFactory
  cmlIni : Boolean = false
Dock
  collectionViewer : CollectionViewer
Dock
  connection : NetConnection
Dock
 InheriteddebugStyle : *
sets the debug style
ElementFactory
  dials : Array
Dock
 InheriteddimensionsTo : String
sets the dimensions of the container
ContainerFactory
 InheriteddisplayEvents : String
Use for dispatch completes.
ElementFactory
  dockText : Array
Dock
 InheriteddropShadow : Boolean
Sets the drop shadow effect
ElementFactory
  gateway : String
Dock
 Inheritedhandle : *
The top mounted TouchContainer used to close/open the drawer when tapped.
Drawer
 InheritedhandleColor : uint
The color of the drawer's handle
Drawer
 InheritedhandleHeight : Number
The height of the drawer's handle
Drawer
 InheritedhandleLineColor : uint
The color the handle's border
Drawer
 InheritedhandleLineStroke : Number
The width of the handle's border in pixels
Drawer
 InheritedhandleWidth : Number
The width of the drawer's handle
Drawer
 Inheritedheight : Number
[override] Sets the height of the drawer and drawer's UI components
Drawer
 InheritedheightPercent : String
sets the height percent of display object
ElementFactory
 InheritedhorizontalCenter : Number
sets the horizontal center of display object
ElementFactory
 Inheritedid : String
sets the id of child
ElementFactory
 Inheritedindex : int
sets the index of display object
ElementFactory
 InheritedinfoSource : String
sets info source
ContainerFactory
 InheritedinitializeOpen : Boolean
Flag indicating whether the initial state of the drawer is open or closed
Drawer
  isLoading : Boolean = false
Dock
 Inheritedlabel : *
The Text component that displays the drawer's title
Drawer
 InheritedlabelColor : uint
The color of the handle's label
Drawer
 InheritedlabelFont : String
The font of the handle's label
Drawer
 InheritedlabelFontSize : Number
The font size of the handle's label
Drawer
 Inheritedlayout : *
Sets the layout of the container
Container
 InheritedlayoutComplete : Function
Sets the function to call when the layout is complete
Container
 InheritedlayoutList : Dictionary
Defines the layoutlist
Container
 InheritedlayoutUpdate : Function
Sets the function to call when the layout updates
Container
 Inheritedleft : Number
sets left value
ElementFactory
 InheritedleftCornerRadius : Number
The radius of the upper left corner of the handle
Drawer
 InheritedleftHandle : *
The left mounted TouchContainer used to close the drawer when tapped.
Drawer
  loadCnt : int = 0
Dock
  loadText : Text
Dock
  maxClones : int = 30
Dock
  maxLoad : int = 1
Dock
  nextArrow : *
An optional way to set a custom graphic for multiple pages of results.
Dock
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
Container
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
Container
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
Container
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
Container
  placeHolders : Array
Dock
  pos : String
Dock
 Inheritedposition : String
Sets the position
Container
  previousArrow : *
An optional way to set a custom graphic for multiple pages of results.
Dock
 InheritedpropertyStates : Array
Deprecated: Please Use state
ElementFactory
  responder : Responder
Dock
  result : *
Dock
  resultCnt : int = 0
Dock
  returnFields : *
Dock
 Inheritedright : Number
sets the right value
ElementFactory
 InheritedrightCornerRadius : Number
The radius of the upper right corner of the handle
Drawer
 InheritedrightHandle : *
The right mounted TouchContainer used to close the drawer when tapped.
Drawer
 Inheritedscale : Number
Sets both the x and y scale values
ElementFactory
 InheritedscaleX : Number
[override] Sets width of the display object in pixels
ElementFactory
 InheritedscaleY : Number
[override] Sets width of the display object in pixels
ElementFactory
  searchFields : String
Dock
  searchTermFilters : Boolean
Automates the generation of filtered search term lists and applies them to the dials.
Dock
  searchTerms : Array
Dock
  serverTimeOut : Number
The amout of time allotted for server connection or query results
Dock
 Inheritedstate : Array
property states array
ElementFactory
  templates : Array
Dock
 Inheritedtitle : String
The text of the handle's label
Drawer
 Inheritedtop : Number
sets top value
ElementFactory
 InheriteduseLeftHandle : Boolean
A flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the close operation to the left handle.
Drawer
 InheriteduseRightHandle : Boolean
A flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the close operation to the right handle.
Drawer
 InheriteduseSideHandles : Boolean
A flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the close operation to the side handles.
Drawer
 InheritedverticalCenter : Number
sets the vertical center of display object
ElementFactory
 Inheritedwidth : Number
[override] Sets the width of the drawer and drawer's UI components
Drawer
 InheritedwidthPercent : String
sets the percent of width of display object
ElementFactory
Protected Properties
 PropertyDefined By
  placeHolderIndex : int
Dock
  _searchFieldsArray : Array
Dock
Public Methods
 MethodDefined By
  
Constructor
Dock
 Inherited
This method searches the childlist and add the children
ContainerFactory
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Reroutes child additions to the drawer's content holder
Drawer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Reroutes child additions to the drawer's content holder
Drawer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
Container
 Inherited
childToList(id:String, child:*):void
this method append to the childlist
ContainerFactory
 Inherited
clone():*
Returns clone of self
ElementFactory
  
connect():void
Connect to a database
Dock
  
[override] CML init
Dock
  
dispose():void
[override] Destructor
Dock
 Inherited
getIndex(index:int):*
returns childlist index
Container
 Inherited
getKey(key:String):*
returns the childlist key
Container
 Inherited
hideIndex(index:int):void
hides the childlist index
Container
 Inherited
hideKey(key:String):void
hides the childlist key
Container
  
init():void
[override] Initialization function
Dock
  
moveBelowDock(obj:DisplayObject):void
Moves the specified display object beneath the dock in the display list
Dock
 Inherited
parseCML(cml:XMLList):XMLList
[override] Parse cml for local layouts.
Container
 Inherited
postparseCML(cml:XMLList):void
post parses the cml file
ElementFactory
  
Preloads the maxClones value of template clones
Dock
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
Container
 Inherited
This method sets the dimensions of childlist
ContainerFactory
 Inherited
showIndex(index:int):void
shows the childlist index
Container
 Inherited
showKey(key:String):void
shows the childlist key
Container
 Inherited
updateProperties(state:Number = 0):void
this method updates the properties
ElementFactory
Protected Methods
 MethodDefined By
  
Dock
  
onCloneLoad(event:StateEvent = null):void
Dock
  
Submit query based on aligned dial search terms
Dock
Property Detail
_searchFieldsArrayproperty
protected var _searchFieldsArray:Array

albumproperty 
public var album:MenuAlbum

amountToShowproperty 
public var amountToShow:int = -1

autoShuffleproperty 
public var autoShuffle:int = -1

cmlIniproperty 
public var cmlIni:Boolean = false

collectionViewerproperty 
public var collectionViewer:CollectionViewer

connectionproperty 
public var connection:NetConnection

dialsproperty 
public var dials:Array

dockTextproperty 
public var dockText:Array

gatewayproperty 
public var gateway:String

isLoadingproperty 
public var isLoading:Boolean = false

loadCntproperty 
public var loadCnt:int = 0

loadTextproperty 
public var loadText:Text

maxClonesproperty 
public var maxClones:int = 30

maxLoadproperty 
public var maxLoad:int = 1

nextArrowproperty 
nextArrow:*

An optional way to set a custom graphic for multiple pages of results. Setting this will remove it from the childList to be placed inside the menu album.


Implementation
    public function get nextArrow():*
    public function set nextArrow(value:any):void
placeHolderIndexproperty 
placeHolderIndex:int


Implementation
    protected function get placeHolderIndex():int
    protected function set placeHolderIndex(value:int):void
placeHoldersproperty 
public var placeHolders:Array

posproperty 
public var pos:String

previousArrowproperty 
previousArrow:*

An optional way to set a custom graphic for multiple pages of results. Setting this will remove it from the childList to be placed inside the menu album.


Implementation
    public function get previousArrow():*
    public function set previousArrow(value:any):void
responderproperty 
public var responder:Responder

resultproperty 
public var result:*

resultCntproperty 
public var resultCnt:int = 0

returnFieldsproperty 
returnFields:*


Implementation
    public function get returnFields():*
    public function set returnFields(value:any):void
searchFieldsproperty 
public var searchFields:String

searchTermFiltersproperty 
searchTermFilters:Boolean

Automates the generation of filtered search term lists and applies them to the dials. This will require additional load time relative to the number of search terms.


Implementation
    public function get searchTermFilters():Boolean
    public function set searchTermFilters(value:Boolean):void
searchTermsproperty 
public var searchTerms:Array

serverTimeOutproperty 
serverTimeOut:Number

The amout of time allotted for server connection or query results


Implementation
    public function get serverTimeOut():Number
    public function set serverTimeOut(value:Number):void
templatesproperty 
public var templates:Array

Constructor Detail
Dock()Constructor
public function Dock()

Constructor

Method Detail
connect()method
public function connect():void

Connect to a database

displayComplete()method 
override public function displayComplete():void

CML init

displayResults()method 
protected function displayResults():void

dispose()method 
override public function dispose():void

Destructor

init()method 
override public function init():void

Initialization function

moveBelowDock()method 
public function moveBelowDock(obj:DisplayObject):void

Moves the specified display object beneath the dock in the display list

Parameters

obj:DisplayObject

onCloneLoad()method 
protected function onCloneLoad(event:StateEvent = null):void

Parameters

event:StateEvent (default = null)

onDialChange()method 
protected function onDialChange(e:StateEvent):void

Submit query based on aligned dial search terms

Parameters

e:StateEvent — dial change state event

preloadClones()method 
public function preloadClones():void

Preloads the maxClones value of template clones