Packagecom.dwuser.ss4.ui
Classpublic class PagingControlHolder
InheritancePagingControlHolder Inheritance Canvas Inheritance Container Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
SubclassesNumberBar, Thumbnails

The PagingControlHolder is the base class for the Thumbnails and NumberBar elements; it creates a grid of tiles which are arranged in unique, navigable pages. It is never used directly; instead, it is used indirectly through each of its subclasses:

When using page-based scrolling, paging controls are automatically shown on the element. These controls can be customized through the PagingControls pseudo-property as mentioned/shown below. See the PagingControls pseudo-property for more information.

There are three important aspects to each subclass of this class. Each of these aspects has a corresponding XML descriptor pseudo-property which is used to create the aspect, and can be explicitly specified to customize the element's appearance:

For each of the XML descriptor pseudo-properties shown above, reference the corresponding pseudo-property's documentation for more specific information.

The number of tiles in the grid is automatically deteremined based on the specified tileWidth and tileHeight parameters, along with the spacing style parameters. At least one tile will always be visible in a given direction; if more space is available, more tiles will be displayed. The layout direction is determined by the layoutDirection property. Spacing style parameters include verticalGap, horizontalGap, and outerSpacing.

There are several properties and style parameters which control transition types, and how paging is handled. The transition between pages (if using paged scrolling) is handled by the transitionType style. Paging can be accomplished through the built-in paging controls (see the PagingControls pseudo-property), hover-based auto-scrolling, or use of the scrollbars. These options are controlled via the usePagedScrolling and hoverScrollEnabled properties. If using built-in paging/scrolling controls, there are six default types which can be used -- "ends" (displays control arrows on each end of the element) or "bottom" ( displays control arrows at the bottom of the element), two scrollbar configurations, and two glide-scroll button configurations. This is controlled via the pagingStyle parameter; see the property's description for more information about supported values.

About tooltips: When a tile is hovered over, a tooltip with information about the corresponding image is by default displayed. There are three tooltipStyle values which can be used - "image" (the default) displays a larger thumbnail image; "text" displays a popup tooltip with the image's title and caption; "none" disables the tooltip entirely. If using "text", you can enable or disable showing the caption in addition to the title through the tooltipShowCaption style parameter. The maximum size of the tooltip is configured by the ToolTipDescriptor pseudo-property; see that property for more information. The tooltipFadeTime style property configures how long the in-out tooltip fade transition takes.

The user can change the tile size on a Thumbnails or NumberBar element by using the PagingControlSizer element. Usually it is used within the PagingControls. See that class for more information.

Layout XML Syntax Example:

Important! The PagingControlHolder class is never used as a standalone element or a style node. Instead, only its subclasses are used. See the subclasses and related classes referenced below for example usage. The example node shown below is purely to provide a listing of all available parameters.

The PagingControlHolder class inherits all of the tag attributes of its superclass.

   <Thumbnails|NumberBar (Implemented through subclass, not directly)
      Properties
      tileWidth="30"
      tileHeight="30"
      layoutDirection="horizontal|vertical"
      usePagedScrolling="true"
      hoverScrollEnabled="false"
      hoverScrollStyle="elastic"
  
      Styles
      verticalGap="10"
      horizontalGap="10"
      verticalLayoutAlign="middle"
      horizontalLayoutAlign="center"
      outerSpacing="horizontalGap value"
      pagingStyle="ends|verticalEnds|bottom|scrollbarBottom|scrollbarRight|glideEnds|verticalGlideEnds|glideBottom|glideRight"
      useScrollWheel="true"
      scrollTime="600"
      glideSpeed="10"
      transitionType="scroll|fade"
      tooltipStyle="image|text|none"
      tooltipShowCaption="true"
      tooltipTextStyle="htmlText|text"
      tooltipHideDelay="1"
      tooltipFadeTime="1000"
      tooltipTruncateTitleAt="-1"
      tooltipTruncateCaptionAt="-1"
   >
  
      Optional Child Descriptor Nodes: (see Pseudo-properties corresponding to node names below)
      <ItemDescriptor>
         ... Custom Descriptor Here ...
      </ItemDescriptor>
  
      <ToolTipDescriptor>
         ... Custom Descriptor Here ...
      </ToolTipDescriptor>
  
      <PagingControls>
         ... Custom Descriptor Here ...
      </PagingControls>
  
   </Thumbnails|NumberBar>
   

See also

