UIScrollBar class

Inheritance MovieClip > UIObject class > UIComponent class > ScrollBar > UIScrollBar

ActionScript Class Name mx.controls.UIScrollBar

The properties of the UIScrollBar class let you adjust the scroll position and the amount of scrolling that occurs when the user clicks the scroll arrows or the scroll track.

Unlike most other components, events are broadcast when the mouse button is pressed and continue broadcasting until the button is released.

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(mx.controls.UIScrollBar.version);

NOTE

The code trace(myUIScrollBarInstance.version); returns undefined.

Method summary for the UIScrollBar class

The following table lists the method of the UIScrollBar class.

Method	Description
UIScrollBar.setScrollProperties()	Sets the scroll range of the scroll bar and the size of the text field that the scroll bar is attached to.
UIScrollBar.setScrollTarget()	Assigns the scroll bar to a text field.

Methods inherited from the UIObject class

The following table lists the methods the UIScrollBar class inherits from the UIObject class. When calling these methods from the UIScrollBar object, use the form UIScrollBarInstance.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Methods inherited from the UIComponent class

The following table lists the methods the UIScrollBar class inherits from the UIComponent class. When calling these methods from the UIScrollBar object, use the form UIScrollBarInstance.methodName.

Method	Description
UIComponent.getFocus()	Returns a reference to the object that has focus.
UIComponent.setFocus()	Sets focus to the component instance.

Property summary for the UIScrollBar class

The following table lists properties of the UIScrollBar class.

Property	Description
UIScrollBar.lineScrollSize	The number of lines or pixels scrolled when the user clicks the arrow buttons of the scroll bar.
UIScrollBar.pageScrollSize	The number of lines or pixels scrolled when the user clicks the track of the scroll bar.
UIScrollBar.scrollPosition	The current scroll position of the scroll bar.
UIScrollBar._targetInstanceName	The instance name of the text field associated with the UIScrollBar instance.
`UIScrollBar.horizontal`	A Boolean value indicating whether the scroll bar is oriented vertically (`false`), the default, or horizontally (`true`).

Properties inherited from the UIObject class

The following table lists the properties the UIScrollBar class inherits from the UIObject class. When accessing these properties from the UIScrollBar object, use the form UIScrollBarInstance.propertyName.

Property	Description
UIObject.bottom	Read-only; the position of the bottom edge of the object, relative to the bottom edge of its parent.
UIObject.height	Read-only; the height of the object, in pixels.
UIObject.left	Read-only; the left edge of the object, in pixels.
UIObject.right	Read-only; the position of the right edge of the object, relative to the right edge of its parent.
UIObject.scaleX	A number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	Read-only; the position of the top edge of the object, relative to its parent.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	Read-only; the width of the object, in pixels.
UIObject.x	Read-only; the left edge of the object, in pixels.
UIObject.y	Read-only; the top edge of the object, in pixels.

Properties inherited from the UIComponent class

The following table lists the properties the UIScrollBar class inherits from the UIComponent class. When accessing these properties from the UIScrollBar object, use the form UIScrollBarInstance.propertyName.

Property	Description
UIComponent.enabled	Indicates whether the component can receive focus and input.
UIComponent.tabIndex	A number indicating the tab order for a component in a document.

Event summary for the UIScrollBar class

The following table lists the event of the UIScrollBar class.

Event	Description
UIScrollBar.scroll	Broadcast when any part of the scroll bar is clicked.

Events inherited from the UIObject class

The following table lists the events the UIScrollBar class inherits from the UIObject class.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Events inherited from the UIComponent class

The following table lists the events the UIScrollBar class inherits from the UIComponent class.

Event	Description
UIComponent.focusIn	Broadcast when an object receives focus.
UIComponent.focusOut	Broadcast when an object loses focus.
UIComponent.keyDown	Broadcast when a key is pressed.
UIComponent.keyUp	Broadcast when a key is released.

Version 8

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00004226.html