| Package | at.modules |
| Class | public class SiteMapModule |
| Inheritance | SiteMapModule  SiteMapBase mx.containers.Canvas |
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
| Property | Defined by | ||
|---|---|---|---|
| brandID : int
The brand id of the current presentation.
| SiteMapModule | ||
| dataProvider : Object | SiteMapModule | ||
 | debugMode : Boolean = false
Outputs useful information for debugging this component for developers when
true. | SiteMapBase | |
| getBrandSlideData : GetBrandSlideDataXML
Instantiates the
GetBrandSlideDataXML class. | SiteMapBase | |
| getIndication : GetIndicationXML
Instantiates the
GetIndicationXML class. | SiteMapBase | |
| getIndicationSlideData : GetIndicationSlideDataXML
Instantiates the
GetIndicationSlideDataXML class. | SiteMapBase | |
| getSectionSlideData : GetSectionSlideDataXML
Instantiates the
GetSectionSlideDataXML class. | SiteMapBase | |
| view : String [write-only]
Sets the current view.
| SiteMapModule | ||
| Property | Defined by | ||
|---|---|---|---|
| siteMapImageView : ListExtended
The image view of the
SiteMapModule. | SiteMapModule | ||
| siteMapListView : eVESiteMapContainer
The list view of the
SiteMapModule. | SiteMapModule | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| SiteMapModule | ||
|
getBrandSlides(brandID:int):XMLList
Method for retrieving consolidated section and slide data from the application database.
| SiteMapBase | |
|
getIndications(brandID:int):XMLList
Method for retrieving indication data from the application database.
| SiteMapBase | |
| Method | Defined by | ||
|---|---|---|---|
|
measure():void
| SiteMapModule | ||
|
onListItemClick(e:ItemClickEvent):void
Method for processing of a list item click from the site map control based on applied listeners.
| SiteMapBase | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| SiteMapModule | ||||
| Constant | Defined 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 | ||
| brandID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbrandID: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.
public function get brandID():int
public function set brandID(value:int):void
| dataProvider | property |
dataProvider:Object [read-write]Implementation
public function get dataProvider():Object
public function set dataProvider(value:Object):void
| siteMapImageView | property |
protected var siteMapImageView:ListExtended
The image view of the SiteMapModule.
| siteMapListView | property |
protected var siteMapListView:eVESiteMapContainer
The list view of the SiteMapModule.
| view | property |
view:String [write-only]Sets the current view.
The component loads the SiteMapModule.IMAGE_VIEW
by default.
public function set view(value:String):void
| SiteMapModule | () | constructor |
public function SiteMapModule()Constructor.
| measure | () | method |
protected override function measure():void
| itemClick | event |
| IMAGE_VIEW | constant |
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_VIEW | constant |
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.