Packagecom.addicted2flash.layout.component
Interfacepublic interface IUIScrollBar extends IUIContainer, IUIComponent, ILayoutObservable, IDisposable
ImplementorsUIScrollBar, UIScroller

Interface for scrollbar implementations.



Public Properties
 PropertyDefined by
 Inheritedbounds : Rectangle
Returns a copy of the bounds of the component.
IUIComponent
 InheritedcomponentCount : int
Returns the total amount of components in the container.
IUIContainer
 Inheritedconstraint : Object
Returns the constraint of the component.
IUIComponent
 InheritedcontentHeight : Number
Returns the occupied height of all components.
IUIContainer
 InheritedcontentWidth : Number
Returns the occupied width of all components.
IUIContainer
  currentStep : int
[read-only] Returns the current step of the scrollbar.
IUIScrollBar
 InheriteddesiredHeight : Number
Returns the desired height of the component.
IUIComponent
 InheriteddesiredPercentHeight : Number
Sets the desired height of the component as percent value.
IUIComponent
 InheriteddesiredPercentWidth : Number
Sets the desired width of the component as percent value.
IUIComponent
 InheriteddesiredWidth : Number
Returns the desired width of the component.
IUIComponent
 InheritedhasPercentagedHeight : Boolean
Returns true if desired height should be calculated in percentaged values.
IUIComponent
 InheritedhasPercentagedWidth : Boolean
Returns true if desired width should be calculated in percentaged values.
IUIComponent
 Inheritedheight : Number
Returns the height of the component.
IUIComponent
 InheritedhorizontalAlignment : int
Returns the horiziontal alignment of the component.
IUIComponent
 InheritedisValid : Boolean
Returns true if component is in a valid state.
IUIComponent
 Inheritedlayout : ILayout
Returns the layout of the container.
IUIContainer
 InheritedlayoutObserverCount : int
Returns the total amount of ILayoutObserver of this ILayoutObservable.
ILayoutObservable
 Inheritedmargin : Margin
Returns the margin of the component.
IUIComponent
 InheritedmaximumHeight : Number
Returns the maximum height of the component.
IUIComponent
 InheritedmaximumWidth : Number
Returns the maximum width of the component.
IUIComponent
 InheritedmeasuredDesiredHeight : Number
Sets the measured desired height of the component.
IUIComponent
 InheritedmeasuredDesiredWidth : Number
Sets the measured desired width of the component.
IUIComponent
 InheritedmeasuredMinimumHeight : Number
Sets the measured minimum height of the component.
IUIComponent
 InheritedmeasuredMinimumWidth : Number
Sets the measured minimum width of the component.
IUIComponent
 InheritedminimumHeight : Number
Returns the minimum height of the component.
IUIComponent
 InheritedminimumWidth : Number
Returns the minimum width of the component.
IUIComponent
  orientation : int
Returns the orientation of the scrollbar.
IUIScrollBar
 Inheritedpadding : Padding
Returns the padding of the component.
IUIComponent
 InheritedparentContainer : IUIContainer
Returns the parent IUIContainer of the component.
IUIComponent
  scrollPosition : Number
Returns the normalized position of the thumb in relation to the scrollbar (between 0 and 1).
IUIScrollBar
  scrollSize : Number
Returns the normalized size of the thumb in relation to the scrollbar (between 0 and 1).
IUIScrollBar
 Inheritedstate : int
Returns the state of the component.
IUIComponent
  stepSize : Number
Returns the normalized size of a step (between 0 and 1).
IUIScrollBar
 InheritedverticalAlignment : int
Returns the vertical alignment of the component.
IUIComponent
 Inheritedwidth : Number
Returns the width of the component.
IUIComponent
 Inheritedx : Number
Returns the x position of the component.
IUIComponent
 Inheritedy : Number
Returns the y position of the component.
IUIComponent
Public Methods
 MethodDefined by
 Inherited
add(c:IUIComponent, constraint:Object = null):IUIComponent
Adds a component to the container with a given constraint.
IUIContainer
 Inherited
addAt(i:int, c:IUIComponent, constraint:Object = null):IUIComponent
Adds a component to the container, at a spcific index, with a given constraint.
IUIContainer
 Inherited
Adds an ILayoutObserver to the set of observers for this object, provided that it is not the same as some observer already in the set.
ILayoutObservable
 Inherited
Returns true if given component exists within containers list.
IUIContainer
 Inherited
dispose():void
free memory for garbage collection.
IDisposable
 Inherited
findComponent(x:Number, y:Number):IUIComponent
Returns the component at the given position.
IUIContainer
 Inherited
Returns the component at the given index.
IUIContainer
 Inherited
Returns the index of the given component.
IUIContainer
 Inherited
invalidate():void
Component will be measured and rearranged.
IUIComponent
 Inherited
lock():void
Locks invalidation lifecycle when adding/removing components (no internal invalidate() calls after add/remove).
IUIContainer
 Inherited
move(x:Number, y:Number):Boolean
Sets the position of the component and returns true if position has changed.
IUIComponent
 Inherited
notifyLayoutObservers(type:int):void
Registered ILayoutObserver will be notified.
ILayoutObservable
 Inherited
Removes a component from the container.
IUIContainer
 Inherited
removeAll():void
Removes all components from the container.
IUIContainer
 Inherited
Removes a component from the container, at a specific index.
IUIContainer
 Inherited
Deletes an ILayoutObserver from the set of observers of this object.
ILayoutObservable
 Inherited
resize(w:Number, h:Number):Boolean
Sets the size of the bounds and the desired size (pixel values) of the component.
IUIComponent
 Inherited
setAt(i:int, c:IUIComponent, constraint:Object = null):IUIComponent
Replaces a component at a given index.
IUIContainer
 Inherited
setLayoutSize(w:Number, h:Number):Boolean
This method is used for updating the size of the bounds within a validation lifecycle (in arrange process within a container).
IUIComponent
 Inherited
unlock():void
Unlocks invalidation lifecycle and calls invalidate() if container is not valid.
IUIContainer
Property detail
currentStepproperty
currentStep:int  [read-only]

Returns the current step of the scrollbar.

Implementation
    public function get currentStep():int
orientationproperty 
orientation:int  [read-write]

Returns the orientation of the scrollbar.

Implementation
    public function get orientation():int
    public function set orientation(value:int):void

See also

Orientation
scrollPositionproperty 
scrollPosition:Number  [read-write]

Returns the normalized position of the thumb in relation to the scrollbar (between 0 and 1).

Implementation
    public function get scrollPosition():Number
    public function set scrollPosition(value:Number):void
scrollSizeproperty 
scrollSize:Number  [read-write]

Returns the normalized size of the thumb in relation to the scrollbar (between 0 and 1).

Implementation
    public function get scrollSize():Number
    public function set scrollSize(value:Number):void
stepSizeproperty 
stepSize:Number  [read-write]

Returns the normalized size of a step (between 0 and 1).

The size determines the size of a step when a mousewheel or keyboard event occures.

Implementation
    public function get stepSize():Number
    public function set stepSize(value:Number):void