Packageat.modules
Classpublic class SiteMap3DModule
InheritanceSiteMap3DModule Inheritance mx.core.UIComponent

The SiteMap3DModule is a carousel represenation of all of the slides for a brand.

The component has a visual component of sections on the left-hand side. Those sections are duplicated in a carousel of sections on the right-hand side with each panel showing a list of all of the slides included in that section. Each slide has a thumbnail icon that can be clicked to show a thumbnail of the slide below the left-hand section menu.

Clicking the slide name dispatches an ItemClickEvent that can be used to navigate around; i.e. a PresentationModule.

The easiest way to get all of the brand data into the component is to set the indicationID and the component will load the dataProvider automatically.



Public Properties
 PropertyDefined by
  container : SiteMap3DContainer
The container for all of the 3D panels.
SiteMap3DModule
  dataProvider : Object
Sets the data provider for the SiteMap3DModule

This value is only necessary if a indicationID was not provided.

SiteMap3DModule
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
SiteMap3DModule
  indicationID : int
The dbid of the current presentation.
SiteMap3DModule
  itemSectionTitleAttribute : String
The attribute in the dataProvider to use for the left-hand section list.
SiteMap3DModule
Protected Properties
 PropertyDefined by
  createdRenderers : Array
A list of the currently active panels in the component.
SiteMap3DModule
  detailImage : SmoothSWFLoader
The loader for the thumbnail image.
SiteMap3DModule
  freeItemRenderers : Array
A list of panels that have been removed due to a shortened length in the dataProvider.
SiteMap3DModule
  list : ListExtended
The List on the left-hand side of the component.
SiteMap3DModule
  scrollBar : HScrollBar
The HScrollBar at the bottom of the component.
SiteMap3DModule
  _st : HFixedScrollThumb
Holder for the ScrollThumb.
SiteMap3DModule
  tnContainer : Canvas
The holder for the thumbnail.
SiteMap3DModule
Public Methods
 MethodDefined by
  
Constructor.
SiteMap3DModule
  
setSelectedIndex(column:int, row:int):void
Sets the selected index for the slide component.
SiteMap3DModule
Protected Methods
 MethodDefined by
  
clickHandler(e:MouseEvent):void
Handles the clicking of a panel to be the selected panel in the display.
SiteMap3DModule
  
Handles the creation of the 3D panels when a new dataProvider is used.
SiteMap3DModule
  
detailHandler(e:EffectEvent):void
Scrolls to the selected section in the left-hand list when a thumbnail is shown.
SiteMap3DModule
  
displayContainer(e:Event):void
SiteMap3DModule
  
SiteMap3DModule
  
handleSlideClick(e:ListEvent):void
Handles the item click for the slide component.
SiteMap3DModule
  
resetOtherPanels(e:Event = null):void
Set all other panels back to an unselected state.
SiteMap3DModule
  
scrollHandler(e:ScrollEvent):void
Sets the selected container based on the position of the scrollThumb.
SiteMap3DModule
  
unloadImage(e:Event = null):void
Unloads the image from the thumbnail holder.
SiteMap3DModule
Events
 EventSummaryDefined by
   Dispatched when a list item in one of the panels is clicked.SiteMap3DModule
Styles
 StyleDescriptionDefined by
  
siteMap3DContainerStyleName
Type: String
The styleName for the container for the 3D panels. The default value is "siteMap3DContainerStyle".
SiteMap3DModule
  
siteMapHScrollBarLabelStyleName
Type: String
The styleName for the text on the ScrollThumb on the horizontal scrollBar at the bottom of the component.

If the fontSize is changed, use paddingTop to vertically center the text.

The default value is "siteMapHScrollBarLabelStyle".
SiteMap3DModule
  
siteMapHScrollBarStyleName
Type: String
The styleName for the horizontal scrollBar at the bottom of the component. The default value is "siteMapHScrollBarStyle".
SiteMap3DModule
  
siteMapSectionListStyleName
Type: String
The styleName for the list in the 3D section. The default value is "siteMapSectionListStyle".
SiteMap3DModule
  
siteMapSectionVScrollBarStyleName
Type: String
The styleName for the vertical scrollBar in the list of sections on the left-hand side. The default value is "siteMapSectionVScrollBarStyle".
SiteMap3DModule
  
siteMapThumbnailContainerStyleName
Type: String
The styleName for the box around the detail thumbnail. The default value is "siteMapThumbnailContainerStyle".
SiteMap3DModule
Property detail
containerproperty
public var container:SiteMap3DContainer