ItemDescriptor
ToolTipDescriptor
PagingControls
NumberBar
Thumbnails
com.dwuser.ss4.ui.controls.PagingControlScrollbar
com.dwuser.ss4.ui.controls.PagingControlSizer


Public Properties
 PropertyDefined by
 InheritedactiveEffects : Array
The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedautoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
Container
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationTabularData : Object
An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : 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
 InheritedbaselinePosition : Number
The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedborderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
Container
 InheritedcacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedchildDescriptors : Array
Array of UIComponentDescriptor objects produced by the MXML compiler.
Container
 InheritedclassName : String
The name of this instance's class, such as "Button".
UIComponent
 InheritedclipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.
Container
 InheritedconstraintColumns : Array
An Array of ConstraintColumn instances that partition this container.
Canvas
 InheritedconstraintRows : Array
An Array of ConstraintRow instances that partition this container.
Canvas
 InheritedcontentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
Container
 InheritedcontentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
Container
 InheritedcreatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
Container
 InheritedcreationIndex : int
Specifies the order to instantiate and draw the children of the container.
Container
 InheritedcreationPolicy : String
The child creation policy for this Container.
Container
 InheritedcurrentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The data property lets you pass a value to the component when you use it in an item renderer or item editor.
Container
 InheriteddefaultButton : IFlexDisplayObject
The Button control designated as the default button for the container.
Container
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : 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
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedglobalX : Number
UIComponent
 InheritedglobalY : Number
UIComponent
 Inheritedheight : Number
Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhorizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalPageScrollSize : Number
Number of pixels to move when the track in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
Container
 InheritedhorizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedhorizontalScrollPosition : Number
The current position of the horizontal scroll bar.
Container
  hoverScrollEnabled : Boolean = false
Specifies if hover-based scrolling is enabled (only works if usePagedScrolling is set to false).
PagingControlHolder
  hoverScrollStyle : String = "elastic"
When hover scrolling is enabled, specifies the type of hover navigation effect.
PagingControlHolder
 Inheritedicon : Class
The Class of the icon displayed by some navigator containers to represent this Container.
Container
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 InheritedisDocument : 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
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
  ItemDescriptor : XML
[Pseudo-property only!] Specifies the XML descriptor used for the creation of each tile in the Thumbnails or NumberBar element.
PagingControlHolder
 Inheritedlabel : String
The text displayed by some navigator containers to represent this Container.
Container
  layoutDirection : String = "horizontal"
Specifies the layout direction of the tiles in the elements.
PagingControlHolder
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
The largest possible value for the horizontalScrollPosition property.
Container
 InheritedmaxVerticalScrollPosition : Number
The largest possible value for the verticalScrollPosition property.
Container
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedminWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmiscHolder : Object
A utility holder for any various properties
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 Inheritedmove_enableProtection : Boolean = false
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
The number of automation children this container has.
UIComponent
 InheritednumChildren : int
Number of child components in this container.
Container
 Inheritedowner : DisplayObjectContainer
The owner of this UIComponent.
UIComponent
  PagingControls : XML
[Pseudo-property only!] Specifies the XML descriptor used for the creation of the paging controls (if there is more than one page of tiles to be shown, and usePagedScrolling is enabled).
PagingControlHolder
 Inheritedparent : DisplayObjectContainer
The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 InheritedrawChildren : IChildList
A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property.
Container
 Inheritedrepeater : IRepeater
A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 InheritedscaleX : Number
Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
Number that specifies the vertical scaling factor.
UIComponent
 Inheritedscreen : Rectangle
Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedsetActualSize_enableProtection : Boolean = false
UIComponent
 InheritedsetVisible_enableProtection : Boolean = true
UIComponent
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
  slideshow : FlashSlideshow
A read-only reference to the main slideshow.
PagingControlHolder
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the styleName property) override inline styles.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
  tileHeight : Number = 30
Specifies the height, in pixels, of each tile in the element.
PagingControlHolder
  tileWidth : Number = 30
Specifies the width, in pixels, of each tile in the element.
PagingControlHolder
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
  ToolTipDescriptor : XML
[Pseudo-property only!] Specifies the XML descriptor used for the creation of the popup tooltip displayed when a tile is hovered over.
PagingControlHolder
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
  usePagedScrolling : Boolean = true
Specifies if page-based or contiguous scrolling should be used.
PagingControlHolder
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.
Container
 InheritedverticalPageScrollSize : Number
Number of pixels to scroll when the track in the vertical scroll bar is pressed.
Container
 InheritedverticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
