| Package | lunas.components.bars |
| Class | public class CoreScrollbar |
| Inheritance | CoreScrollbar CoreProgressbar CoreProgress CoreComponent Background CoreSprite flash.display.Sprite |
| Implements | Scrollbar |
| Subclasses | SimpleScrollbar |
Scrollbar display components,
to minimize the effort required to implement this interface.
| Property | Defined By | ||
|---|---|---|---|
![]() | align : uint
The alignement of the background. | Background | |
![]() | autoResetPosition : Boolean
This flag indicates of the position is auto reset. | CoreProgress | |
![]() | autoSize : Boolean
Indicates if the background is resizing when the stage resize event is invoked. | Background | |
| bar : Sprite
The bar display of the scrollbar. | CoreScrollbar | ||
![]() | border : EdgeMetrics
Indicates the thickness, in pixels, of the four edge regions around a visual component. | CoreComponent | |
![]() | bottomLeftRadius : Number
The radius of the bottom-left corner, in pixels. | Background | |
![]() | bottomRightRadius : Number
The radius of the bottom-right corner, in pixels. | Background | |
![]() | bubbles : Boolean = true
Indicates if the events use bubbling when are dispatched. | CoreComponent | |
![]() | builder : Builder
Indicates the Builder reference of this instance. | CoreComponent | |
![]() | componentInspectorSetting : Boolean
Initialize when the Flash component settings are initialized (only in Flash with a compiled component). | CoreComponent | |
![]() | direction : String
Indicates the direction value of the background when the display is in this "full" mode (default value is null). | Background | |
![]() | enabled : Boolean
Indicates the enabled state of the component. | CoreComponent | |
![]() | fill : IFillStyle
Determinates the IFillStyle reference of this display. | Background | |
![]() | gradientMatrix : Matrix
The matrix value to draw the gradient fill. | Background | |
![]() | gradientRotation : Number = 0
The rotation value to draw the gradient fill. | Background | |
![]() | gradientTranslation : Point
The translation vector to draw the gradient fill. | Background | |
![]() | group : Boolean
Indicates with a boolean if this object is grouped. | CoreComponent | |
![]() | groupName : String
Indicates the name of the group of this object. | CoreComponent | |
![]() | h : Number
Determinates the virtual height value of this component. | Background | |
| invert : Boolean
Indicates if the layout direction of the thumb is invert. | CoreScrollbar | ||
| isDragging : Boolean [read-only]
Indicates if the bar is dragging. | CoreScrollbar | ||
![]() | isFull : Boolean
Indicates if the background use full size (use Stage.stageWidth and Stage.stageHeight to resize the background). | Background | |
![]() | layout : Layout
Determinates the layout of this container. | CoreComponent | |
![]() | line : ILineStyle
Determinates the ILineStyle reference of this display. | Background | |
| lineScrollSize : Number
Determines how much the scrollbar's value will change when one of the arrow buttons is clicked. | CoreScrollbar | ||
![]() | logger : Logger
Determinates the internal ILogger reference of this Logable object. | CoreSprite | |
![]() | maxHeight : Number
This property defined the maximum height of this display. | Background | |
![]() | maximum : Number
The maximum value of this scrollbar. | CoreProgress | |
![]() | maxWidth : Number
Defines the maximum width of this display. | Background | |
![]() | minHeight : Number
This property defined the mimimun height of this display (This value is >= 0). | Background | |
![]() | minimum : Number
The minimum value of this scrollbar. | CoreProgress | |
![]() | minWidth : Number
This property defined the mimimun width of this display (This value is >= 0). | Background | |
| pageSize : Number
Determines the amount the value will change if the user clicks above or below the thumb. | CoreScrollbar | ||
![]() | position : Number
Indicates the position of the progress bar. | CoreProgress | |
![]() | style : Style
Returns the style of this component. | CoreComponent | |
| thumb : Sprite
The thumb display of the scrollbar. | CoreScrollbar | ||
| thumbSize : Number
Determinates the size of the thumb. | CoreScrollbar | ||
![]() | topLeftRadius : Number
The radius of the upper-left corner, in pixels. | Background | |
![]() | topRightRadius : Number
The radius of the upper-right corner, in pixels. | Background | |
![]() | useGradientBox : Boolean
Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle). | Background | |
![]() | w : Number
Determinates the virtual height value of this component. | Background | |
| Method | Defined By | ||
|---|---|---|---|
CoreScrollbar(direction:String = vertical, w:Number = 150, h:Number = 6)
Creates a new CoreScrollbar instance. | CoreScrollbar | ||
![]() | doLater():void
Launch an event with a delayed interval. | Background | |
dragging(e:Event = null):void
Invoked when the bar is dragging. | CoreScrollbar | ||
![]() | draw(... arguments):void
Draw the display. | Background | |
![]() | getBuilderRenderer():Class
Returns the Builder constructor use to initialize this component. | CoreComponent | |
![]() | getStyleRenderer():Class
Returns the Style constructor use to initialize this component. | CoreComponent | |
![]() | groupPolicyChanged():void
Invoked when the group property or the groupName property changed. | CoreComponent | |
![]() | hide():void
Hides the component. | CoreComponent | |
![]() | initBackgroundPen(graphic:* = null):IPen
Init the pen to draw the background of this display. | Background | |
![]() | initialize():void
Initialize the component. | CoreComponent | |
![]() | isLocked():Boolean
Returns true if the object is locked. | CoreSprite | |
![]() | isVisible():Boolean
Returns true if the component is visible. | CoreComponent | |
![]() | lock():void [override]
Locks the object. | CoreComponent | |
![]() | move(x:Number, y:Number):void
Moves the component. | CoreComponent | |
![]() | notifyChanged():void
Notify a change in this component. | CoreComponent | |
notifyDrag():void
Dispatchs an event when the user drag the bar. | CoreScrollbar | ||
![]() | notifyEnabled():void
Notify an event when the enabled property is changed. | CoreComponent | |
![]() | notifyResized():void
Notify an event when you resize the component. | Background | |
notifyStartDrag():void
Dispatchs an event when the user start to drag the bar. | CoreScrollbar | ||
notifyStopDrag():void
Dispatchs an event when the user stop to drag the bar. | CoreScrollbar | ||
![]() | refresh(init:*):void
Refresh and initialize the display with a generic object and invoke the "update" method. | Background | |
![]() | registerView(scope:DisplayObjectContainer = null):void
Registers the view of this component. | CoreComponent | |
![]() | resetLock():void
Reset the lock security of the display. | CoreSprite | |
![]() | resize(e:Event = null):void
Resize and update the background. | Background | |
![]() | scope():DisplayObject
Returns the real scope reference of this component. | CoreComponent | |
![]() | setCornerRadius(n:Number):void
Defines all corner radius of the background (upper-left, upper-right, bottom-left and bottom-right). | Background | |
![]() | setPosition(value:Number, noEvent:Boolean = false, flag:Boolean = false):void
Sets the position of the progress bar. | CoreProgress | |
![]() | setSize(w:Number, h:Number):void
Sets the virtual width (w) and height (h) values of the component. | Background | |
![]() | setStyle(... args):void
Sets the style property on the style declaration or object. | CoreComponent | |
![]() | show():void
Shows the component. | CoreComponent | |
startDragging(e:Event = null):void
Invoked when the user start to drag the bar. | CoreScrollbar | ||
stopDragging(e:Event = null):void
Invoked when the user stop to drag the bar. | CoreScrollbar | ||
![]() | unlock():void [override]
Unlocks the display. | CoreComponent | |
![]() | unregisterView():void
Unregisters the view of this component. | CoreComponent | |
![]() | update():void [override]
Updates the component. | CoreComponent | |
![]() | viewChanged():void [override]
Invoked when the view of the display is changed. | CoreProgress | |
![]() | viewDestroyed(e:Event = null):void
Invoked when the component is removed. | CoreComponent | |
![]() | viewEnabled():void
Invoked when the enabled property of the component change. | Background | |
viewPositionChanged(flag:Boolean = false):void [override]
Invoked when the position value of the bar is changed. | CoreScrollbar | ||
![]() | viewResize():void
Invoked when the component is resized. | Background | |
![]() | viewStyleChanged(e:Event = null):void
Invoked when the component Style changed. | CoreComponent | |
| Method | Defined By | ||
|---|---|---|---|
_fireButtonEvent(type:String):void
Dispatchs a ButtonEvent with the specified type. | CoreScrollbar | ||
![]() | addedToStage(e:Event = null):void
Invoked when the display is added to the stage. | CoreSprite | |
![]() | addedToStageResize(e:Event = null):void
Invoked when the display is removed from the stage to enable the autoSize mode. | Background | |
![]() | fireComponentEvent(type:String):void
Dispatchs a ComponentEvent with the specified type. | CoreComponent | |
![]() | removedFromStage(e:Event = null):void
Invoked when the display is removed from the stage. | CoreSprite | |
![]() | removedFromStageResize(e:Event = null):void
Invoked when the display is removed from the stage to disable the autoSize mode. | Background | |
![]() | renderLayout(layout:Layout = null):void
Receives a message when the layout emit when is rendered. | CoreComponent | |
![]() | updateLayout(layout:Layout = null):void
Receives a message when the layout emit when is updated. | CoreComponent | |
| bar | property |
bar:SpriteThe bar display of the scrollbar.
public function get bar():Sprite public function set bar(value:Sprite):void| invert | property |
invert:BooleanIndicates if the layout direction of the thumb is invert.
public function get invert():Boolean public function set invert(value:Boolean):void| isDragging | property |
isDragging:Boolean [read-only] Indicates if the bar is dragging.
public function get isDragging():Boolean| lineScrollSize | property |
lineScrollSize:NumberDetermines how much the scrollbar's value will change when one of the arrow buttons is clicked. If the scrollbar is being used to control something like a text area, this should probably be set to one, to cause the text to scroll one line. If it is scrolling a picture or movie clip, it should probably be set to a larger amount.
public function get lineScrollSize():Number public function set lineScrollSize(value:Number):void| pageSize | property |
pageSize:NumberDetermines the amount the value will change if the user clicks above or below the thumb. If this amount is 0 the thumb will move with the lineScrollSize value.
public function get pageSize():Number public function set pageSize(value:Number):void| thumb | property |
thumb:SpriteThe thumb display of the scrollbar.
public function get thumb():Sprite public function set thumb(value:Sprite):void| thumbSize | property |
thumbSize:NumberDeterminates the size of the thumb.
public function get thumbSize():Number public function set thumbSize(value:Number):void| CoreScrollbar | () | Constructor |
public function CoreScrollbar(direction:String = vertical, w:Number = 150, h:Number = 6)Creates a new CoreScrollbar instance.
Parametersdirection:String (default = vertical) — The direction value of the bar (see Direction).
| |
w:Number (default = 150) — The prefered width of the button (default 120 pixels).
| |
h:Number (default = 6) — The prefered height of the button (default 20 pixels).
|
| _fireButtonEvent | () | method |
protected function _fireButtonEvent(type:String):voidDispatchs a ButtonEvent with the specified type.
Parameters
type:String |
| dragging | () | method |
public function dragging(e:Event = null):voidInvoked when the bar is dragging.
Parameters
e:Event (default = null) |
| notifyDrag | () | method |
public function notifyDrag():voidDispatchs an event when the user drag the bar.
| notifyStartDrag | () | method |
public function notifyStartDrag():voidDispatchs an event when the user start to drag the bar.
| notifyStopDrag | () | method |
public function notifyStopDrag():voidDispatchs an event when the user stop to drag the bar.
| startDragging | () | method |
public function startDragging(e:Event = null):voidInvoked when the user start to drag the bar.
Parameters
e:Event (default = null) |
| stopDragging | () | method |
public function stopDragging(e:Event = null):voidInvoked when the user stop to drag the bar.
Parameters
e:Event (default = null) |
| viewPositionChanged | () | method |
override public function viewPositionChanged(flag:Boolean = false):voidInvoked when the position value of the bar is changed.
Parameters
flag:Boolean (default = false) |