| Package | com.addicted2flash.layout.component |
| Class | public class UIScrollBar |
| Inheritance | UIScrollBar  UIContainer UIComponent flash.display.Sprite |
| Implements | IUIScrollBar |
IUIScrollBarObservers get notifications about
the change of the scroll position. In addition it is possible to set the scroll size
or the scroll position.
| Property | Defined by | ||
|---|---|---|---|
 | bounds : Rectangle
Returns a copy of the bounds of the component.
| UIComponent | |
| componentCount : int
Returns the total amount of components in the container.
| UIContainer | |
| constraint : Object
Returns the constraint of the component.
| UIComponent | |
| contentHeight : Number
Returns the occupied height of all components.
| UIContainer | |
| contentWidth : Number
Returns the occupied width of all components.
| UIContainer | |
| currentStep : int [read-only]
Returns the current step of the scrollbar.
| UIScrollBar | ||
| desiredHeight : Number
Returns the desired height of the component.
| UIComponent | |
| desiredPercentHeight : Number
Sets the desired height of the component as percent value.
| UIComponent | |
| desiredPercentWidth : Number
Sets the desired width of the component as percent value.
| UIComponent | |
| desiredWidth : Number
Returns the desired width of the component.
| UIComponent | |
| hasPercentagedHeight : Boolean
Returns true if desired height should be calculated in percentaged values.
| UIComponent | |
| hasPercentagedWidth : Boolean
Returns true if desired width should be calculated in percentaged values.
| UIComponent | |
| height : Number
Returns the height of the component.
| UIComponent | |
| horizontalAlignment : int
Returns the horiziontal alignment of the component.
| UIComponent | |
| isValid : Boolean
Returns true if component is in a valid state.
| UIComponent | |
| layout : ILayout
Returns the layout of the container.
| UIContainer | |
| layoutObserverCount : int
Returns the total amount of
ILayoutObserver of this ILayoutObservable. | UIComponent | |
| margin : Margin
Returns the margin of the component.
| UIComponent | |
| maximumHeight : Number
Returns the maximum height of the component.
| UIComponent | |
| maximumWidth : Number
Returns the maximum width of the component.
| UIComponent | |
| measuredDesiredHeight : Number
Sets the measured desired height of the component.
| UIComponent | |
| measuredDesiredWidth : Number
Sets the measured desired width of the component.
| UIComponent | |
| measuredMinimumHeight : Number
Sets the measured minimum height of the component.
| UIComponent | |
| measuredMinimumWidth : Number
Sets the measured minimum width of the component.
| UIComponent | |
| minimumHeight : Number
Returns the minimum height of the component.
| UIComponent | |
| minimumWidth : Number
Returns the minimum width of the component.
| UIComponent | |
| orientation : int
Returns the orientation of the scrollbar.
| UIScrollBar | ||
| padding : Padding
Returns the padding of the component.
| UIComponent | |
| parentContainer : IUIContainer
Returns the parent
IUIContainer of the component. | UIComponent | |
| scroller : UIScroller
[write-only]
Sets the parent scroller.
| UIScrollBar | ||
| scrollPosition : Number
Returns the normalized position of the thumb in relation to the scrollbar (between 0 and 1).
| UIScrollBar | ||
| scrollSize : Number
Returns the normalized size of the thumb in relation to the scrollbar (between 0 and 1).
| UIScrollBar | ||
| state : int
Returns the state of the component.
| UIComponent | |
| stepSize : Number
Returns the normalized size of a step (between 0 and 1).
| UIScrollBar | ||
| verticalAlignment : int
Returns the vertical alignment of the component.
| UIComponent | |
| width : Number
Returns the width of the component.
| UIComponent | |
| x : Number
Returns the x position of the component.
| UIComponent | |
| y : Number
Returns the y position of the component.
| UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
Creates a new
UIScrollBar. | UIScrollBar | ||
|
Adds a component to the container with a given constraint.
| UIContainer | |
|
Adds a component to the container, at a spcific index, with a given constraint.
| UIContainer | |
|
addLayoutObserver(o:ILayoutObserver):void
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. | UIComponent | |
|
containsComponent(c:IUIComponent):Boolean
Returns true if given component exists within containers list.
| UIContainer | |
|
dispose():void
free memory for garbage collection.
| UIScrollBar | ||
|
findComponent(x:Number, y:Number):IUIComponent
Returns the component at the given position.
| UIContainer | |
|
getAt(i:int):IUIComponent
Returns the component at the given index.
| UIContainer | |
|
indexOfComponent(c:IUIComponent):int
Returns the index of the given component.
| UIContainer | |
|
invalidate():void
Component will be measured and rearranged.
| UIComponent | |
|
lock():void
Locks invalidation lifecycle when adding/removing components (no internal
invalidate()
calls after add/remove). | UIContainer | |
|
move(x:Number, y:Number):Boolean
Sets the position of the component and returns true if position has changed.
| UIComponent | |
|
notifyLayoutObservers(type:int):void
Registered
ILayoutObserver will be notified. | UIComponent | |
|
Removes a component from the container.
| UIContainer | |
|
removeAll():void
Removes all components from the container.
| UIContainer | |
|
removeAt(i:int):IUIComponent
Removes a component from the container, at a specific index.
| UIContainer | |
|
removeLayoutObserver(o:ILayoutObserver):void
Deletes an
ILayoutObserver from the set of observers of this object. | UIComponent | |
|
resize(w:Number, h:Number):Boolean
Sets the size of the bounds and the desired size (pixel values)
of the component.
| UIComponent | |
|
Replaces a component at a given index.
| UIContainer | |
|
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). | UIComponent | |
|
toString():String
Returns the string representation of the scrollbar.
| UIScrollBar | ||
|
unlock():void
Unlocks invalidation lifecycle and calls
invalidate() if container is not valid. | UIContainer | |
| Method | Defined by | ||
|---|---|---|---|
|
arrange():void
Concrete implementations need to override this method to arrange
and size their components, depending on their bounds.
| UIScrollBar | ||
|
horizontalOverflow():void
Concrete implementations need to override this method to handle horizontal overflow.
| UIContainer | |
|
measure():void
Concrete implemenations need to override this method to set its
sizes (measured desired, measured minimum size).
| UIScrollBar | ||
|
measureContentBounds():void
Validates the content bounds of the
UIContainer. | UIContainer | |
|
verticalOverflow():void
Concrete implementations need to override this method to handle vertical overflow.
| UIContainer | |
| currentStep | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescurrentStep:int [read-only]Returns the current step of the scrollbar.
Implementation public function get currentStep():int
| orientation | property |
orientation:int [read-write]Returns the orientation of the scrollbar.
Implementation public function get orientation():int
public function set orientation(value:int):void
| scroller | property |
scroller:UIScroller [write-only]Sets the parent scroller. Necessary when arrows are needed.
Implementation public function set scroller(value:UIScroller):void
| scrollPosition | property |
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
| scrollSize | property |
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
| stepSize | property |
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
| UIScrollBar | () | constructor |
public function UIScrollBar(thumb:UIComponent, track:UIComponent, orientation:int)
Creates a new UIScrollBar.
thumb:UIComponent — the thumb of the scrollbar
|
|
track:UIComponent — the track of the scrollbar
|
|
orientation:int — orientation of the scrollbar
|
See also
| arrange | () | method |
protected override function arrange():voidConcrete implementations need to override this method to arrange and size their components, depending on their bounds.
| dispose | () | method |
public override function dispose():voidfree memory for garbage collection.
| measure | () | method |
protected override function measure():voidConcrete implemenations need to override this method to set its sizes (measured desired, measured minimum size).
This offers the possibility for container implementations to adjust their minimum size to the size of its components.
| toString | () | method |
public override function toString():StringReturns the string representation of the scrollbar.
ReturnsString — the string representation of the scrollbar
|