| Package | com.gestureworks.cml.element |
| Class | public class ScrollBar |
| Inheritance | ScrollBar  TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
| Property | Defined By | ||
|---|---|---|---|
 | _$height : Number = 0 | TouchSprite | |
| _$rotation : Number = 0 | TouchSprite | |
| $rotation : Number | TouchSprite | |
| _$scaleX : Number = 1 | TouchSprite | |
| $scaleX : Number | TouchSprite | |
| _$scaleY : Number = 1 | TouchSprite | |
| $scaleY : Number | TouchSprite | |
| $transformPoint : Point | TouchSprite | |
| _$width : Number = 0 | TouchSprite | |
| _$x : Number = 0 | TouchSprite | |
| $x : Number | TouchSprite | |
| _$y : Number = 0 | TouchSprite | |
| $y : Number | TouchSprite | |
| autoShuffle : Boolean
autoshuffles
| TouchContainerFactory | |
| broadcastTarget : Boolean | TouchSprite | |
| buttonAlpha : Number
The color of the button's background. | ScrollBar | ||
| buttonFill : uint
The color of the button's background. | ScrollBar | ||
| buttonVisible : Boolean
The color of the button's background. | ScrollBar | ||
| childList : ChildList [read-only]
returns the childlist
| TouchContainerFactory | |
| class_ : String
Object's css class;
| TouchContainerFactory | |
| className : String
sets the class name of displayobject
| TouchContainerFactory | |
| cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
| clusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects
in the local parent child display list stack. | TouchSprite | |
| clusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| clusterID : int | TouchSprite | |
| cmlIndex : int
sets the cml index
| TouchContainerFactory | |
| cml_item : Boolean | TouchSprite | |
| cO : ClusterObject | TouchSprite | |
| contentHeight : Number
The height of the content that needs to be scrolled. | ScrollBar | ||
| contentWidth : Number
The width of the content that needs to be scrolled;
| ScrollBar | ||
| cornerHeight : Number
Sets part of the corner radius for the ellipse used to round the rectangle of the thumb. | ScrollBar | ||
| cornerWidth : Number
Sets part of the corner radius for the ellipse used to round the rectangle of the thumb. | ScrollBar | ||
| debugDisplay : Boolean | TouchSprite | |
| deltaFilterOn : Boolean
Determins whether filtering is applied to the delta values. | TouchSprite | |
| dimensionsTo : String
sets the dimensions of touchcontainer
| TouchContainerFactory | |
| disableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite. | TouchSprite | |
| disableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| dN : Number | TouchSprite | |
| dropShadow : Boolean
Sets the drop shadow effect
| TouchContainerFactory | |
| fill : uint
The scrollbar fill (background color). | ScrollBar | ||
| GESTRELIST_UPDATE : String = gestureList update [static] | TouchSprite | |
| gestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite. | TouchSprite | |
| gestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite. | TouchSprite | |
| gestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| gestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite. | TouchSprite | |
| gestureFilters : Boolean | TouchSprite | |
| gestureList : Object | TouchSprite | |
| gestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite. | TouchSprite | |
| gestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite. | TouchSprite | |
| _gestureTweenOn : Boolean = false | TouchSprite | |
| gestureTweenOn : Boolean | TouchSprite | |
| gO : GestureListObject | TouchSprite | |
| group : String | TouchContainerFactory | |
| height : Number [override] | ScrollBar | ||
| id : String
sets childlist id
| TouchContainerFactory | |
| invertDrag : Boolean = false | ScrollBar | ||
| layout : *
speciffies the type of layout
| TouchContainerFactory | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| TouchContainer | |
| layoutList : Dictionary | TouchContainer | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| TouchContainer | |
| loaded : Boolean [read-only]
Checks to see if the element is loaded. | ScrollBar | ||
| maxScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| minScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainerFactory | |
| movementRail : Number | ScrollBar | ||
| N : int | TouchSprite | |
| nestedTransform : Boolean | TouchSprite | |
| orientation : String
Designates the orientation of the scrollbar, "horizontal" or "vertical"
| ScrollBar | ||
| outline_alpha : Number
sets the alpha of outline
| TouchContainerFactory | |
| outline_color : Number
sets the color of outline
| TouchContainerFactory | |
| outline_joint : String
TODO
| TouchContainerFactory | |
| outlineOn : String
specifies the outline of container to true or false
| TouchContainerFactory | |
| outline_stroke : int
sets the line stroke of outline
| TouchContainerFactory | |
| pointArray : Vector.<PointObject> [read-only] | TouchSprite | |
| pointCount : int | TouchSprite | |
| propertyStates : Array Deprecated: Please Use state | TouchContainerFactory | |
| railGraphic : Graphic | ScrollBar | ||
| railTouch : TouchContainer | ScrollBar | ||
| scale : Number
Scales display object
| TouchContainer | |
| scrollBtn1 : Graphic | ScrollBar | ||
| scrollBtn2 : Graphic | ScrollBar | ||
| scrollPosition : Number
The position of the scroll thumb on the rail. | ScrollBar | ||
| shape : String
Sets the shape of the thumb, either "rectangle", or "roundRectangle". | ScrollBar | ||
| sO : StrokeObject | TouchSprite | |
| state : Array
property states array
| TouchContainerFactory | |
| targeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test
targeting model with exclusive target clustering
| TouchSprite | |
| targetList : Array
Allows touch and gesture events to explicitly target a group of defined
touch objects which can be outside of the local parent child display list stack
| TouchSprite | |
| targetObject : Object
Allows touch and gesture events to explicitly target a touch object
this can be outside the local parent child display list stack
| TouchSprite | |
| targetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
| TouchSprite | |
| tc : TouchCluster | TouchSprite | |
| td : TouchDebugDisplay | TouchSprite | |
| tg : TouchGesture | TouchSprite | |
| thumb : Graphic | ScrollBar | ||
| thumbFill : uint
The color of the central thumb that slides up and down the scrollbar. | ScrollBar | ||
| thumbPosition : Number [write-only]
This sets the thumbPosition, this is not to be accessed externally in CML or used in Actionscript,
it is solely here for the ScrollPane class to reach when content is dragged. | ScrollBar | ||
| thumbTouch : TouchContainer | ScrollBar | ||
| tiO : TimelineObject | TouchSprite | |
| touchBtn1 : TouchContainer | ScrollBar | ||
| touchBtn2 : TouchContainer | ScrollBar | ||
| touchChildren : Boolean | TouchSprite | |
| touchObjectID : int [read-only] | TouchSprite | |
| tp : TouchPipeline | TouchSprite | |
| traceDebugModeOn : Boolean | TouchSprite | |
| transformComplete : Boolean | TouchSprite | |
| transformEventComplete : Boolean | TouchSprite | |
| transformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| transformEventStart : Boolean | TouchSprite | |
| transformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| transformStart : Boolean | TouchSprite | |
| trO : TransformObject | TouchSprite | |
| tt : TouchTransform | TouchSprite | |
| width : Number [override] | ScrollBar | ||
| x_lock : Boolean | TouchSprite | |
| y_lock : Boolean | TouchSprite | |
| Method | Defined By | ||
|---|---|---|---|
Constructor
| ScrollBar | ||
| activateTouch():void
TODO
| TouchContainerFactory | |
| addAllChildren():void
method searches the child and adds to the list
| TouchContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Registers event listeners. | TouchSprite | |
| applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
| childToList(id:String, child:*):void
child appended to the childlist
| TouchContainerFactory | |
clone():* [override] | ScrollBar | ||
createEvents():void | ScrollBar | ||
displayComplete():void [override]
CML display callback Initialisation
| ScrollBar | ||
dispose():void [override]
Dispose method
| ScrollBar | ||
| hideIndex(index:int):void
hides child list index
| TouchContainer | |
| hideKey(key:String):void
hides childlist key visibility
| TouchContainer | |
init():void [override]
Initialisation method
| ScrollBar | ||
| makeGestureList(value:XMLList):Object
TODO
| TouchContainerFactory | |
| onTouchDown(event:TouchEvent, target:* = null):void
decides how to assign the captured touch point to a cluster
can pass to parent, an explicit target, an explicit list or
targets or a passed to any touch object in the local display stack. | TouchSprite | |
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | TouchContainer | |
| postparseCML(cml:XMLList):void
postparse method
| TouchContainerFactory | |
resize(newDimension:Number):void
Used by the ScrollPane class to resize the scrollbar when scrollable content is scaled larger or smaller. | ScrollBar | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
| setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainerFactory | |
| showIndex(index:int):void
shows index of the child list
| TouchContainer | |
| showKey(key:String):void
shows the child list key visibility
| TouchContainer | |
| updateClusterAnalysis():void | TouchSprite | |
| updateDebugDisplay():void | TouchSprite | |
| updateGesturePipeline():void | TouchSprite | |
| updateListeners():void
Registers/unregisters event handlers depending on the active modes
| TouchSprite | |
| updateMotionClusterAnalysis():void | TouchSprite | |
| updateProperties(state:Number = 0):void
update properties of child
| TouchContainerFactory | |
| updateSensorClusterAnalysis():void | TouchSprite | |
| updateTObjProcessing():void | TouchSprite | |
| buttonAlpha | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbuttonAlpha:NumberThe color of the button's background.
public function get buttonAlpha():Number public function set buttonAlpha(value:Number):void| buttonFill | property |
buttonFill:uintThe color of the button's background.
public function get buttonFill():uint public function set buttonFill(value:uint):void| buttonVisible | property |
buttonVisible:BooleanThe color of the button's background.
public function get buttonVisible():Boolean public function set buttonVisible(value:Boolean):void| contentHeight | property |
contentHeight:NumberThe height of the content that needs to be scrolled.
public function get contentHeight():Number public function set contentHeight(value:Number):void| contentWidth | property |
contentWidth:NumberThe width of the content that needs to be scrolled;
public function get contentWidth():Number public function set contentWidth(value:Number):void| cornerHeight | property |
cornerHeight:NumberSets part of the corner radius for the ellipse used to round the rectangle of the thumb. Shape must be "roundRectangle" for this to be used.
The default value is 10.
public function get cornerHeight():Number public function set cornerHeight(value:Number):void| cornerWidth | property |
cornerWidth:NumberSets part of the corner radius for the ellipse used to round the rectangle of the thumb. Shape must be "roundRectangle" for this to be used.
The default value is 10.
public function get cornerWidth():Number public function set cornerWidth(value:Number):void| fill | property |
fill:uintThe scrollbar fill (background color).
public function get fill():uint public function set fill(value:uint):void| height | property |
height:Number[override] public function get height():Number public function set height(value:Number):void| invertDrag | property |
public var invertDrag:Boolean = false| loaded | property |
loaded:Boolean [read-only] Checks to see if the element is loaded. Setter is only for cloning to be available to set a scrollbar is loaded, do not set this variable.
public function get loaded():Boolean| movementRail | property |
public var movementRail:Number| orientation | property |
orientation:StringDesignates the orientation of the scrollbar, "horizontal" or "vertical"
The default value is vertical.
public function get orientation():String public function set orientation(value:String):void| railGraphic | property |
public var railGraphic:Graphic| railTouch | property |
public var railTouch:TouchContainer| scrollBtn1 | property |
public var scrollBtn1:Graphic| scrollBtn2 | property |
public var scrollBtn2:Graphic| scrollPosition | property |
scrollPosition:NumberThe position of the scroll thumb on the rail. This is to dispatch events to the ScrollPane class to set the position of the content, it should not be accessed externally.
public function get scrollPosition():Number public function set scrollPosition(value:Number):void| shape | property |
shape:StringSets the shape of the thumb, either "rectangle", or "roundRectangle".
The default value is roundRectangle.
public function get shape():String public function set shape(value:String):void| thumb | property |
public var thumb:Graphic| thumbFill | property |
thumbFill:uintThe color of the central thumb that slides up and down the scrollbar. If no color is set, it will default to match the button styles.
public function get thumbFill():uint public function set thumbFill(value:uint):void| thumbPosition | property |
thumbPosition:Number [write-only] This sets the thumbPosition, this is not to be accessed externally in CML or used in Actionscript, it is solely here for the ScrollPane class to reach when content is dragged.
public function set thumbPosition(value:Number):void| thumbTouch | property |
public var thumbTouch:TouchContainer| touchBtn1 | property |
public var touchBtn1:TouchContainer| touchBtn2 | property |
public var touchBtn2:TouchContainer| width | property |
width:Number[override] public function get width():Number public function set width(value:Number):void| ScrollBar | () | Constructor |
public function ScrollBar()Constructor
| clone | () | method |
override public function clone():*Returns* |
| createEvents | () | method |
public function createEvents():void| displayComplete | () | method |
override public function displayComplete():voidCML display callback Initialisation
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidInitialisation method
| resize | () | method |
public function resize(newDimension:Number):voidUsed by the ScrollPane class to resize the scrollbar when scrollable content is scaled larger or smaller.
Parameters
newDimension:Number |