Package | mx.controls.scrollClasses |
Class | public class ScrollBar |
Inheritance | ScrollBar UIComponent FlexSprite flash.display.Sprite |
Subclasses | HScrollBar, VScrollBar |
The width of a scroll bar is equal to the largest width of its subcomponents (up arrow, down arrow, thumb, and track). Every subcomponent is centered in the scroll bar.
MXML Syntax Hide MXML SyntaxThe <mx:ScrollBar>
tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
<mx:ScrollBar Properties direction="vertical|horizontal" lineScrollSize="1" maxScrollPosition="0" minScrollPosition="0" pageScrollSize="Reset to the pageSize parameter of setScrollProperties" pageSize="0" scrollPosition="0" Styles borderColor="0xB7BABC" cornerRadius="0" disabledIconColor="0x999999" downArrowDisabledSkin="mx.skins.halo.ScrollArrowSkin" downArrowDownSkin="mx.skins.halo.ScrollArrowSkin" downArrowOverSkin="mx.skins.halo.ScrollArrowSkin" downArrowUpSkin="mx.skins.halo.ScrollArrowSkin" fillAlphas="[0.6, 0.4]" fillColors="[0xFFFFFF, 0xCCCCCC]" highlightAlphas="[0.3, 0.0]" iconColor="0x111111" thumbDownSkin="mx.skins.halo.ScrollThumbSkin" thumbIcon="undefined" thumbOffset="0" thumbOverSkin="mx.skins.halo.ScrollThumbSkin" thumbUpSkin="mx.skins.halo.ScrollThumbSkin" trackColors="[0x94999b, 0xe7e7e7]" trackSkin="mx.skins.halo.ScrollTrackSkin" upArrowDisabledSkin="mx.skins.halo.ScrollArrowSkin" upArrowDownSkin="mx.skins.halo.ScrollArrowSkin" upArrowOverSkin="mx.skins.halo.ScrollArrowSkin" upArrowUpSkin="mx.skins.halo.ScrollArrowSkin" />
See also
Property | Defined by | ||
---|---|---|---|
activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | ||
automationName : String
Name that can be used as an identifier for this object.
| UIComponent | ||
automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | ||
baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | ||
cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | ||
className : String
The name of this instance's class, such as
"Button" . | UIComponent | ||
contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | ||
contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | ||
currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | ||
currentState : String
The current view state of the component.
| UIComponent | ||
cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
direction : String
Specifies whether the ScrollBar is for horizontal or vertical scrolling.
| ScrollBar | ||
document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | ||
errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | ||
focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | ||
focusPane : Sprite
The focus pane associated with this object.
| UIComponent | ||
globalX : Number | UIComponent | ||
globalY : Number | UIComponent | ||
height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
id : String
ID of the component.
| UIComponent | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | ||
inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | ||
instanceIndex : int
The index of a repeated component.
| UIComponent | ||
instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | ||
isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | ||
isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
lineScrollSize : Number
Amount to scroll when an arrow button is pressed, in pixels.
| ScrollBar | ||
maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
maxScrollPosition : Number
Number which represents the maximum scroll position.
| ScrollBar | ||
maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | ||
minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
minScrollPosition : Number
Number that represents the minimum scroll position.
| ScrollBar | ||
minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
miscHolder : Object
A utility holder for any various properties
| UIComponent | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | ||
move_enableProtection : Boolean = false | UIComponent | ||
nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | ||
nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | ||
numAutomationChildren : int
The number of automation children this container has.
| UIComponent | ||
owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | ||
pageScrollSize : Number
Amount to move the scroll thumb when the scroll bar
track is pressed, in pixels.
| ScrollBar | ||
pageSize : Number
The number of lines equivalent to one page.
| ScrollBar | ||
parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | ||
parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | ||
parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | ||
percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | ||
percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | ||
processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | ||
repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | ||
scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | ||
scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | ||
screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | ||
scrollPosition : Number
Number that represents the current scroll position.
| ScrollBar | ||
setActualSize_enableProtection : Boolean = false | UIComponent | ||
setVisible_enableProtection : Boolean = true | UIComponent | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
states : Array
The view states that are defined for this component.
| UIComponent | ||
styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
styleName : Object
The class style used by this component.
| UIComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
toolTip : String
Text to display in the ToolTip.
| UIComponent | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | ||
uid : String
A unique identifier for the object.
| UIComponent | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | ||
validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | ||
visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | ||
width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | ||
y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent |
Property | Defined by | ||
---|---|---|---|
downArrowStyleFilters : Object [read-only]
Set of styles to pass from the ScrollBar to the down arrow.
| ScrollBar | ||
thumbStyleFilters : Object [read-only]
Set of styles to pass from the ScrollBar to the thumb.
| ScrollBar | ||
unscaledHeight : Number
A convenience method for determining the unscaled height
of the component.
| UIComponent | ||
unscaledWidth : Number
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to
updateDisplayList() . | UIComponent | ||
upArrowStyleFilters : Object [read-only]
Set of styles to pass from the ScrollBar to the up arrow.
| ScrollBar |
Method | Defined by | ||
---|---|---|---|
Constructor.
| ScrollBar | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | ||
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
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 | ||
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | ||
drawFocus(isFocused:Boolean):void
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 | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | ||
getRepeaterItem(whichRepeater:int = -1):Object
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 | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component.
| UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | ||
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | ||
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | ||
measureHTMLText(htmlText:String):TextLineMetrics
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 | ||
measureText(text:String):TextLineMetrics
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 | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | ||
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
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 | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | ||
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater() , after a call to
suspendBackgroundProcessing() . | UIComponent | ||
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | ||
setFocus():void
Sets the focus to this component.
| UIComponent | ||
setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void
Sets the range and viewport size of the ScrollBar control.
| ScrollBar | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | ||
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater() ,
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
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 | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Style | Description | Defined by | ||
---|---|---|---|---|
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
borderColor
| Type: uint Format: Color CSS Inheritance: no Color of the border. The following controls support this style: Button, CheckBox, ComboBox, MenuBar, NumericStepper, ProgressBar, RadioButton, ScrollBar, Slider, and any components that support the borderStyle style.
The default value depends on the component class;
if not overriden for the class, the default value is 0xB7BABC .
| ScrollBar | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color brightness of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | |||
cornerRadius
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. The following components support this style: Alert, Button, ComboBox, LinkButton, MenuBar, NumericStepper, Panel, ScrollBar, Tab, TitleWindow, and any component that supports a borderStyle property set to "solid" .
The default value depends on the component class;
if not overriden for the class, the default value is 0 .
| ScrollBar | ||
downArrowDisabledSkin
| 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. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
downArrowDownSkin
| 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 . If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
downArrowOverSkin
| 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. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
downArrowSkin
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the down arrow button of the scroll bar. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
downArrowUpSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the down arrow button of the scroll bar. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
fillAlphas
| Type: Array CSS Inheritance: no Alphas used for the background fill of controls. Use [1, 1] to make the control background opaque. The default value is [ 0.6, 0.4 ] . | ScrollBar | ||
fillColors
| Type: Array Format: Color CSS Inheritance: no Colors used to tint the background of the control. Pass the same color for both values for a flat-looking control. The default value is [ 0xFFFFFF, 0xCCCCCC ] . | ScrollBar | ||
highlightAlphas
| Type: Array CSS Inheritance: no Alpha transparencies used for the highlight fill of controls. The first value specifies the transparency of the top of the highlight and the second value specifies the transparency of the bottom of the highlight. The highlight covers the top half of the skin. The default value is [ 0.3, 0.0 ] . | ScrollBar | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The color hue of the component. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The opacity of the component. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color saturation of the component. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | |||
thumbDownSkin
| 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. The default value is mx.skins.halo.ScrollThumbSkin . | ScrollBar | ||
thumbIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon for the thumb of the scroll bar. The default value is "undefined" . | ScrollBar | ||
thumbOffset
| Type: Number CSS Inheritance: no The number of pixels to offset the scroll thumb from the center of the scroll bar. The default value is 0 . | ScrollBar | ||
thumbOverSkin
| 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. The default value is mx.skins.halo.ScrollThumbSkin . | ScrollBar | ||
thumbSkin
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the down arrow button of the scroll bar. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
thumbUpSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the thumb of the scroll bar. The default value is mx.skins.halo.ScrollThumbSkin . | ScrollBar | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | |||
trackColors
| Type: Array Format: Color CSS Inheritance: no The colors of the track, as an array of two colors. You can use the same color twice for a solid track color. The default value is [0x94999b, 0xe7e7e7] . | ScrollBar | ||
trackDisabledSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the track of the scroll bar when the scroll bar is disabled. The default value is undefined . | ScrollBar | ||
trackDownSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the track of the scroll bar when you click on the track. The default value is undefined . | ScrollBar | ||
trackOverSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the track of the scroll bar when the mouse pointer is over the scroll bar. The default value is undefined . | ScrollBar | ||
trackSkin
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the track of the scroll bar. The default value is mx.skins.halo.ScrollTrackSkin . | ScrollBar | ||
trackUpSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the track of the scroll bar. The default value is undefined . | ScrollBar | ||
upArrowDisabledSkin
| 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. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
upArrowDownSkin
| 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. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
upArrowOverSkin
| 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. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
upArrowSkin
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the up arrow button of the scroll bar. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
upArrowUpSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the up arrow button of the scroll bar. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal ScrollBars) or width (for vertical ScrollBars) as the track. The default value is mx.skins.halo.ScrollArrowSkin . | ScrollBar | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent |
Constant | Defined by | ||
---|---|---|---|
DEFAULT_MAX_HEIGHT : Number = 10000 [static]
The default value for the
maxHeight property. | UIComponent | ||
DEFAULT_MAX_WIDTH : Number = 10000 [static]
The default value for the
maxWidth property. | UIComponent | ||
DEFAULT_MEASURED_HEIGHT : Number = 22 [static]
The default value for the
measuredHeight property. | UIComponent | ||
DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static]
The default value for the
measuredMinHeight property. | UIComponent | ||
DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static]
The default value for the
measuredMinWidth property. | UIComponent | ||
DEFAULT_MEASURED_WIDTH : Number = 160 [static]
The default value for the
measuredWidth property. | UIComponent | ||
THICKNESS : Number = 16 [static]
The width of a vertical scrollbar, or the height of a horizontal
scrollbar, in pixels.
| ScrollBar |
direction | property |
direction:String
[read-write]
Specifies whether the ScrollBar is for horizontal or vertical scrolling.
Valid values in MXML are "vertical"
and "horizontal"
.
In ActionScript, you use the following constants
to set this property:
ScrollBarDirection.VERTICAL
and
ScrollBarDirection.HORIZONTAL
.
The default value is ScrollBarDirection.VERTICAL
.
This property can be used as the source for data binding.
Implementation public function get direction():String
public function set direction(value:String):void
See also
downArrowStyleFilters | property |
downArrowStyleFilters:Object
[read-only]Set of styles to pass from the ScrollBar to the down arrow.
Implementation protected function get downArrowStyleFilters():Object
See also
lineScrollSize | property |
lineScrollSize:Number
[read-write]Amount to scroll when an arrow button is pressed, in pixels.
The default value is 1
.
public function get lineScrollSize():Number
public function set lineScrollSize(value:Number):void
maxScrollPosition | property |
maxScrollPosition:Number
[read-write]Number which represents the maximum scroll position.
The default value is 0
.
public function get maxScrollPosition():Number
public function set maxScrollPosition(value:Number):void
minScrollPosition | property |
minScrollPosition:Number
[read-write]Number that represents the minimum scroll position.
The default value is 0
.
public function get minScrollPosition():Number
public function set minScrollPosition(value:Number):void
pageScrollSize | property |
pageScrollSize:Number
[read-write]Amount to move the scroll thumb when the scroll bar track is pressed, in pixels.
The default value is 0
.
public function get pageScrollSize():Number
public function set pageScrollSize(value:Number):void
pageSize | property |
pageSize:Number
[read-write]The number of lines equivalent to one page.
The default value is 0
.
public function get pageSize():Number
public function set pageSize(value:Number):void
scrollPosition | property |
scrollPosition:Number
[read-write]
Number that represents the current scroll position.
The value is between minScrollPosition
and
maxScrollPosition
inclusively.
The default value is 0
.
public function get scrollPosition():Number
public function set scrollPosition(value:Number):void
thumbStyleFilters | property |
thumbStyleFilters:Object
[read-only]Set of styles to pass from the ScrollBar to the thumb.
Implementation protected function get thumbStyleFilters():Object
See also
upArrowStyleFilters | property |
upArrowStyleFilters:Object
[read-only]Set of styles to pass from the ScrollBar to the up arrow.
Implementation protected function get upArrowStyleFilters():Object
See also
ScrollBar | () | constructor |
public function ScrollBar()
Constructor.
setScrollProperties | () | method |
public function setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void
Sets the range and viewport size of the ScrollBar control. The ScrollBar control updates the state of the arrow buttons and size of the scroll thumb accordingly.
ParameterspageSize:Number — Number which represents the size of one page.
|
|
minScrollPosition:Number — Number which represents the bottom of the
scrolling range.
|
|
maxScrollPosition:Number — Number which represents the top of the
scrolling range.
|
|
pageScrollSize:Number (default = 0 ) — Number which represents the increment to move when
the scroll track is pressed.
|
THICKNESS | constant |
public static const THICKNESS:Number = 16
The width of a vertical scrollbar, or the height of a horizontal scrollbar, in pixels.