| Package | mx.controls |
| Class | public class HScrollBar |
| Inheritance | HScrollBar  ScrollBar UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Although you can use the HScrollBar control as a stand-alone control, you usually combine it as part of another group of components to provide scrolling functionality.
A ScrollBar control consist of four parts: two arrow buttons, a track, and a thumb. The position of the thumb and the display of the buttons depend on the current state of the control. The ScrollBar control uses four parameters to calculate its display state:
Hide MXML Syntax
The <mx:HScrollBar> tag inherits all of the
tag attributes of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:HScrollBar
Styles
repeatDelay="500"
repeatInterval="35"
Events
scroll="No default"
/>
See also
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| HScrollBar | ||
 |
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the
DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later.
| UIComponent | |
|
Deletes a style property from this component instance.
| UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
|
Converts a
Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a
Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
| UIComponent | ||
|
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
Ends all currently playing effects on the component.
| UIComponent | |
|
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
Called after printing is complete.
| UIComponent | |
|
Provides the automation object at the specified index.
| UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
|
Returns the child display object instance that exists at the specified index.
| DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name.
| DisplayObjectContainer | |
|
Returns the index position of a
child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus.
| UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the
targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
Converts a
Point object from global to content coordinates. | UIComponent | |
|
Converts the
point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Evaluates the display object to see if it overlaps or intersects with the
obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the
x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component.
| UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Converts a
Point object from local to content coordinates. | UIComponent | |
|
Converts the
point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Moves the component to a specified position within its parent.
| UIComponent | |
|
Propagate style changes to the children.
| UIComponent | |
|
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, register the EffectManager
as one of the event listeners.
| UIComponent | |
|
Removes the specified
child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified
index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Replays the specified event.
| UIComponent | |
|
Resolves a child by using the id provided.
| UIComponent | |
|
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object.
| UIComponent | |
|
Changes the position of an existing child in the display object container.
| DisplayObjectContainer | |
|
Set the current state.
| UIComponent | |
|
Sets the focus to this component.
| UIComponent | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void
Sets the range and viewport size of the ScrollBar control.
| ScrollBar | |
|
Sets a style property on this component instance.
| UIComponent | |
|
Called when the
visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite.
| Sprite | |
|
Ends the
startDrag() method. | Sprite | |
|
Detects changes to style properties.
| UIComponent | |
|
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
|
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
|
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object.
| Object | |
|
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when Flash Player gains operating system focus and becomes active. | EventDispatcher | ||
|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
|
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | ||
| Dispatched when Flash Player loses operating system focus and is becoming inactive. | EventDispatcher | ||
|
Dispatched when a user presses and releases the main button of a pointing device twice in
rapid succession over the same InteractiveObject when that object's
doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
|
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the ScrollBar control scrolls through user initiated action or programmatically. | HScrollBar | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
|
Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
|
Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
|
Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
|
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | ||
|
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: no Color of the border. | ScrollBar | ||
| Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its parent container. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the down arrow button of the scroll bar when it is disabled. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the down arrow button of the scroll bar when you click the arrow button . | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the down arrow button of the scroll bar when the mouse pointer is over the arrow button. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the down arrow button of the scroll bar. | ScrollBar | ||
| Type: Array CSS Inheritance: no Alphas used for the background fill of controls. | ScrollBar | ||
| Type: Array Format: Color CSS Inheritance: no Colors used to tint the background of the control. | ScrollBar | ||
| Type: Array CSS Inheritance: no Alpha transparencies used for the highlight fill of controls. | ScrollBar | ||
| Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the center of the component's parent container to the center of the component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's parent container to the left edge of the component. | UIComponent | ||
|
repeatDelay
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds to wait after the first buttonDown
event before repeating buttonDown events at the
repeatInterval.
The default value is 500.
| HScrollBar | ||
|
repeatInterval
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds between buttonDown events
if the user presses and holds the mouse on a button.
The default value is 35.
| HScrollBar | ||
| Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its parent container. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the thumb of the scroll bar when you click the thumb. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the icon for the thumb of the scroll bar. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the thumb of the scroll bar when the mouse pointer is over the thumb. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the thumb of the scroll bar. | ScrollBar | ||
| Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the top edge of the component's parent container to the top edge of the component. | UIComponent | ||
| Type: Array Format: Color CSS Inheritance: no The colors of the track, as an array of two colors. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the track of the scroll bar. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the up arrow button of the scroll bar when it is disabled. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the up arrow button of the scroll bar when you click the arrow button. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the up arrow button of the scroll bar when the mouse pointer is over the arrow button. | ScrollBar | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the up arrow button of the scroll bar. | ScrollBar | ||
| Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the center of the component's parent container to the center of the component. | UIComponent | ||
| HScrollBar | () | constructor |
public function HScrollBar()Constructor.
| scroll | event |
mx.events.ScrollEvent
mx.events.ScrollEvent.SCROLL
Dispatched when the ScrollBar control scrolls through user initiated action or programmatically.
The ScrollEvent.SCROLL constant defines the value of the
type property of the event object for a scroll event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
delta | Contains the change in scroll position, expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left. |
direction | Contains the
scroll direction, either ScrollEventDirection.HORIZONTAL or
ScrollEventDirection.VERTICAL. |
position | Contains the new scroll position. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the HScrollBar control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
import mx.events.ScrollEvent;
// Event handler function to display the scroll location
// as you move the scroll thumb.
private function myScroll(event:ScrollEvent):void
{
showPosition.text = "HScrollBar properties summary:" + '\n' +
"------------------------------------" + '\n' +
"Current scroll position: " + event.currentTarget.scrollPosition + '\n' +
"The maximum scroll position: " + event.currentTarget.maxScrollPosition + '\n' +
"The minimum scroll position: " + event.currentTarget.minScrollPosition ;
}
]]>
</mx:Script>
<mx:Panel id="panel" title="HScrollBar Control Example" height="75%" width="75%"
paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">
<mx:Label width="100%" color="blue"
text="Click on the scroll bar to view its properties."/>
<mx:HScrollBar id="bar" width="100%"
minScrollPosition="0" maxScrollPosition="{panel.width - 20}"
lineScrollSize="50" pageScrollSize="100"
scroll="myScroll(event);"
repeatDelay="1000" repeatInterval="500" />
<mx:TextArea height="100%" width="100%" id="showPosition" color="blue" />
</mx:Panel>
</mx:Application>
