Packagecom.gestureworks.cml.elements
Classpublic class Dock
InheritanceDock Inheritance Drawer Inheritance Container Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

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
  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
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 Inheritedbackground : *
The DisplayObject representing the drawer's content area
Drawer
 InheritedbkgColor : uint
The color of the drawer's content area
Drawer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
  cmlIni : Boolean = false
Dock
  collectionViewer : CollectionViewer
Dock
  connection : NetConnection
Dock
  dials : Array
Dock
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
  dockText : Array
Dock
 InheriteddragAngle : Number
Determines the drag direction.
Drawer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
  gateway : String
Dock
 Inheritedgroup : String
TouchContainer
 Inheritedhandle : *
The top mounted TouchContainer used to close/open the drawer when tapped.
Drawer
 InheritedhandleAlpha : Number
The alpha of the drawer's handle
Drawer
 InheritedhandleColor : uint
The color of the drawer's handle
Drawer
 InheritedhandleGestureList : Object
Modifies the handle's gesture list to disable default (tap, flick, drag) gestures.
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
 InheritedhandleOrientation : String
The side of the container (top, bottom, right, left) to position the handle.
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 : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
 InheritedinitializeOpen : Boolean
Flag indicating whether the initial state of the drawer is open or closed
Drawer
  isLoading : Boolean = false
Dock
 InheritedisOpen : Boolean
[read-only]
Drawer
 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 : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 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
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
  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.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
  placeHolders : Array
Dock
  pos : String
Dock
 Inheritedposition : *
Sets the position
TouchContainer
  previousArrow : *
An optional way to set a custom graphic for multiple pages of results.
Dock
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  responder : Responder
Dock
  result : *
Dock
  resultCnt : int = 0
Dock
  resultsPerPage : int
Sets the results for pagination.
Dock
  returnFields : *
Dock
 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
  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
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
  templates : Array
Dock
 Inheritedtitle : String
The text of the handle's label
Drawer
 InheritedtoBitmap : Boolean
TouchContainer
 Inheritedupdate : Boolean
[write-only] Updates Drawer when set to true
Drawer
 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
 InheritedverticalHandle : Boolean
[read-only] Flag indicating handle orientation is either left or right
Drawer
 Inheritedwidth : Number
[override] Sets the width of the drawer and drawer's UI components
Drawer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
  placeHolderIndex : int
Dock
  _searchFieldsArray : Array
Dock
Public Methods
 MethodDefined By
  
Constructor
Dock
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Reroutes non-UI child additions to the drawer's content holder
Drawer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Reroutes non-UI child additions to the drawer's content holder
Drawer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
 Inherited
close(e:GWGestureEvent = null):void
Plays the down tween, registers the open listener, and removes the close listener
Drawer
  
connect():void
Connect to a database
Dock
  
dispose():void
[override] Destructor
Dock
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialization function
Dock
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
  
moveBelowDock(obj:DisplayObject):void
Moves the specified display object beneath the dock in the display list
Dock
 Inherited
open(e:GWGestureEvent = null):void
Plays the up tween, registers the close listener, and removes the open listener
Drawer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
  
Preloads the maxClones value of template clones
Dock
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
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

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

resultsPerPageproperty 
resultsPerPage:int

Sets the results for pagination. If left unset, CollectiveAccess will return any and all results for a search. FlickrQuery will default to whatever amount it has set (default for FlickrQuery: 12), otherwise the resultsPerPage property is definitive whether FlickrQuery or CollectiveAccess is used.


Implementation
    public function get resultsPerPage():int
    public function set resultsPerPage(value:int):void
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

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