| Package | com.gestureworks.cml.element |
| Class | public class Dock |
| Inheritance | Dock  Drawer Container ContainerFactory ElementFactory flash.display.Sprite |
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 | ||
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| 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 : int = -1 | Dock | ||
| background : *
The DisplayObject representing the drawer's content area
| Drawer | |
| bkgColor : uint
The color of the drawer's content area
| Drawer | |
| blur : Boolean
Sets the drop shadow effect
| ElementFactory | |
| bottom : Number
sets the bottom value
| ElementFactory | |
| childList : ChildList [read-only]
store the child list
| ContainerFactory | |
| class_ : String
Object's css class;
| ElementFactory | |
| className : String
sets the class name of displayobject
| ElementFactory | |
| cmlIndex : int
sets the cml index
| ElementFactory | |
| cmlIni : Boolean = false | Dock | ||
| collectionViewer : CollectionViewer | Dock | ||
| connection : NetConnection | Dock | ||
| debugStyle : *
sets the debug style
| ElementFactory | |
| dials : Array | Dock | ||
| dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | |
| displayEvents : String
Use for dispatch completes. | ElementFactory | |
| dockText : Array | Dock | ||
| dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | |
| gateway : String | Dock | ||
| handle : *
The top mounted TouchContainer used to close/open the drawer when tapped. | Drawer | |
| handleColor : uint
The color of the drawer's handle
| 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 | |
| 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 : String
sets the height percent of display object
| ElementFactory | |
| horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | |
| id : String
sets the id of child
| ElementFactory | |
| index : int
sets the index of display object
| ElementFactory | |
| infoSource : String
sets info source
| ContainerFactory | |
| initializeOpen : Boolean
Flag indicating whether the initial state of the drawer is open or closed
| Drawer | |
| isLoading : Boolean = false | Dock | ||
| 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 : *
Sets the layout of the container
| Container | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| Container | |
| layoutList : Dictionary
Defines the layoutlist
| Container | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| Container | |
| left : Number
sets left value
| ElementFactory | |
| 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 | ||
| 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. | Container | |
| paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | |
| paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | |
| paddingTop : 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 | ||
| position : String
Sets the position
| Container | |
| previousArrow : *
An optional way to set a custom graphic for multiple pages of results. | Dock | ||
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| responder : Responder | Dock | ||
| result : * | Dock | ||
| resultCnt : int = 0 | Dock | ||
| returnFields : * | Dock | ||
| right : Number
sets the right value
| ElementFactory | |
| 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 | |
| scale : Number
Sets both the x and y scale values
| ElementFactory | |
| scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| scaleY : 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 | ||
| state : Array
property states array
| ElementFactory | |
| templates : Array | Dock | ||
| title : String
The text of the handle's label
| Drawer | |
| top : Number
sets top value
| ElementFactory | |
| 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 | |
| verticalCenter : Number
sets the vertical center of display object
| ElementFactory | |
| width : Number [override]
Sets the width of the drawer and drawer's UI components
| Drawer | |
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Property | Defined By | ||
|---|---|---|---|
| placeHolderIndex : int | Dock | ||
| _searchFieldsArray : Array | Dock | ||
| Method | Defined By | ||
|---|---|---|---|
Dock()
Constructor
| Dock | ||
| addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Reroutes child additions to the drawer's content holder
| Drawer | |
| addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Reroutes child additions to the drawer's content holder
| Drawer | |
| applyLayout(value:* = null):void
Apply the containers layout
| Container | |
| childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | |
| clone():*
Returns clone of self
| ElementFactory | |
connect():void
Connect to a database
| Dock | ||
displayComplete():void [override]
CML init
| Dock | ||
dispose():void [override]
Destructor
| Dock | ||
| getIndex(index:int):*
returns childlist index
| Container | |
| getKey(key:String):*
returns the childlist key
| Container | |
| hideIndex(index:int):void
hides the childlist index
| Container | |
| 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 | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | |
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
preloadClones():void
Preloads the maxClones value of template clones
| Dock | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | |
| setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | |
| showIndex(index:int):void
shows the childlist index
| Container | |
| showKey(key:String):void
shows the childlist key
| Container | |
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| 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 |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _searchFieldsArray:Array| album | property |
public var album:MenuAlbum| amountToShow | property |
public var amountToShow:int = -1| autoShuffle | property |
public var autoShuffle: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| returnFields | property |
returnFields:*
public function get returnFields():* public function set returnFields(value:any):void| searchFields | property |
public var searchFields:String| searchTermFilters | property |
searchTermFilters:BooleanAutomates 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:NumberThe 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():voidConnect to a database
| displayComplete | () | method |
override public function displayComplete():voidCML init
| displayResults | () | method |
protected function displayResults():void| dispose | () | method |
override public function dispose():voidDestructor
| init | () | method |
override public function init():voidInitialization function
| moveBelowDock | () | method |
public function moveBelowDock(obj:DisplayObject):voidMoves the specified display object beneath the dock in the display list
Parameters
obj:DisplayObject |
| onCloneLoad | () | method |
protected function onCloneLoad(event:StateEvent = null):voidParameters
event:StateEvent (default = null) |
| onDialChange | () | method |
protected function onDialChange(e:StateEvent):voidSubmit query based on aligned dial search terms
Parameters
e:StateEvent — dial change state event
|
| preloadClones | () | method |
public function preloadClones():voidPreloads the maxClones value of template clones