Package | com.gestureworks.cml.elements |
Class | public class Dock |
Inheritance | Dock ![]() ![]() ![]() ![]() |
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.
Property | Defined By | ||
---|---|---|---|
album : MenuAlbum | Dock | ||
amountToShow : int = -1 | Dock | ||
![]() | applyMask : Boolean
Flag indicating the application of a mask to the drawer to prevent
content from exceeding the drawer's boundaries
| Drawer | |
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | background : *
The DisplayObject representing the drawer's content area
| Drawer | |
![]() | bkgColor : uint
The color of the drawer's content area
| Drawer | |
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
cmlIni : Boolean = false | Dock | ||
collectionViewer : CollectionViewer | Dock | ||
connection : NetConnection | Dock | ||
dials : Array | Dock | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
dockText : Array | Dock | ||
![]() | dragAngle : Number
Determines the drag direction. | Drawer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
gateway : String | Dock | ||
![]() | group : String | TouchContainer | |
![]() | handle : *
The top mounted TouchContainer used to close/open the drawer when tapped. | Drawer | |
![]() | handleAlpha : Number
The alpha of the drawer's handle
| Drawer | |
![]() | handleColor : uint
The color of the drawer's handle
| Drawer | |
![]() | handleGestureList : Object
Modifies the handle's gesture list to disable default (tap, flick, drag) gestures. | Drawer | |
![]() | handleHeight : Number
The height of the drawer's handle
| Drawer | |
![]() | handleLineColor : uint
The color the handle's border
| Drawer | |
![]() | handleLineStroke : Number
The width of the handle's border in pixels
| Drawer | |
![]() | handleOrientation : String
The side of the container (top, bottom, right, left) to position the handle. | Drawer | |
![]() | handleWidth : Number
The width of the drawer's handle
| Drawer | |
![]() | height : Number [override]
Sets the height of the drawer and drawer's UI components
| Drawer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | initializeOpen : Boolean
Flag indicating whether the initial state of the drawer is open or closed
| Drawer | |
isLoading : Boolean = false | Dock | ||
![]() | isOpen : Boolean [read-only] | Drawer | |
![]() | label : *
The Text component that displays the drawer's title
| Drawer | |
![]() | labelColor : uint
The color of the handle's label
| Drawer | |
![]() | labelFont : String
The font of the handle's label
| Drawer | |
![]() | labelFontSize : Number
The font size of the handle's label
| Drawer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | leftCornerRadius : Number
The radius of the upper left corner of the handle
| Drawer | |
![]() | leftHandle : *
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 | ||
![]() | mouseChildren : 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 | ||
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : 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 | ||
![]() | position : *
Sets the position
| TouchContainer | |
previousArrow : *
An optional way to set a custom graphic for multiple pages of results. | Dock | ||
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : 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 | ||
![]() | rightCornerRadius : Number
The radius of the upper right corner of the handle
| Drawer | |
![]() | rightHandle : *
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 | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
templates : Array | Dock | ||
![]() | title : String
The text of the handle's label
| Drawer | |
![]() | toBitmap : Boolean | TouchContainer | |
![]() | update : Boolean [write-only]
Updates Drawer when set to true
| Drawer | |
![]() | useLeftHandle : 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 | |
![]() | useRightHandle : 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 | |
![]() | useSideHandles : 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 | |
![]() | verticalHandle : Boolean [read-only]
Flag indicating handle orientation is either left or right
| Drawer | |
![]() | width : Number [override]
Sets the width of the drawer and drawer's UI components
| Drawer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
placeHolderIndex : int | Dock | ||
_searchFieldsArray : Array | Dock |
Method | Defined By | ||
---|---|---|---|
Dock()
Constructor
| Dock | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Reroutes non-UI child additions to the drawer's content holder
| Drawer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Reroutes non-UI child additions to the drawer's content holder
| Drawer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
![]() | clone():*
Clone method
| TouchContainer | |
![]() | 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 | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class. | TouchContainer | |
init():void [override]
Initialization function
| Dock | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | 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 | ||
![]() | open(e:GWGestureEvent = null):void
Plays the up tween, registers the close listener, and removes the open listener
| Drawer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
preloadClones():void
Preloads the maxClones value of template clones
| Dock | ||
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void [override]
Removes children from display list and, if not already removed, the child list
| TouchContainer | |
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
displayResults():void | Dock | ||
onCloneLoad(event:StateEvent = null):void | Dock | ||
onDialChange(e:StateEvent):void
Submit query based on aligned dial search terms
| Dock |
_searchFieldsArray | property |
protected var _searchFieldsArray:Array
album | property |
public var album:MenuAlbum
amountToShow | property |
public var amountToShow:int = -1
cmlIni | property |
public var cmlIni:Boolean = false
collectionViewer | property |
public var collectionViewer:CollectionViewer
connection | property |
public var connection:NetConnection
dials | property |
public var dials:Array
dockText | property |
public var dockText:Array
gateway | property |
public var gateway:String
isLoading | property |
public var isLoading:Boolean = false
loadCnt | property |
public var loadCnt:int = 0
loadText | property |
public var loadText:Text
maxClones | property |
public var maxClones:int = 30
maxLoad | property |
public var maxLoad:int = 1
nextArrow | property |
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.
public function get nextArrow():*
public function set nextArrow(value:any):void
placeHolderIndex | property |
placeHolderIndex:int
protected function get placeHolderIndex():int
protected function set placeHolderIndex(value:int):void
placeHolders | property |
public var placeHolders:Array
pos | property |
public var pos:String
previousArrow | property |
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.
public function get previousArrow():*
public function set previousArrow(value:any):void
responder | property |
public var responder:Responder
result | property |
public var result:*
resultCnt | property |
public var resultCnt:int = 0
resultsPerPage | property |
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.
public function get resultsPerPage():int
public function set resultsPerPage(value:int):void
returnFields | property |
returnFields:*
public function get returnFields():*
public function set returnFields(value:any):void
searchFields | property |
public var searchFields:String
searchTermFilters | property |
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.
public function get searchTermFilters():Boolean
public function set searchTermFilters(value:Boolean):void
searchTerms | property |
public var searchTerms:Array
serverTimeOut | property |
serverTimeOut:Number
The amout of time allotted for server connection or query results
public function get serverTimeOut():Number
public function set serverTimeOut(value:Number):void
templates | property |
public var templates:Array
Dock | () | Constructor |
public function Dock()
Constructor
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