Container
 InheritedverticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedverticalScrollPosition : Number
The current position of the vertical scroll bar.
Container
 InheritedviewMetrics : EdgeMetrics
Returns an object that has four properties: left, top, right, and bottom.
Container
 InheritedviewMetricsAndPadding : EdgeMetrics
Returns an object that has four properties: left, top, right, and bottom.
Container
 Inheritedvisible : Boolean
Controls the visibility of this UIComponent.
UIComponent
 Inheritedvisible_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
 Inheritedwidth : Number
Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 InheritedxmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
UIComponent
 Inheritedy : Number
Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
Protected Properties
 PropertyDefined by
 InheritedactualCreationPolicy : String
The creation policy of this container.
Container
 InheritedunscaledHeight : Number
A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : 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
Public Methods
 MethodDefined by
  
PagingControlHolder
 Inherited
addChild(child:DisplayObject):DisplayObject
Adds a child DisplayObject to this Container.
Container
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child DisplayObject to this Container.
Container
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
Container
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
Container
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.
Container
 Inherited
createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.
Container
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the data bindings on this Container.
Container
 Inherited
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
Container
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
getChildAt(index:int):DisplayObject
Gets the nth child component object.
Container
 Inherited
getChildByName(name:String):DisplayObject
Returns the child whose name property is the specified String.
Container
 Inherited
getChildIndex(child:DisplayObject):int
Gets the zero-based index of a specific child.
Container
 Inherited
getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children of the container.
Container
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
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
 Inherited
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
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
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
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
Container
 Inherited
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
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
Container
 Inherited
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
 Inherited
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
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
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
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes all children from the child list of this container.
Container
 Inherited
removeChild(child:DisplayObject):DisplayObject
Removes a child DisplayObject from the child list of this Container.
Container
 Inherited
removeChildAt(index:int):DisplayObject
Removes a child DisplayObject from the child list of this Container at the specified index.
Container
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
UIComponent
 Inherited
setChildIndex(child:DisplayObject, newIndex:int):void
Sets the index of a particular child.
Container
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
UIComponent
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
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
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
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
Protected Methods
 MethodDefined by
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
Container
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
createBorder():void
Creates the container's border skin if it is needed and does not already exist.
Container
  
PagingControlHolder
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes of this container's borders.
Container
  
measure():void
PagingControlHolder
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.
Container
  
setupStyles():void
PagingControlHolder
  
updateDisplayList(w:Number, h:Number):void
PagingControlHolder
Events
 EventSummaryDefined by
 Inherited
add
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIComponent
 Inherited Dispatched after a child has been added to a container.Container
 Inherited Dispatched after the index (among the container children) of a container child changes.Container
 Inherited Dispatched before a child of a container is removed.Container
 Inherited Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 Inherited Dispatched after the view state has changed.UIComponent
 Inherited Dispatched after the currentState property changes, but before the view state changes.UIComponent
 Inherited Dispatched when the data property changes.Container
 Inherited 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
 Inherited Dispatched by the drop target when the user releases the mouse over it.UIComponent
 Inherited Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 Inherited Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 Inherited Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 Inherited Dispatched by the drag initiator when starting a drag operation.UIComponent
 Inherited Dispatched after an effect ends.UIComponent
 Inherited Dispatched just before an effect starts.UIComponent
 Inherited Dispatched after the component has returned to the root view state.UIComponent
 Inherited Dispatched before the component exits from the root view state.UIComponent
 Inherited Dispatched when an object's state changes from visible to invisible.UIComponent
 Inherited Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 Inherited Dispatched when the object has moved.UIComponent
 Inherited Dispatched at the beginning of the component initialization sequence.UIComponent
 Inherited Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.UIComponent
 Inherited Dispatched when the component is resized.UIComponent
 Inherited Dispatched when the user manually scrolls the container.Container
 Inherited Dispatched when an object's state changes from invisible to visible.UIComponent
 Inherited Dispatched by the component when it is time to create a ToolTip.UIComponent
 Inherited Dispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be hidden.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be shown.UIComponent
 Inherited Dispatched by the component when its ToolTip has been shown.UIComponent
 Inherited Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 Inherited Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 Inherited Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 StyleDescriptionDefined by
 Inherited Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
Container
 Inherited Type: String   CSS Inheritance: no
If a background image is specified, this style specifies whether it is fixed with regard to the viewport ("fixed") or scrolls along with the content ("scroll").
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: no
Background color of a component.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled.
Container
 Inherited Type: Object   Format: File   CSS Inheritance: no
