| Package | org.openPyro.controls |
| Class | public class ScrollBar |
| Inheritance | ScrollBar  UIContainer UIControl MeasurableControl flash.display.Sprite |
| Property | Defined by | ||
|---|---|---|---|
 | backgroundPainter : IPainter
UIControls can have a backgroundPainter object attached that is
triggered everytime updateDisplayList is called.
| UIControl | |
| clipContent : Boolean | UIContainer | |
| contentHeight : Number | UIContainer | |
| contentWidth : Number | UIContainer | |
| creationCompleteFired : Boolean | MeasurableControl | |
| decrementButton : Button | ScrollBar | ||
| decrementButtonSkin : ISkin
[write-only]
| ScrollBar | ||
| direction : String [read-only]
| ScrollBar | ||
| displayListInvalidated : Boolean = true
Flag to mark a dirty displaylist.
| MeasurableControl | |
| dragData : Object | UIControl | |
| dragEnabled : Boolean | UIControl | |
| dropEnabled : Boolean | UIControl | |
| explicitlyAllocatedHeight : Number
This property are modified by IContainerMeasurementHelpers.
| UIContainer | |
| explicitlyAllocatedWidth : Number
This property are modified by IContainerMeasurementHelpers.
| UIContainer | |
| explicitWidth : Number The height set in terms of actual pixels.
| MeasurableControl | |
| forceInvalidateDisplayList : Boolean = false | MeasurableControl | |
| height : Number
Set/get the height of the control.
| MeasurableControl | |
| horizontalScrollBar : ScrollBar
Returns The instance of the created horizontal
or null if it was never created or is not visible.
| UIContainer | |
| horizontalScrollIncrement : Number | UIContainer | |
| horizontalScrollPolicy : Boolean | UIContainer | |
| horizontalScrollPosition : Number | UIContainer | |
| includeInLayout : Boolean
Specifies whether this control participates in the
layout system in OpenPyro.
| MeasurableControl | |
| incrementalScrollDelta : Number = 25
The height/width the scrollbar must scroll
when one of the scroll buttons is clicked on.
| ScrollBar | ||
| incrementButton : Button | ScrollBar | ||
| incrementButtonSkin : ISkin
[write-only]
| ScrollBar | ||
| initialized : Boolean = false
Property indicates whether a control has been initialized
or not.
| MeasurableControl | |
| layout : ILayout
Containers can be assigned different layouts
which control the positioning of the
different controls.
| UIContainer | |
| layoutChildren : Array
Returns an Array of displayObjects whose positions
are controlled by the
ILayout object. | UIContainer | |
| maximum : Number | ScrollBar | ||
| maximumHeight : Number | MeasurableControl | |
| maximumWidth : Number | MeasurableControl | |
| measuredHeight : Number
Overrides the set measuredHeight property from
MeasurableControl to invalidate children
(UIControl acknowledges that it can have children whose
dimensions are based on its own)
| UIControl | |
| measuredWidth : Number
Overrides the set measuredWidth property from
MeasurableControl to invalidate children
(UIControl acknowledges that it can have children whose
dimensions are based on its own)
| UIControl | |
| minimum : Number | ScrollBar | ||
| mouseActionsDisabled : Boolean | MeasurableControl | |
| mouseOverDisabled : Boolean = false [static]
| UIContainer | |
| needsMeasurement : Boolean = true
Only setting percent width/heights changes the
needsMeasurement flag which makes its parent
container call measure on it.
| MeasurableControl | |
| padding : Padding
Paddings define the unusable space within
UIContainers that should not be used for
measurement and layout.
| UIControl | |
| parentContainer : UIControl | MeasurableControl | |
| percentHeight : Number | MeasurableControl | |
| percentUnusedHeight : Number
Set/get the percent height.
| MeasurableControl | |
| percentUnusedWidth : Number
Set/get the percent width.
| MeasurableControl | |
| percentWidth : Number | MeasurableControl | |
| scrollHeight : Number
scrollHeight is the max height a vertical
scrollbar needs to scroll
| UIContainer | |
| scrollWidth : Number
scrollWidth is the max width a horizontal
scrollbar needs to scroll
| UIContainer | |
| sizeInvalidated : Boolean = false
The flag to mark that the control's size
has been invalidated.
| MeasurableControl | |
| skin : ISkin
[write-only]
| ScrollBar | ||
| skinnedControl : UIControl | UIControl | |
| slider : Slider | ScrollBar | ||
| styleName : String
Defines the skin this component is registered to.
| UIControl | |
| toolTip : * | UIControl | |
| usesMeasurementStrategy : Boolean
This property defines whether measure() will be called during
validateSize() or not.
| MeasurableControl | |
| value : Number | ScrollBar | ||
| verticalScrollBar : ScrollBar
Returns The instance of the created verticalScrollBar
or null if it was never created or is not visible.
| UIContainer | |
| verticalScrollIncrement : Number | UIContainer | |
| verticalScrollPolicy : Boolean | UIContainer | |
| verticalScrollPosition : Number | UIContainer | |
| visible : Boolean | MeasurableControl | |
| width : Number
Set/get the width of the control.
| MeasurableControl | |
| Method | Defined by | ||
|---|---|---|---|
|
ScrollBar(direction:String)
| ScrollBar | ||
|
addChild(child:DisplayObject):DisplayObject
| UIContainer | |
|
addChildAt(child:DisplayObject, index:int):DisplayObject
| UIContainer | |
|
cancelMouseEvents():void
| MeasurableControl | |
|
checkDisplayListValidation():void
Calls the queueValidateDisplayList if measure causes
_dimensionsChanged to change to true.
| UIControl | |
|
dispose():void
| UIControl | |
|
doLayoutChildren():void
Lays out the layoutChildren based
ILayout
object. | UIContainer | |
|
doOnAdded():void
[Temp] This function is called automatically
by a parent UIControl if this is created as a
child of a UIControl.
| MeasurableControl | |
|
enableMouseEvents():void
| MeasurableControl | |
|
getChildByName(name:String):DisplayObject
| UIContainer | |
|
getExplicitOrMeasuredHeight():Number
Returns the explicitly defined height or the measured
height computed by the
measure function. | MeasurableControl | |
|
getExplicitOrMeasuredWidth():Number
Returns the explicitly defined width or the measured
number computed by the
measure function. | MeasurableControl | |
|
heightForMeasurement():Number
When measure is called, it uses the widthForMeasurement and
heightForMeasurement to calculate the sizes for
percent-dimension based children
| UIContainer | |
|
initialize():void
At the very least, a scrollBar needs a slider
or some subclass of it.
| ScrollBar | ||
|
invalidateSize(event:PyroEvent = null):void
Marks itself dirty and waits till either the container
to validateSize or validates itself at the next enterframe
if it has no parent container.
| MeasurableControl | |
|
isMouseOver(event:MouseEvent):Boolean
Utility function to check if a mouseEvent happened
while the mouse was over the displayObject
| MeasurableControl | |
|
measure():void
Measure is called during the validateSize if
the needsmeasurement flag is set.
| UIControl | |
| UIControl | ||
|
queueValidateDisplayList(event:PyroEvent = null):void
This function is called if the framework determines that dimensions of the
control have changed.
| MeasurableControl | |
|
removeAllChildren():void
| UIContainer | |
|
removeBackgroundPainter():void
| UIControl | |
|
removeChild(child:DisplayObject):DisplayObject
| UIContainer | |
|
resizeHandler():void
| MeasurableControl | |
|
setScrollProperty(visibleScroll:Number, maxScroll:Number):void
For example: setScrollProperty(scrollHeight, contentHeight);
| ScrollBar | ||
|
Convinience function for setting width and height
in one call.
| UIControl | |
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Unlike UIControls, UIContainers do not apply a skin directly on
themselves but interpret the skin file and apply them to the
different children.
| UIContainer | |
|
validateDisplayList(event:Event = null):void
validateDisplayList is called as a response to invalidateDisplayList.
| MeasurableControl | |
|
validateSize():void
For scrollBars, unless the dimension properites of the
buttons are set, the button's width and heights are
set to the same as the each other to create square
buttons
| ScrollBar | ||
|
widthForMeasurement():Number
When measure is called, it uses the widthForMeasurement and
heightForMeasurement to calculate the sizes for
percent-dimension based children
| UIContainer | |
| Method | Defined by | ||
|---|---|---|---|
|
calculateMeasuredHeight():void
Calculates the measuredHeight property.
| MeasurableControl | |
|
calculateMeasuredWidth():void
Calculates the measuredWidth property.
| MeasurableControl | |
|
checkNeedsHScrollBar():void
| UIContainer | |
|
checkNeedsVScrollBar():void
| UIContainer | |
|
checkRevalidation():void
| UIContainer | |
|
createChildren():void
This is where the new children should
be created and then added to the displaylist.
| MeasurableControl | |
|
createHScrollBar():void
| UIContainer | |
|
createVScrollBar():void
| UIContainer | |
|
disableEvent(event:Event):void
| MeasurableControl | |
|
dispatchDragStart(event:MouseEvent):void
| UIControl | |
|
dispatchUpdateComplete():void
Dispatches the UpdateComplete event
| MeasurableControl | |
|
doChildBasedValidation():void
| UIContainer | |
|
doQueuedValidateSize(event:Event):void
doQueueValidateSize is executed by the top level UIControl.
| MeasurableControl | |
|
handleMouseWheel(event:MouseEvent):void
| UIContainer | |
|
handlePreDragMouseDown(event:Event):void
This function is called if the UIControl instance is drag enabled
and the user clicks the mouse down.
| UIControl | |
|
hideHScrollBar():void
| UIContainer | |
|
hideVScrollBar():void
| UIContainer | |
|
invalidateDisplayList():void
| MeasurableControl | |
|
onAddedToParent(event:Event):void
The event listener executed when this component
has been added to the parent.
| MeasurableControl | |
|
onHorizontalScroll(event:ScrollEvent):void
Event listener for when the horizontal scrollbar is
used.
| UIContainer | |
|
onHorizontalScrollBarSizeValidated(event:PyroEvent):void
| UIContainer | |
|
onHScrollBarUpdateComplete(event:PyroEvent):void
Event listener for the horizontal scrollbar's
creation and validation event.
| UIContainer | |
|
onSkinnedControlResize(event:Event):void
Event handler for when the UIControl is applied as a Skin
and the control it is skinning is resized.
| UIControl | |
|
onSliderThumbDrag(event:SliderEvent):void
| ScrollBar | ||
|
onSliderUpdateComplete(event:PyroEvent):void
| ScrollBar | ||
|
onVerticalScroll(event:ScrollEvent):void
Event listener for when the vertical scrollbar is
used.
| UIContainer | |
|
onVerticalScrollBarSizeValidated(event:PyroEvent):void
| UIContainer | |
|
onVScrollBarUpdateComplete(event:PyroEvent):void
Event listener for the vertical scrollbar's
creation and validation event.
| UIContainer | |
|
setContentMask():void
| UIContainer | |
|
setVerticalScrollBar():void
| UIContainer | |
|
updateScrollUI():void
| ScrollBar | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| UIControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| ScrollBar | ||||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| _decrementButton | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _decrementButton:Button
| decrementButton | property |
decrementButton:Button [read-write]Implementation
public function get decrementButton():Button
public function set decrementButton(value:Button):void
| _decrementButtonSkin | property |
protected var _decrementButtonSkin:ISkin
| decrementButtonSkin | property |
decrementButtonSkin:ISkin [write-only]Implementation
public function set decrementButtonSkin(value:ISkin):void
| _direction | property |
protected var _direction:String
| direction | property |
direction:String [read-only]Implementation
public function get direction():String
| incrementalScrollDelta | property |
public var incrementalScrollDelta:Number = 25The height/width the scrollbar must scroll when one of the scroll buttons is clicked on.
| _incrementButton | property |
protected var _incrementButton:Button
| incrementButton | property |
incrementButton:Button [read-write]Implementation
public function get incrementButton():Button
public function set incrementButton(value:Button):void
| _incrementButtonSkin | property |
protected var _incrementButtonSkin:ISkin
| incrementButtonSkin | property |
incrementButtonSkin:ISkin [write-only]Implementation
public function set incrementButtonSkin(value:ISkin):void
| maximum | property |
maximum:Number [read-write]Implementation
public function get maximum():Number
public function set maximum(value:Number):void
| _maxScroll | property |
protected var _maxScroll:Number = NaN
| minimum | property |
minimum:Number [read-write]Implementation
public function get minimum():Number
public function set minimum(value:Number):void
| _scrollButtonSize | property |
protected var _scrollButtonSize:Number = NaN
| skin | property |
| _slider | property |
protected var _slider:Slider
| slider | property |
slider:Slider [read-write]Implementation
public function get slider():Slider
public function set slider(value:Slider):void
| value | property |
value:Number [read-write]Implementation
public function get value():Number
public function set value(value:Number):void
| _visibleScroll | property |
protected var _visibleScroll:Number = NaN
| ScrollBar | () | constructor |
public function ScrollBar(direction:String)Parameters
direction:String |
| initialize | () | method |
public override function initialize():voidAt the very least, a scrollBar needs a slider or some subclass of it. Increment and Decrement Buttons are created automatically when a skin is applied.
| onSliderThumbDrag | () | method |
| onSliderUpdateComplete | () | method |
| setScrollProperty | () | method |
public function setScrollProperty(visibleScroll:Number, maxScroll:Number):voidFor example: setScrollProperty(scrollHeight, contentHeight);
ParametersvisibleScroll:Number — The height of the viewport being scrolled
|
|
maxScroll:Number — The height of the content to be scrolled
|
| updateScrollUI | () | method |
protected function updateScrollUI():void
| validateSize | () | method |
public override function validateSize():voidFor scrollBars, unless the dimension properites of the buttons are set, the button's width and heights are set to the same as the each other to create square buttons
| scroll | event |