Packageat.controls
Classpublic class SiteMap3DPanel
InheritanceSiteMap3DPanel Inheritance mx.core.UIComponent

The SiteMap3DPanel contains a list of slides contained in the section, the name of which is displayed in a Label at the top of the component.

This component is used internally in the SiteMap3DModule as one of the 3D panels on the right-hand side.

The title for the section can be set by setting the label property.



Public Properties
 PropertyDefined by
  centerRegistrationPoint : Boolean = false
Centers the registration point of the component for ease of use in 3D manipulation.
SiteMap3DPanel
  dataProvider : Object
[write-only] The list of slides to be used for the list in this component.
SiteMap3DPanel
  itemColumnIndex : int = -1
The index of the column in the 3D rotation.
SiteMap3DPanel
  label : String
The title of the Section to display in the titleLabel.
SiteMap3DPanel
  list : SiteMap3DDataList
The SiteMapDataList that holds all of the Slide information.
SiteMap3DPanel
  panelColor : uint
The color for the background of this section.
SiteMap3DPanel
Protected Properties
 PropertyDefined by
  slideProps : Object
The properties for the slide repeater.
SiteMap3DPanel
  slideRepeater : Repeater
The repeater for the Slides in the Section from the dataProvider.
SiteMap3DPanel
  titleLabel : Label
The Label that displays the title of the Section.
SiteMap3DPanel
Public Methods
 MethodDefined by
  
Constructor.
SiteMap3DPanel
  
deselectThumbnails(keepSelected:int = -1):Boolean
SiteMap3DPanel
  
setDetailButtons(selectedIndex:int = -1, detailClick:Boolean = true):void
Toggles the background for the detail buttons.
SiteMap3DPanel
Protected Methods
 MethodDefined by
  
detailClickHandler(e:ListEvent):void
Handles the click on the thumbnail icon in the list.
SiteMap3DPanel
  
itemClickHandler(e:ListEvent):void
Handles a click to an item in the list that isn't a thumbnail.
SiteMap3DPanel
Events
 EventSummaryDefined by
   Dispatched when a thumbnail image in the list is clicked.SiteMap3DPanel
   Dispatched when a selected thumbnail is clicked on.SiteMap3DPanel
   Dispatched when an item in the list is clicked.SiteMap3DPanel
Styles
 StyleDescriptionDefined by
  
siteMapPanelItemStyleName
Type: String
The StyleName for an item in the list. The default value is "siteMapPanelItemStyle".
SiteMap3DPanel
  
siteMapPanelLabelStyleName
Type: String
The styleName for the titleLabel. The default value is "siteMapPanelLabelStyle".
SiteMap3DPanel
Property detail
centerRegistrationPointproperty
public var centerRegistrationPoint:Boolean = false

Centers the registration point of the component for ease of use in 3D manipulation.

This will move all of the visuals to a negative coordinate when set to true.

The default value is false.

dataProviderproperty 
dataProvider:Object  [write-only]

The list of slides to be used for the list in this component.

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

Example
<slide /> <slide /> <slide /> <slide />

itemColumnIndexproperty 
public var itemColumnIndex:int = -1

The index of the column in the 3D rotation.

The default value is -1.

labelproperty 
label:String  [read-write]

The title of the Section to display in the titleLabel.

The default value is "".

Implementation
    public function get label():String
    public function set label(value:String):void
listproperty 
public var list:SiteMap3DDataList

The SiteMapDataList that holds all of the Slide information.

panelColorproperty 
panelColor:uint  [read-write]

The color for the background of this section.

The default value is 0x333333.

Implementation
    public function get panelColor():uint
    public function set panelColor(value:uint):void
slidePropsproperty 
protected var slideProps:Object

The properties for the slide repeater.

slideRepeaterproperty 
protected var slideRepeater:Repeater

The repeater for the Slides in the Section from the dataProvider.

titleLabelproperty 
protected var titleLabel:Label

The Label that displays the title of the Section.

Constructor detail
SiteMap3DPanel()constructor
public function SiteMap3DPanel()

Constructor.

Method detail
deselectThumbnails()method
public function deselectThumbnails(keepSelected:int = -1):BooleanParameters
keepSelected:int (default = -1)

Returns
Boolean
detailClickHandler()method 
protected function detailClickHandler(e:ListEvent):void

Handles the click on the thumbnail icon in the list.

Parameters
e:ListEvent — The list event
itemClickHandler()method 
protected function itemClickHandler(e:ListEvent):void

Handles a click to an item in the list that isn't a thumbnail.

Parameters
e:ListEvent — The list event
setDetailButtons()method 
public function setDetailButtons(selectedIndex:int = -1, detailClick:Boolean = true):void

Toggles the background for the detail buttons.

This will set the visual display of the list based on a click. If detailClick is true, it will deselect any item in the list to ensure the thumbnail image is highlighted in the list. Otherwise it will set the selected index in the list to the item that was clicked.

Parameters
selectedIndex:int (default = -1) — The index of the item that was selected
 
detailClick:Boolean (default = true) — Set to true if the thumbnail was clicked
Event detail
detailClickevent 
Event object type: mx.events.ListEvent

Dispatched when a thumbnail image in the list is clicked.

This event is custom to this component and doesn't follow typical standards for events. It is internal to the SiteMap3DModule.

hideThumbnailevent  
Event object type: flash.events.Event

Dispatched when a selected thumbnail is clicked on.

When this event is dispatched the thumbnail image will deselect and the displayed image will be hidden.

itemClickevent  
Event object type: mx.events.ListEvent

Dispatched when an item in the list is clicked.