Background image of a component.
Container
 Inherited Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Determines the color of a ProgressBar.
Container
 Inherited 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
 Inherited Type: uint   Format: Color   CSS Inheritance: no
Color of the border.
Container
 Inherited Type: String   CSS Inheritance: no
Bounding box sides.
Container
 Inherited Type: Class   CSS Inheritance: no
The border skin class of the component.
Container
 Inherited Type: String   CSS Inheritance: no
Bounding box style.
Container
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness.
Container
 Inherited 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
 Inherited Type: Number   CSS Inheritance: no
The color brightness of the component.
UIComponent
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label.
Container
 Inherited Type: Number   CSS Inheritance: no
The color contrast of the component.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled.
Container
 Inherited Type: Number   CSS Inheritance: no
The alpha value for the overlay that is placed on top of the container when it is disabled.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow.
Container
 Inherited Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 Inherited Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
Container
 Inherited Type: String   CSS Inheritance: yes
Name of the font to use.
Container
 Inherited Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
Container
 Inherited Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
Container
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels.
Container
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is italic font.
Container
 Inherited Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
Container
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is boldface.
Container
  
glideSpeed
Type: Number   Format: Length   CSS Inheritance: no
Specifies the speed of glide-based scrolling (when using the PagingControlGlideBackButton or PagingControlGlideForwardButton control elements).

This setting is only relevant when you have usePagedScrolling disabled and your paging controls include the PagingControlGlideBackButton or PagingControlGlideForwardButton elements. In this case, this controls the maximum number of pixels moved on each update. Thus, a higher value represents greater speed and a lower value a slower speed.

The default value is 10.
PagingControlHolder
 Inherited 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
  
horizontalGap
Type: Number   Format: Length   CSS Inheritance: no
Specifies the horizontal gap (spacing) between each of the tiles. The default value is 10.
PagingControlHolder
  
horizontalLayoutAlign
Type: String   Format: Enumerated   CSS Inheritance: no
When page-based scrolling is disabled and the tiles occupy less than the available space, this setting determines the horizontal alignment of those tiles. The default value is "center".
PagingControlHolder
 Inherited Type: String   CSS Inheritance: no
The name of the horizontal scrollbar style.
Container
 Inherited
hue
Type: Number   CSS Inheritance: no
The color hue of the component.
UIComponent
 Inherited Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
Container
 Inherited 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
 Inherited Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character.
Container
 Inherited Type: Number   CSS Inheritance: no
The opacity of the component.
UIComponent
  
outerSpacing
Type: Number   Format: Length   CSS Inheritance: no
Specifies the minimum gap (spacing) between the edges of the container and the first tile.

The default value is the value of the horizontalGap style (10).

PagingControlHolder
  
pagingStyle
Type: String   Format: Enumerated   CSS Inheritance: no
If no custom PagingControls description has been specified, controls the location of the default paging controls.

Possible values are:

  • ends - (Default if horizontal layout direction) Displays paging control arrows at each end of the element.
  • verticalEnds - (Default if vertical layout direction) Displays vertically-oriented paging control arrows at the top and bottom of the element.
  • bottom - Displays paging control arrows and status text at the bottom of the element.
  • scrollbarBottom - Displays a scrollbar which snaps to each page at the bottom of the element. Designed to be used with usePagedScrolling enabled.
  • scrollbarRight - Displays a scrollbar which snaps to each page at the right side of the element. Designed to be used with usePagedScrolling enabled.
  • glideEnds - Displays back and forward glide-scroll buttons on the left and right ends of the element. Designed to be used with usePagedScrolling disabled.
  • verticalGlideEnds - Displays vertically-oriented back and forward glide-scroll buttons on the top and bottom of the element. Designed to be used with usePagedScrolling disabled.
  • glideBottom - Displays back and forward glide-scroll buttons at the bottom of the element. Designed to be used with usePagedScrolling disabled.
  • glideRight - Displays vertically-oriented back and forward glide-scroll buttons on the right side of the element. Designed to be used with usePagedScrolling disabled.

The default value is "ends".
PagingControlHolder
 Inherited 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
 Inherited Type: Number   CSS Inheritance: no
The color saturation of the component.
UIComponent
  
scrollTime
Type: Number   Format: Time   CSS Inheritance: no
Specifies the speed/duration, in milliseconds, of page-based scrolling or mouse-based scrolling.

If using page-based scrolling (as enabled by the usePagedScrolling property), specifies the duration of the transition between each page.

