Packageat.containers
Classpublic class SiteMap3DItemContainer
InheritanceSiteMap3DItemContainer Inheritance mx.containers.VBox

This is the component that holds the list of slide names in the SiteMap3DModule.


Public Properties
 PropertyDefined by
  scrollBarText : String
The text to be displayed on the ScrollThumb.
SiteMap3DItemContainer
Protected Properties
 PropertyDefined by
  labelField : Text
The Text that appears on the ScrollThumb.
SiteMap3DItemContainer
Public Methods
 MethodDefined by
  
SiteMap3DItemContainer()
Constructor.
SiteMap3DItemContainer
  
updateScrollThumbText(e:Event = null, delta:Number = 0):void
Updates the text that appears on the ScrollThumb.
SiteMap3DItemContainer
Protected Methods
 MethodDefined by
  
getVisibleItems(delta:Number = 0):Array
Returns an array of indicies of all of the items visible in the list, to be used for the ScrollThumb text.
SiteMap3DItemContainer
  
isItemVisible(value:DisplayObject, delta:Number = 0):Boolean
Checks to determine whether or not the supplied DisplayObject is visible in the list.
SiteMap3DItemContainer
  
scrollHandler(e:ScrollEvent):void
Handles the interaction with the scrollBar.
SiteMap3DItemContainer
Events
 EventSummaryDefined by
  
itemClick
Dispatched when the item is clicked on.SiteMap3DItemContainer
  
itemFocusIn
Dispatched when the thumbnail is clicked on.SiteMap3DItemContainer
  
itemFocusOut
Dispatched when the thumbnail is clicked on, when it is currently selected.SiteMap3DItemContainer
Property detail
labelFieldproperty
protected var labelField:Text

The Text that appears on the ScrollThumb.

scrollBarTextproperty 
scrollBarText:String  [read-write]

The text to be displayed on the ScrollThumb.

Implementation
    public function get scrollBarText():String
    public function set scrollBarText(value:String):void
Constructor detail
SiteMap3DItemContainer()constructor
public function SiteMap3DItemContainer()

Constructor.

Method detail
getVisibleItems()method
protected function getVisibleItems(delta:Number = 0):Array

Returns an array of indicies of all of the items visible in the list, to be used for the ScrollThumb text.

Parameters
delta:Number (default = 0) — The distance that has been scrolled from a ScrollEvent due to the fact that the display has not updated this container's content positions.

Returns
Array — An array of indicies
isItemVisible()method 
protected function isItemVisible(value:DisplayObject, delta:Number = 0):Boolean

Checks to determine whether or not the supplied DisplayObject is visible in the list.

Parameters
value:DisplayObject — The DisplayObject to check
 
delta:Number (default = 0) — The distance that has been scrolled from a ScrollEvent due to the fact that the display has not updated this container's content positions.

Returns
Boolean — If the item is visible true else false
scrollHandler()method 
protected function scrollHandler(e:ScrollEvent):void

Handles the interaction with the scrollBar.

Parameters
e:ScrollEvent — The scroll event
updateScrollThumbText()method 
public function updateScrollThumbText(e:Event = null, delta:Number = 0):void

Updates the text that appears on the ScrollThumb.

Parameters
e:Event (default = null)
 
delta:Number (default = 0)
Event detail
itemClickevent 
Event object type: mx.events.ListEvent

Dispatched when the item is clicked on.

itemFocusInevent  
Event object type: mx.events.ListEvent

Dispatched when the thumbnail is clicked on.

itemFocusOutevent  
Event object type: mx.events.ListEvent

Dispatched when the thumbnail is clicked on, when it is currently selected.




Copyright 2009 AbelsonTaylor