Packageat.display
Classpublic class AnnotationList
InheritanceAnnotationList Inheritance mx.containers.Panel

The AnnotationList contains an Accordion component to display sections of annotations.

The accordion displays a series of annotations based on the data provided to the component. These sections can be clicked on and so can the annotations.



Public Properties
 PropertyDefined by
  accordion : Accordion
The accordion component inside of the AnnotationList.
AnnotationList
  accordionChangeDuration : uint
The amount of time it takes the accordion component to animate between sections
AnnotationList
  accordionHeaderRenderer : IFactory
The renderer for the headers in the Accordion.
AnnotationList
  accordionIndex : uint
The index of the currently selected section in the accordion.
AnnotationList
  accordionItems : Array
The items in the accordion.
AnnotationList
  assetDirectory : String
The directory location of the files and configuration for this AnnotationModule.
AnnotationList
  autoAnnotationPauseDuration : uint = 400
The amount of time to pause in between simulated user-based iteractions in milliseconds (detail_close => pause => accordion_click => pause => detail_open)
AnnotationList
  columnWidth : Number
The width of each item in the accordion list.
AnnotationList
  configXML : XML
The contents of the loaded configuration XML file.
AnnotationList
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
AnnotationList
  detail : VBox
The container for the detailContainer and the detailCloseBtn.
AnnotationList
  detailCloseBtn : Button
Button that switches from the list view to the detail view for an annotation.
AnnotationList
  detailCloseButtonLabel : String
The text for the button to return to the list view from the detail.
AnnotationList
  detailContainer : Canvas
The container around the detailLoader's SWFLoader to allow for long imagery to scroll.
AnnotationList
  detailLoader : SWFLoader
The loader for the detail.
AnnotationList
  hideAnnotationListDuration : uint = 400
The amount of time it takes to show/hide the detail, in milliseconds.
AnnotationList
  hideAnnotationListEasingFunction : Function
The easing function for the movement between showing/hiding the annotation detail.
AnnotationList
  rowHeight : Number = 100
The height for each annotation.
AnnotationList
Public Methods
 MethodDefined by
  
Constructor.
AnnotationList
  
enterStateHandler(e:StateChangeEvent):void
Executed when the detail list is displayed or hidden.
AnnotationList
  
returns a reference to the List that is open in the Accordion component
AnnotationList
  
hideDetail():void
Hides detail content and shows the Accordion component.
AnnotationList
  
loadDetail(url:String):Boolean
Loads content using a SWFLoader into the detail window
AnnotationList
  
scrollToIndex(index:int):Boolean
Scrolls to a specific index in the current annotation section.
AnnotationList
  
setCurrentAnnotation(annotationID:String = null):Boolean
Changes the current annotation to the one with the id specified.
AnnotationList
  
showDetail():void
Shows detail content and hides the Accordion component.
AnnotationList
Events
 EventSummaryDefined by
   Dispatched when the AnnotationList displays a detail.AnnotationList
   Dispatched when the AnnotationList displays the list of annotations.AnnotationList
Styles
 StyleDescriptionDefined by
  
accordionItemDescriptionStyleName
Type: String
Sets the styleName for the description text in the Accordion list. The default value is "accordionItemDescriptionStyle".
AnnotationList
  
accordionItemTitleStyleName
Type: String
Sets the styleName for the title of the annotation in the Accordion list. The default value is "accordionItemTitleStyle".
AnnotationList
  
accordionStyleName
Type: String
The styleName for the Accordion component found in the AnnotationList. The default value is "accordionStyle".
AnnotationList
  
annotationDetailStyleName
Type: String
The detail style is mainly to add padding and scroll bar style for the container of the loaded detail. The default value is "annotationDetailStyle".
AnnotationList
  
detailCloseButtonStyleName
Type: String
The styleName for the button to close the detail and return to the annotation list. The default value is detailCloseButtonStyle.
AnnotationList
Property detail
accordionproperty
public var accordion:Accordion

The accordion component inside of the AnnotationList.

accordionChangeDurationproperty 
accordionChangeDuration:uint  [read-write]

The amount of time it takes the accordion component to animate between sections

The default value is 1000.