If using hover-based scrolling (as enabled by the hoverScrollEnabled property), specifies the speed of the hover-based scrolling. A higher value represents a longer duration, which equates to slower scrolling. A lower value represents a shorter duration, which equates to faster scrolling.

The default value is 600.
PagingControlHolder
 Inherited Type: String   CSS Inheritance: no
Direction of the drop shadow.
Container
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow.
Container
 Inherited Type: String   CSS Inheritance: yes
Alignment of text within a container.
Container
 Inherited Type: String   CSS Inheritance: yes
Determines whether the text is underlined.
Container
 Inherited Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Theme color of a component.
UIComponent
  
tooltipFadeTime
Type: Number   Format: Time   CSS Inheritance: no
Specifies how long the tooltip fade-in effect lasts, in milliseconds. The default value is 1000.
PagingControlHolder
  
tooltipHideDelay
Type: Number   Format: Time   CSS Inheritance: no
Specifies how long (in milliseconds) before the tooltip hides itself after a tile is no longer hovered-over.

The default value, 1, makes the tooltip hide almost instantaneously.

The default value is 1.
PagingControlHolder
  
tooltipShowCaption
Type: Boolean   CSS Inheritance: no
When using a tooltipStyle of "text", specifies if the caption should be shown in the tooltip. By default, only the slide's caption and title are both shown in the text tooltip. However, if this setting is changed to false, only the title will be shown. The default value is true.
PagingControlHolder
  
tooltipStyle
Type: String   Format: Enumerated   CSS Inheritance: no
Specifies the type of tooltip shown when a tile is hovered over.

Possible values are:

  • image - Displays a larger version of the thumbnail image.
  • text - Displays a popup tooltip with the image's title and caption values.
  • none - Disables the tooltip entirely.

The default value is "image".
PagingControlHolder
  
tooltipTextStyle
Type: String   Format: Enumerated   CSS Inheritance: no
When using a tooltipStyle of "text", specifies if the tooltip text should be treated as plain text or HTML text.

Possible values are:

  • htmlText - (Default) Treats the text as HTML; the tradeoff is that truncation will not be 'pretty'.
  • text - Treats the text as plain text.

The default value is false.
PagingControlHolder
  
tooltipTruncateCaptionAt
Type: Number   CSS Inheritance: no
When using a tooltipStyle of "text" with tooltipShowCaption enabled, specifies at what length the caption text in the tooltip should be truncated with an ellipsis (...).

The default value of -1 means that the caption should never be truncated.

The default value is -1.
PagingControlHolder
  
tooltipTruncateTitleAt
Type: Number   CSS Inheritance: no
When using a tooltipStyle of "text", specifies at what length the title text in the tooltip should be truncated with an ellipsis (...).

The default value of -1 means that the title should never be truncated.

The default value is -1.
PagingControlHolder
 Inherited
top
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
  
transitionType
Type: String   Format: Enumerated   CSS Inheritance: no
If using page-based scrolling (as enabled by the usePagedScrolling property), specifies the transition effect used between pages. A value of "scroll" (the default) causes the current page to scroll out of view and the next page to scroll into view. A value of "fade" causes the current page to fade out and the new page to fade back in.

The speed of both transitions is controlled by the scrollTime style parameter.

The default value is "scroll".
PagingControlHolder
  
useScrollWheel
Type: Boolean   CSS Inheritance: no
Specifies if using the mouse's scroll wheel on the component should result in the thumbnails scrolling back or forward. The default value is true.
PagingControlHolder
 Inherited 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
  
verticalGap
Type: Number   Format: Length   CSS Inheritance: no
Specifies the vertical gap (spacing) between each of the tiles. The default value is 10.
PagingControlHolder
  
verticalLayoutAlign
Type: String   Format: Enumerated   CSS Inheritance: no
When page-based scrolling is disabled and the tiles occupy less than the available space, this setting determines the vertical alignment of those tiles. The default value is "middle".
PagingControlHolder
 Inherited Type: String   CSS Inheritance: no
The name of the vertical scrollbar style.
Container
Effects
 EffectDescriptionDefined by
 Inherited Triggering event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering event: move
Played when the component is moved.
UIComponent
 Inherited Triggering event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined by
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property detail
hoverScrollEnabledproperty
public var hoverScrollEnabled:Boolean = false

Specifies if hover-based scrolling is enabled (only works if usePagedScrolling is set to false). If enabled and usePagedScrolling is disabled, the user can scroll simply by mousing over the element and moving the mouse towards one end or the other.

