Packageat.modules
Classpublic class SiteMapModule
InheritanceSiteMapModule Inheritance SiteMapBase Inheritance mx.containers.Canvas

The SiteMapModule allows for easy navigation to any slide in brand.

The SiteMapModule has two different navigation views for navigating to any slide in a brand. The switch can be made by setting view to "imageView" or "listView" via the two constants.

The image view is a vertical list of rows of slides. Each row represents a section in the brand. In each row, there are thumbnails of the slides available. Any one of the slides can be clicked for easy navigation to that particular slide. The list view has a 3D representation of the sections, with a list of slide titles to be clicked on. Each title has a thumbnail icon that can be clicked on to view a thumbnail of the slide on the left-hand side of the component. The list view also has a list on the left above the thumbnail to click to a section. In either view, the an ItemClickEvent is dispatched for easy navigation to a particular slide.

See also

at.controls.eVESiteMapContainer
at.controls.ListExtended


Public Properties
 PropertyDefined by
  brandID : int
The brand id of the current presentation.
SiteMapModule
  dataProvider : Object
SiteMapModule
 InheriteddebugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
SiteMapBase
 InheritedgetBrandSlideData : GetBrandSlideDataXML
Instantiates the GetBrandSlideDataXML class.
SiteMapBase
 InheritedgetIndication : GetIndicationXML
Instantiates the GetIndicationXML class.
SiteMapBase
 InheritedgetIndicationSlideData : GetIndicationSlideDataXML
Instantiates the GetIndicationSlideDataXML class.
SiteMapBase
 InheritedgetSectionSlideData : GetSectionSlideDataXML
Instantiates the GetSectionSlideDataXML class.
SiteMapBase
  view : String
[write-only] Sets the current view.
SiteMapModule
Protected Properties
 PropertyDefined by
  siteMapImageView : ListExtended
The image view of the SiteMapModule.
SiteMapModule
  siteMapListView : eVESiteMapContainer
The list view of the SiteMapModule.
SiteMapModule
Public Methods
 MethodDefined by
  
Constructor.
SiteMapModule
 Inherited
getBrandSlides(brandID:int):XMLList
Method for retrieving consolidated section and slide data from the application database.
SiteMapBase
 Inherited
getIndications(brandID:int):XMLList
Method for retrieving indication data from the application database.
SiteMapBase
Protected Methods
 MethodDefined by
  
measure():void
SiteMapModule
 Inherited
onListItemClick(e:ItemClickEvent):void
Method for processing of a list item click from the site map control based on applied listeners.
SiteMapBase
Events
 EventSummaryDefined by
    SiteMapModule
Public Constants
 ConstantDefined by
  IMAGE_VIEW : String = "imageView"
[static] Constant to switch to image view.
SiteMapModule
  LIST_VIEW : String = "listView"
[static] Constant to switch to list view.
SiteMapModule
Property detail
brandIDproperty
brandID:int  [read-write]

The brand id of the current presentation.

By passing in a brandID the SiteMapModule will automatically call DataInterface.getBrandSlides() and set the dataProvider of the component. This will get all of the indications' sections with slides for the current presentation.

The default value is -1.

Implementation
    public function get brandID():int
    public function set brandID(value:int):void
dataProviderproperty 
dataProvider:Object  [read-write]Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void
siteMapImageViewproperty 
protected var siteMapImageView:ListExtended

The image view of the SiteMapModule.

siteMapListViewproperty 
protected var siteMapListView:eVESiteMapContainer

The list view of the SiteMapModule.

viewproperty 
view:String  [write-only]

Sets the current view.

The component loads the SiteMapModule.IMAGE_VIEW by default.

Implementation
    public function set view(value:String):void
Constructor detail
SiteMapModule()constructor
public function SiteMapModule()

Constructor.

Method detail
measure()method
protected override function measure():void
Event detail
itemClickevent 
Event object type: mx.events.ItemClickEvent

Constant detail
IMAGE_VIEWconstant
public static const IMAGE_VIEW:String = "imageView"

Constant to switch to image view.

Set the value of view with this constant to change the view to the image view.

LIST_VIEWconstant 
public static const LIST_VIEW:String = "listView"

Constant to switch to list view.

Set the value of view with this constant to change the view to the list view.