mx.controls.scrollClasses
Class ScrollBar
Direct Known Subclasses
           mx.controls.HScrollBar, mx.controls.VScrollBar

class ScrollBar
extends mx.core.UIComponent

The ScrollBar class is the base class for HScrollBar and VScrollBar controls. A ScrollBar control is a window with a title bar, caption and optional close button. The user can use the title bar to drag the window to a new location.

MXML Syntax

The <mx:ScrollBar> control defines the following properties: 

 <mx:ScrollBar
   lineScrollSize="1"
   maxPos="0"
   minPos="0"
   pageScrollSize="Reset to the pageSize parameter of setScrollProperties"
   pageSize="0"
   scrollPosition="0"
   scroll="Event handler; no default."
 />

See Also
mx.controls.SimpleButton
mx.controls.scrollClasses.ScrollThumb


Methods
      setScrollProperties(pSize:Number, mnPos:Number, mxPos:Number, ls:Number) : Void
Sets the range and viewport size for the ScrollBar.

Methods inherited from class mx.core.UIComponent
getFocus  setFocus  getFocusManager 

Methods inherited from class mx.core.UIObject
createAccessibilityImplementation  measure  doLater  cancelAllDoLaters  invalidate  invalidateStyle  invalidateProperties  invalidateSize  redraw  move  setSize  setSizeNoLayout  drawRect  fillRect  destroyLabel  createClassObject  createEmptyObject  destroyObject  getStyle  setMask  swapDepths 


Properties
      className:String  
Name of this class.
      scrollPosition:Number   [Read-Write]
Current scroll position.
      pageScrollSize:Number   [Read-Write]
Amount to move when the track is pressed.
      lineScrollSize:Number   [Read/Write]
Amount to move when an arrow button is pressed.

Properties inherited from class mx.core.UIComponent
version  enabled  tabIndex 

Properties inherited from class mx.core.UIObject
version  nestLevel  dispatchEvent  addEventListener  handleEvent  removeEventListener  kStretch  styleName  className  setStyle  parentApplication  isDocument  parentDocument  documentDescriptor  descriptor  instanceIndices  repeaterIndices  getRepeaterItem  id  width  height  x  y  minHeight  minWidth  preferredHeight  preferredWidth  maxHeight  maxWidth  widthFlex  heightFlex  visible  scaleX  scaleY  alpha  depth  mouseX  mouseY  toolTip  baselinePosition 


Effects

Effects inherited from class mx.core.UIComponent
showEffect  hideEffect  focusInEffect  focusOutEffect 

Effects inherited from class mx.core.UIObject
creationCompleteEffect  moveEffect  resizeEffect  mouseDownEffect  mouseOverEffect  mouseOutEffect  mouseUpEffect 


Events

Events inherited from class: mx.core.UIComponent
focusIn  focusOut  keyDown  keyUp  show  hide  valid  invalid  valueCommitted 

Events inherited from class: mx.core.UIObject
initialize  creationComplete  resize  move  draw  load  unload  mouseDown  mouseUp  mouseMove  mouseOver  mouseOut  mouseDownSomewhere  mouseUpSomewhere  mouseMoveSomewhere  mouseChangeSomewhere  effectStart  effectEnd  dragBegin  dragComplete  dragEnter  dragOver  dragExit  dragDrop 


Styles

Styles inherited from class mx.core.UIComponent
backgroundColor  backgroundDisabledColor  backgroundImage  backgroundAlpha  backgroundSize  barColor  borderCapColor  borderColor  buttonColor  borderStyle  disabledColor  errorColor  highlightColor  lineHeight  modalTransparency  scrollTrackColor  shadowColor  shadowCapColor  symbolColor  symbolBackgroundColor  symbolBackgroundDisabledColor  symbolBackgroundPressedColor  symbolDisabledColor  themeColor 

Styles inherited from class mx.core.UIObject
color  fontFamily  fontSize  fontStyle  fontWeight  textAlign  textDecoration  textIndent  marginLeft  marginRight  horizontalGap  verticalGap 


Method Detail

setScrollProperties

setScrollProperties(pSize:Number, mnPos:Number, mxPos:Number, ls:Number) : Void

Sets the range and viewport size for the ScrollBar. The ScrollBar control updates the state of the buttons and size of the thumb accordingly.

Parameters
     pSize - Increment to move when the track is pressed.
     mnPos - Bottom of the scrolling range.
     mxPos - Top of the scrolling range.
     ls - Increment to move when an arrow button is pressed.


Property Detail

className

className:String  

Name of this class.

lineScrollSize

lineScrollSize:Number   [Read/Write]

Amount to move when an arrow button is pressed.

pageScrollSize

pageScrollSize:Number   [Read-Write]

Amount to move when the track is pressed.

scrollPosition

scrollPosition:Number   [Read-Write]

Current scroll position.