The appearnce style of this effect is controlled by the hoverScrollStyle property.

The speed of the scrolling if affected by the scrollTime style parameter; the greater the scrollTime value, the slower the scrolling.

The default value is false.

See also

hoverScrollStyleproperty 
public var hoverScrollStyle:String = "elastic"

When hover scrolling is enabled, specifies the type of hover navigation effect.

This property only applies when hoverScrollEnabled is set to true. In these cases, it specifies the type of scrolling effect. By default, when using the "elastic" mode, the position of the thumbnails depends on the position of the mouse over the element. The entire set of thumbnails may be viewed by moving the mouse to a given position within the element. On the other hand, the "normal" mode means that the thumbs scroll whenever the user hovers over them, with the amount of scrolling determined by the distance from the center of the element.

The default value is "elastic".

See also

ItemDescriptorproperty 
public var ItemDescriptor:XML

[Pseudo-property only!] Specifies the XML descriptor used for the creation of each tile in the Thumbnails or NumberBar element. A custom value can be used to customize the appearance of the tiles which are shown on the Thumbnails or NumberBar.

This is a pseudo-property; it is passed as a child node of the XML node, not as an element attribute. See the class description above for more information / example code.

This descriptor's configuration and default value depends on the subclass in question:

If a custom ItemDescriptor is not explicitly specified on a Thumbnails element, the following default descriptor is used:

    <ItemDescriptor>
     <Thumb />
    </ItemDescriptor>
    

When creating a custom descriptor, it must be of the same format, with only a single <Thumb ... /> element described. For more information about available settings on the Thumb element, see the Thumb class. To control the appearance of the NumberBar tile in it's hover, selected, and visited states, reference the following pseudo-style classes: ThumbHover, ThumbSelected, and ThumbVisited . The style selectors referenced by these classes control the Thumb's appearance in these other states.

If a custom ItemDescriptor is not explicitly specified on a NumberBar, the following default descriptor is used:

    <ItemDescriptor>
     <NumberBarTile />
    </ItemDescriptor>
    

When creating a custom descriptor, it must of the same format, with only a single <NumberBarTile ... /> element described. For more information about available settings on the NumberBarTile element, see the NumberBarTile class. To control the appearance of the NumberBar tile in it's hover, selected, and visited states, reference the following pseudo-style classes: NumberBarTileHover, NumberBarTileSelected, and NumberBarTileVisited . The style selectors referenced by these classes control the NumberBarTile's appearance in these other states.

See also

layoutDirectionproperty 
public var layoutDirection:String = "horizontal"

Specifies the layout direction of the tiles in the elements.

If set to "horizontal", numerous columns will be created with a fixed number of tiles in each. If scrollbars are necessary, they will facilitate horizontal scrolling. The number of tiles in each column is automatically determined based on the available space, the tileHeight and the spacing style settings.

If set to "vertical", numerous rows will be created with a fixed number of tiles in each. If scrollbars are necessary, they will facilitate vertical scrolling. The number of tiles in each row is automatically determined based on the available space, the tileWidth and the spacing style settings.

The default value is "horizontal".

See also

PagingControlsproperty 
public var PagingControls:XML

[Pseudo-property only!] Specifies the XML descriptor used for the creation of the paging controls (if there is more than one page of tiles to be shown, and usePagedScrolling is enabled). A custom value can be used to customize the appearance of the paging controls.

This is a pseudo-property; it is passed as a child node of the XML node, not as an element attribute. See the class description above for more information / example code.

If this property is not explicitly specified, there are six possible default descriptors based on the value of the pagingStyle style parameter: (1) The "ends" display (default) which displays the paging control buttons at each end of the element; (2) The "bottom" view, which displays paging control buttons and a status label at the bottom of the element; (3) The "scrollbarBottom" view, which displays a paging control scrollbar at the bottom of the element; (4) The "scrollbarRight" view, which displays a paging control scrollbar at the right edge of the element; (5) The "glideEnds" view, which displays glide-scroll buttons at each end of the element; (6) The "glideBottom" view, which displays glide-scroll buttons at the bottom of the element. These last two are designed to be used in conjunction with usePagedScrolling="false" (page-based scrolling disabled) . The descriptor for the "ends" paging type is:

    <PagingControls>
     <HBox left="0" top="0" bottom="0" verticalAlign="middle" paddingRight="5" paddingLeft="5">
       <Button name="previousButton" __label="&lt;" skin="Skin('com.dwuser.ss4.skins.FirstButtonSkin')" />
      </HBox>
     <HBox right="0" top="0" bottom="0" verticalAlign="middle" paddingLeft="5" paddingRight="5">
      <Button name="nextButton" __label="&gt;" skin="Skin('com.dwuser.ss4.skins.LastButtonSkin')" />
     </HBox>
    </PagingControls>
    