The container for all of the 3D panels.

createdRenderersproperty 
protected var createdRenderers:Array

A list of the currently active panels in the component.

The default value is [].

dataProviderproperty 
dataProvider:Object  [read-write]

Sets the data provider for the SiteMap3DModule

This value is only necessary if a indicationID was not provided. If the indicationID is provided, then the component calls DataInterface.getBrandSlides() and sets the result to the dataProvider.

To specify a thumbnail image for this Module, use the slideThumbnailFilename property in each <slide /> node.

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void

See also


Example
   <section>
     <slide slideThumbnailFilename="path/to/file/filename.jpg"... />
     <slide slideThumbnailFilename="path/to/file/filename.jpg"... />
     <slide slideThumbnailFilename="path/to/file/filename.jpg"... />
   </section>
   <section...>
     <slide slideThumbnailFilename="path/to/file/filename.jpg"... />
   </section>

debugModeproperty 
public var debugMode:Boolean = false

Outputs useful information for debugging this component for developers when true.

The output is typically in the form of trace statements and Alerts.

The default value is false.

detailImageproperty 
protected var detailImage:SmoothSWFLoader

The loader for the thumbnail image.

This image is loaded from the data provided, and uses the slideThumbnailFilename to load from.

freeItemRenderersproperty 
protected var freeItemRenderers:Array

A list of panels that have been removed due to a shortened length in the dataProvider. These will be reused if the dataProvider becomes longer in length.

The default value is [].

indicationIDproperty 
indicationID:int  [read-write]

The dbid of the current presentation.

By passing in an indication dbid the SiteMapListModule will automatically call DataInterface.getIndicationSlideData() and set the dataProvider of the component. This will get all of the Sections with Slides for the indication.

The default value is -1.

Implementation
    public function get indicationID():int
    public function set indicationID(value:int):void
itemSectionTitleAttributeproperty 
itemSectionTitleAttribute:String  [read-write]

The attribute in the dataProvider to use for the left-hand section list.

The default value is "title".

Implementation
    public function get itemSectionTitleAttribute():String
    public function set itemSectionTitleAttribute(value:String):void
listproperty 
protected var list:ListExtended

The List on the left-hand side of the component.

scrollBarproperty 
protected var scrollBar:HScrollBar

The HScrollBar at the bottom of the component.

_stproperty 
protected var _st:HFixedScrollThumb

Holder for the ScrollThumb.

tnContainerproperty 
protected var tnContainer:Canvas

The holder for the thumbnail.

Constructor detail
SiteMap3DModule()constructor
public function SiteMap3DModule()

Constructor.

Method detail
clickHandler()method
protected function clickHandler(e:MouseEvent):void

Handles the clicking of a panel to be the selected panel in the display.

Parameters
e:MouseEvent — The click event
createNavigation()method 
protected function createNavigation():void

Handles the creation of the 3D panels when a new dataProvider is used.

detailHandler()method 
protected function detailHandler(e:EffectEvent):void

Scrolls to the selected section in the left-hand list when a thumbnail is shown.

Parameters
e:EffectEvent — The effect event
displayContainer()method 
protected function displayContainer(e:Event):voidParameters
e:Event
getFreeOrNewItemRenderer()method 
protected function getFreeOrNewItemRenderer():SiteMap3DPanel

Returns
SiteMap3DPanel
handleSlideClick()method 
protected function handleSlideClick(e:ListEvent):void

Handles the item click for the slide component.

Parameters
e:ListEvent — The list event
resetOtherPanels()method 
protected function resetOtherPanels(e:Event = null):void

Set all other panels back to an unselected state.

Parameters
e:Event (default = null)
scrollHandler()method 
protected function scrollHandler(e:ScrollEvent):void

Sets the selected container based on the position of the scrollThumb.

Parameters
e:ScrollEvent — The scroll event
setSelectedIndex()method 
public function setSelectedIndex(column:int, row:int):void

Sets the selected index for the slide component.

The column is the section and the row is the slide to be hilited in the list.

Parameters
column:int — The index of the section
 
row:int — The index of the slide in the section
unloadImage()method 
protected function unloadImage(e:Event = null):void

Unloads the image from the thumbnail holder.

Parameters
e:Event (default = null) — The optional event to trigger the unload
Event detail
itemClickevent 
Event object type: mx.events.ItemClickEvent

Dispatched when a list item in one of the panels is clicked.