Implementation
    public function get accordionChangeDuration():uint
    public function set accordionChangeDuration(value:uint):void
accordionHeaderRendererproperty 
public var accordionHeaderRenderer:IFactory

The renderer for the headers in the Accordion.

See also

mx.containers.Accordion
accordionIndexproperty 
accordionIndex:uint  [read-write]

The index of the currently selected section in the accordion.

The default value is -1.

This property can be used as the source for data binding.

Implementation
    public function get accordionIndex():uint
    public function set accordionIndex(value:uint):void
accordionItemsproperty 
public var accordionItems:Array

The items in the accordion.

The default value is [].

assetDirectoryproperty 
public var assetDirectory:String

The directory location of the files and configuration for this AnnotationModule. If this is empty, it defaults to the root of the application (""). Otherwise it takes the supplied path and formats it for use (adds trailing slash).

Typically passed in from the AnnotationModule.

The default value is "".

autoAnnotationPauseDurationproperty 
public var autoAnnotationPauseDuration:uint = 400

The amount of time to pause in between simulated user-based iteractions in milliseconds (detail_close => pause => accordion_click => pause => detail_open)

The default value is 400.

columnWidthproperty 
public var columnWidth:Number

The width of each item in the accordion list. Defaults to the width of the accordion.

configXMLproperty 
configXML:XML  [read-write]

The contents of the loaded configuration XML file.

The default value is null.

This property can be used as the source for data binding.

Implementation
    public function get configXML():XML
    public function set configXML(value:XML):void
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.

detailproperty 
public var detail:VBox

The container for the detailContainer and the detailCloseBtn.

See also

detailCloseBtnproperty 
public var detailCloseBtn:Button

Button that switches from the list view to the detail view for an annotation.

detailCloseButtonLabelproperty 
detailCloseButtonLabel:String  [read-write]

The text for the button to return to the list view from the detail.

The default value is "Back to Annotation List".

Implementation
    public function get detailCloseButtonLabel():String
    public function set detailCloseButtonLabel(value:String):void
detailContainerproperty 
public var detailContainer:Canvas

The container around the detailLoader's SWFLoader to allow for long imagery to scroll.

detailLoaderproperty 
public var detailLoader:SWFLoader

The loader for the detail.

hideAnnotationListDurationproperty 
public var hideAnnotationListDuration:uint = 400

The amount of time it takes to show/hide the detail, in milliseconds.

The default value is 400.

hideAnnotationListEasingFunctionproperty 
public var hideAnnotationListEasingFunction:Function

The easing function for the movement between showing/hiding the annotation detail.

The default value is Linear.easeIn.

rowHeightproperty 
public var rowHeight:Number = 100

The height for each annotation.

The default value is 100.

Constructor detail
AnnotationList()constructor
public function AnnotationList()

Constructor.

Method detail
enterStateHandler()method
public function enterStateHandler(e:StateChangeEvent):void

Executed when the detail list is displayed or hidden.

Parameters
e:StateChangeEvent — The state change event
getCurrentList()method 
public function getCurrentList():List

returns a reference to the List that is open in the Accordion component

Returns
List — The List of the current accordion selection
hideDetail()method 
public function hideDetail():void

Hides detail content and shows the Accordion component.

loadDetail()method 
public function loadDetail(url:String):Boolean

Loads content using a SWFLoader into the detail window

Parameters
url:String — The url of the content to load

Returns
Booleantrue if the operation was execeptoin free, otherwise false
scrollToIndex()method 
public function scrollToIndex(index:int):Boolean

Scrolls to a specific index in the current annotation section.

Parameters
index:int — The index to scroll to

Returns
Boolean
setCurrentAnnotation()method 
public function setCurrentAnnotation(annotationID:String = null):Boolean

Changes the current annotation to the one with the id specified.

Parameters
annotationID:String (default = null) — The id of the annotation to be navigated to

Returns
Boolean
showDetail()method 
public function showDetail():void

Shows detail content and hides the Accordion component.

Event detail
showAnnotationDetailevent 

Dispatched when the AnnotationList displays a detail.

showAnnotationListevent  

Dispatched when the AnnotationList displays the list of annotations.