It creates two boxes, one on the left holding a previous button, and one of the right holding a next button. Each box has a little padding on each side. The descriptor for the "bottom" paging type is:

    <PagingControls>
     <HBox bottom="0" left="0" right="0" horizontalAlign="center" verticalAlign="middle">
        <Button name="previousButton" __label="&lt;" skin="ClassReference('com.dwuser.ss4.skins.PreviousButtonSkin')" />
        <Label name="pagingLabel" text="Page {N} of {T}" color="#FFFFFF" />
      <Button name="nextButton" __label="&gt;" skin="ClassReference('com.dwuser.ss4.skins.NextButtonSkin')" />         
     </HBox>
    </PagingControls>
    
The descriptor for the "verticalEnds" paging type (which creates vertically-oriented controls at the top and bottom; designed for use with layoutDirection="vertical"; note the rotation on the buttons) is:
    <PagingControls>
     <VBox top="0" left="0" right="0" horizontalAlign="center" paddingTop="5" paddingBottom="5" paddingLeft="14" paddingRight="-14">
        <Button name="previousButton" __label="<" skin="Skin('com.dwuser.ss4.skins.FirstButtonSkin')" rotation="90" />
       </VBox>
      <VBox bottom="0" left="0" right="0" horizontalAlign="center" paddingTop="5" paddingBottom="5" paddingLeft="14" paddingRight="-14">
       <Button name="nextButton" __label=">" skin="Skin('com.dwuser.ss4.skins.LastButtonSkin')" rotation="90" />
      </VBox>
    </PagingControls>
    
The descriptor for the "scrollbarBottom" paging type is:
    <PagingControls>
     <HBox left="0" right="0" bottom="0" paddingTop="5">
       <PagingControlScrollbar width="100%" />
      </HBox> 
    </PagingControls>
    
The descriptor for the "scrollbarRight" paging type is:
    <PagingControls>
     <HBox right="0" top="0" bottom="0" paddingLeft="5">
       <PagingControlScrollbar height="100%" /> 
      </HBox>
    </PagingControls>
    
The descriptor for the "glideEnds" paging type is:
    <PagingControls>
     <HBox left="0" top="0" bottom="0" verticalAlign="middle" paddingRight="5" paddingLeft="5">
       <PagingControlGlideBackButton __label="&lt;" />
      </HBox>
     <HBox right="0" top="0" bottom="0" verticalAlign="middle" paddingLeft="5" paddingRight="5">
      <PagingControlGlideForwardButton __label="&gt;" />
     </HBox>
    </PagingControls>
    
The descriptor for the "verticalGlideEnds" paging type is:
    <PagingControls>
     <VBox left="0" right="0" top="0" horizontalAlign="center" paddingTop="5" paddingBottom="5" paddingLeft="14" paddingRight="-14">
       <PagingControlGlideBackButton __label="<" rotation="90" />
      </VBox>
     <VBox left="0" right="0" bottom="0" horizontalAlign="center" paddingTop="5" paddingBottom="5" paddingLeft="14" paddingRight="-14">
      <PagingControlGlideForwardButton __label=">" rotation="90" />
     </VBox>
    </PagingControls>
    
The descriptor for the "glideBottom" paging type is:
    <PagingControls>
     <HBox left="0" right="0" bottom="0" verticalAlign="middle" paddingTop="5" paddingBottom="5" paddingLeft="5" paddingRight="5">
      <PagingControlGlideBackButton __label="&lt;" />
      <Spacer width="100%" />
      <PagingControlGlideForwardButton __label="&gt;" />
     </HBox>
    </PagingControls>
    
The descriptor for the "glideRight" paging type is:
    <PagingControls>
     <VBox top="0" bottom="0" right="0" horizontalAlign="center" paddingTop="5" paddingBottom="5" paddingLeft="19" paddingRight="-9">
      <PagingControlGlideBackButton __label="&lt;" rotation="90" />
      <Spacer height="100%" />
      <PagingControlGlideForwardButton __label="&gt;" rotation="90" />
     </VBox>
    </PagingControls>
    

Either way, the descriptor must have at least one child element of the following structure:

Please note! To work properly, the elements must be exactly as shown: a <Button ... /> element named previousButton, a <Label ... /> element named pagingLabel, and a <Button ... /> element named nextButton . If you don't use these special names, the correct values won't be automatically displayed nor the correct handlers triggered.

All of these paging control elements are usually held in a single box container or multiple box containers (such as the HBox element), which is/are positioned on one of the NumberBar or Thumbnails element's edges. It is important that you use relative positioning to anchor the controls to a certain side, so that the PagingControlHolder can accurately calculate the available space which remains after accounting for the controls. The default descriptor shown above uses relative positioning to anchor the wrapper container to the bottom edge of the element. You can anchor multiple paging control elements to different edges, as shown in the following example, which puts a previous button on the left and a next button on the right edge:

    <PagingControls>
        <HBox left="0" top="0" bottom="0" verticalAlign="middle" paddingRight="5" paddingLeft="5">
      <Button name="previousButton" skin="ClassReference('com.dwuser.ss4.skins.FirstButtonSkin')" />
     </HBox>
     <HBox right="0" top="0" bottom="0" verticalAlign="middle" paddingLeft="5" paddingRight="5>
      <Button name="nextButton" __label=">" skin="ClassReference('com.dwuser.ss4.skins.LastButtonSkin')" />
     </HBox>
    </PagingControls>
    

See also

slideshowproperty 
public var slideshow:FlashSlideshow

A read-only reference to the main slideshow.

tileHeightproperty 
public var tileHeight:Number = 30

Specifies the height, in pixels, of each tile in the element.

The default value is 30.

See also

tileWidthproperty 
public var tileWidth:Number = 30

Specifies the width, in pixels, of each tile in the element.

The default value is 30.

See also

ToolTipDescriptorproperty 
public var ToolTipDescriptor:XML

[Pseudo-property only!] Specifies the XML descriptor used for the creation of the popup tooltip displayed when a tile is hovered over. A custom value can be used to customize the appearance of the tooltip which appears when a user hovers over one of the tiles. This pseudo-property is only applicable if the tooltip hasn't been disabled (through the tooltipStyle style setting).

This is a pseudo-property; it is passed as a child node of the XML node, not as an element attribute. See the class description above for more information / example code.

If this property is not explicitly specified, the following default descriptor is used:

    <ToolTipDescriptor>
     <PopupToolTip maxWidth="180" maxHeight="180" />
    </ToolTipDescriptor>
    

Either way, the format must be the same as shown above. The descriptor must be a single <PopupToolTip ... /> element. Because the actual tooltip contents are determined by the tooltipStyle setting, this descriptor is essentially only used to control the size, background, and border styles on the tooltip. For sizing, the most important attributes are the maxWidth, maxHeight, minWidth, and minHeight properties. To learn more about the available settings for the PopupToolTip element, see the PopupToolTip class.

When the tooltipStyle value is "image", the only content in the tooltip is a larger version of the thumbnail. Its dimensions are determined by the dimension settings on the PopupToolTip.

When using the tooltipStyle value is "text", there are two Label elements displayed. The first contains the image's title, and its styles are controlled by the PopupThumbTitle selector in the <styles> section of the XML configuration file. The second contains the image's caption, and its styles are controlled by the PopupThumbCaption selector in the <styles> section of the XML configuration file. For more information about customizing these text styles, see the PopupThumbTitle and PopupThumbCaption classes. The tooltip's dimensions are determined by the dimension settings on the PopupToolTip. The caption is displayed or not displayed based on the tooltipShowCaption style setting. The length of the text displayed in each of the boxes before trunction occurs is controlled by tooltipTruncateTitleAt and tooltipTruncateCaptionAt.

See also

usePagedScrollingproperty 
public var usePagedScrolling:Boolean = true

Specifies if page-based or contiguous scrolling should be used.

The default value, true, means that the tiles are split up into separate pages. Navigation between each page is a distinct jump from one page to another; there is no partial page scrolling. Each page "snaps" from one to another.

If set to false, the tiles will be laid out contiguously. Scrolling will be contiguous, with no "snap" between pages, and scrollbars will automatically show as needed.

The default value is true.

Constructor detail
PagingControlHolder()constructor
public function PagingControlHolder()
Method detail
createChildren()method
protected override function createChildren():void
measure()method 
protected override function measure():void
setupStyles()method 
protected function setupStyles():void
updateDisplayList()method 
protected override function updateDisplayList(w:Number, h:Number):voidParameters
w:Number
 
h:Number