Packageat.modules
Classpublic class AnnotationModule
InheritanceAnnotationModule Inheritance mx.containers.HBox

The AnnotationModule is displays a list of clickable annotations that highlight in a displayed HTML document and display further information about the highlighted text from an external file.



Public Properties
 PropertyDefined by
  accordionChangeDuration : uint
The amount of time it takes the accordion in the AnnotationList component to animate between sections.
AnnotationModule
  accordionHeaderRenderer : IFactory
The accordionHeaderRenderer is a component that is placed at the top of the AnnotationList component in the AnnotationModule.
AnnotationModule
  accordionItems : Array = null
An array of all of the lists that are put into the accordion in the AnnotationList
AnnotationModule
  annotatedDocument : AnnotatedDocument
This is an implementation of the AnnotatedDocument class that displays a html file in a text field with highlights that pertain to annotations listed in the AnnotationList.
AnnotationModule
  annotationFilesDirectory : String
The directory location of the annotation files for this AnnotationModule.
AnnotationModule
  annotationListTitle : String
This is the text that is displayed in the title above the accordion in the AnnotationList.
AnnotationModule
  annotationPanel : AnnotationList
The annotation panel is the an AnnotationList component that is on the left side of the AnnotationModule.
AnnotationModule
  assetDirectory : String
The directory location of the files and configuration for this AnnotationModule.
AnnotationModule
  autoAnnotationPauseDuration : uint
The amount of time to pause in between simulated user-based iteractions in milliseconds in the AnnotationList (detail_close => pause => accordion_click => pause => detail_open)
AnnotationModule
  autoLoad : Boolean = true
Whether or not to load the XML configuration file when the Module is created, based on the configDirectoryName and configFilename.
AnnotationModule
  configDirectoryName : String
Directory name for the location of where the Module's configuration file is stored.
AnnotationModule
  configFilename : String
Filename for the configuration file for the AnnotationModule.
AnnotationModule
  configXML : XML
The contents of the loaded configuration XML file.
AnnotationModule
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
AnnotationModule
  detailCloseButtonLabel : String
This is the text for the button displayed when a detail for an annotation is displayed in the AnnotationList.
AnnotationModule
  documentCSS : StyleSheet
This is the CSS document for the text field to diplsay the mainDocument.
AnnotationModule
  hideAnnotationListDuration : uint
The amount of time it takes to show/hide the detail, in milliseconds.
AnnotationModule
  hideAnnotationListEasingFunction : Function
The easing function for the movement between showing/hiding the annotation detail.
AnnotationModule
  listWidth : int
AnnotationModule
  mainDocumentFilename : String
Filename for the main annotated document HTML file for the AnnotationModule.
AnnotationModule
  mainDocumentTitle : String
The title to be displayed above the HTML file in the AnnotatedDocument.
AnnotationModule
Public Methods
 MethodDefined by
  
Constructor.
AnnotationModule
  
deInit():void
Handles the removal of the Module by the ModuleInitializer.
AnnotationModule
  
detailLoaded(e:Event):void
Displays the detail in the AnnotationPanel after the detail is loaded.
AnnotationModule
  
getAnnotationAt(sectionIndex:uint, annotationIndex:uint):Annotation
Returns an Annotation object based on the section and annotation indicies.
AnnotationModule
  
Returns an Annotation object based on id passed in.
AnnotationModule
  
getSectionAt(sectionIndex:uint):Object
Returns the section properties as on object based on the section index passed in.
AnnotationModule
  
init(initProperties:Object):void
Initiates the AnnotationModule to create most of its children, to be created or removed at any time by the ModuleInitializer.
AnnotationModule
  
loadConfigError(e:FaultEvent):void
Alerts that there was an error loading the configXML.
AnnotationModule
  
A way to load the configuration XML manually or if the autoLoad is set to false.
AnnotationModule
  
parseConfigXML(e:ResultEvent):void
Handles the loaded XML file and saves the results into the configXML property.
AnnotationModule
Protected Methods
 MethodDefined by
  
Changes the selectedIndex of the accordion in the AnnotationList based on an event from the AnnotatedDocument.
AnnotationModule
  
documentLinkClickHandler(e:TextEvent):void
Handles the click from an annotation in the AnnotationList.
AnnotationModule
Events
 EventSummaryDefined by
   Dispatched when the deInit() method has completed.AnnotationModule
   Dispatched when the AnnotationModule has completed the init() method to instantiate all of the children on the Module, and added the event listeners.AnnotationModule
   Dispatched when the AnnotationList displays a detail.AnnotationModule
   Dispatched when the AnnotationList displays the list of annotations.AnnotationModule
Styles
 StyleDescriptionDefined by
  
annotationDocumentStyleName
Type: String
Style for the AnnotationDocument contained in the Module. The default value is "annotationDocumentStyle".
AnnotationModule
  
annotationListStyleName
Type: String
Style for the AnnotationList contained in the Module. The default value is "annotationListStyle".
AnnotationModule
  
highlightAnnotationColor
Type: uint   Format: Color
The color for the annotations when they are not selected. Requires alpha when specifying the color. In the form 0xAARRGGBB. The default value is 0xffff0000.
AnnotationModule
  
highlightSelectionColor
Type: uint   Format: Color
The color for the currently selected annotation. Requires alpha when specifying the color. In the form 0xAARRGGBB. The default value is 0xff000000.
AnnotationModule
Property detail
accordionChangeDurationproperty
accordionChangeDuration:uint  [read-write]

The amount of time it takes the accordion in the AnnotationList 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 accordionHeaderRenderer is a component that is placed at the top of the AnnotationList component in the AnnotationModule. Its the same one that is used in a Panel component.

See also

mx.containers.Panel
accordionItemsproperty 
public var accordionItems:Array = null

An array of all of the lists that are put into the accordion in the AnnotationList

annotatedDocumentproperty 
public var annotatedDocument:AnnotatedDocument

This is an implementation of the AnnotatedDocument class that displays a html file in a text field with highlights that pertain to annotations listed in the AnnotationList.

See also

annotationFilesDirectoryproperty 
annotationFilesDirectory:String  [read-write]

The directory location of the annotation files 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).

The default value is "files/".

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

Implementation
    public function get annotationFilesDirectory():String
    public function set annotationFilesDirectory(value:String):void
annotationListTitleproperty 
annotationListTitle:String  [read-write]

This is the text that is displayed in the title above the accordion in the AnnotationList.

The default value is "".

Implementation
    public function get annotationListTitle():String
    public function set annotationListTitle(value:String):void
annotationPanelproperty 
public var annotationPanel:AnnotationList

The annotation panel is the an AnnotationList component that is on the left side of the AnnotationModule. This is a Panel that contains the Accordion component to display the list of annotations and interacts with the AnnotatedDocument component inside this Module as well.

See also

assetDirectoryproperty 
assetDirectory:String  [read-write]

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).

The default value is "".

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

Implementation
    public function get assetDirectory():String
    public function set assetDirectory(value:String):void
autoAnnotationPauseDurationproperty 
autoAnnotationPauseDuration:uint  [read-write]

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

The default value is 400.

Implementation
    public function get autoAnnotationPauseDuration():uint
    public function set autoAnnotationPauseDuration(value:uint):void
autoLoadproperty 
public var autoLoad:Boolean = true

Whether or not to load the XML configuration file when the Module is created, based on the configDirectoryName and configFilename.

The default value is true.

configDirectoryNameproperty 
configDirectoryName:String  [read-write]

Directory name for the location of where the Module's configuration file is stored. The ending slash is automatically applied. The full path of the configuration directory will be:

assetDirectory/configDirectoryName/

The default value is "config/".

Implementation
    public function get configDirectoryName():String
    public function set configDirectoryName(value:String):void
configFilenameproperty 
configFilename:String  [read-write]

Filename for the configuration file for the AnnotationModule. Location of this file can be set with the configDirectoryName variable.

The default value is "config.xml".

Implementation
    public function get configFilename():String
    public function set configFilename(value:String):void
configXMLproperty 
configXML:XML  [read-write]

The contents of the loaded configuration XML file.

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.

detailCloseButtonLabelproperty 
detailCloseButtonLabel:String  [read-write]

This is the text for the button displayed when a detail for an annotation is displayed in the AnnotationList.

The default value is "Back to Annotation List".

Implementation
    public function get detailCloseButtonLabel():String
    public function set detailCloseButtonLabel(value:String):void
documentCSSproperty 
documentCSS:StyleSheet  [read-write]

This is the CSS document for the text field to diplsay the mainDocument. This will be for the html tags.

Implementation
    public function get documentCSS():StyleSheet
    public function set documentCSS(value:StyleSheet):void
hideAnnotationListDurationproperty 
hideAnnotationListDuration:uint  [read-write]

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

The default value is 400.

Implementation
    public function get hideAnnotationListDuration():uint
    public function set hideAnnotationListDuration(value:uint):void
hideAnnotationListEasingFunctionproperty 
hideAnnotationListEasingFunction:Function  [read-write]

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

The default value is Linear.easeIn.

Implementation
    public function get hideAnnotationListEasingFunction():Function
    public function set hideAnnotationListEasingFunction(value:Function):void
listWidthproperty 
listWidth:int  [read-write]Implementation
    public function get listWidth():int
    public function set listWidth(value:int):void
mainDocumentFilenameproperty 
mainDocumentFilename:String  [read-write]

Filename for the main annotated document HTML file for the AnnotationModule. Location of this file can be set with the annotationFilesDirectory variable. So the full path would be:

assetDirectory+annotationFilesDirectory+mainDocumentFilename

The default value is "document.html".

Implementation
    public function get mainDocumentFilename():String
    public function set mainDocumentFilename(value:String):void
mainDocumentTitleproperty 
mainDocumentTitle:String  [read-write]

The title to be displayed above the HTML file in the AnnotatedDocument.

The default value is "".

Implementation
    public function get mainDocumentTitle():String
    public function set mainDocumentTitle(value:String):void
Constructor detail
AnnotationModule()constructor
public function AnnotationModule()

Constructor.

Method detail
accordionSelectedIndexChange()method
protected function accordionSelectedIndexChange(e:AnnotationEvent):void

Changes the selectedIndex of the accordion in the AnnotationList based on an event from the AnnotatedDocument.

Parameters
e:AnnotationEvent
deInit()method 
public function deInit():void

Handles the removal of the Module by the ModuleInitializer.

detailLoaded()method 
public function detailLoaded(e:Event):void

Displays the detail in the AnnotationPanel after the detail is loaded.

Parameters
e:Event
documentLinkClickHandler()method 
protected function documentLinkClickHandler(e:TextEvent):void

Handles the click from an annotation in the AnnotationList.

Parameters
e:TextEvent — The event
getAnnotationAt()method 
public function getAnnotationAt(sectionIndex:uint, annotationIndex:uint):Annotation

Returns an Annotation object based on the section and annotation indicies.

Parameters
sectionIndex:uint — The section index relating to the position of the section in XML
 
annotationIndex:uint — The annotation index relating to the position of the annotation in a section in XML

Returns
Annotation
getAnnotationByID()method 
public function getAnnotationByID(id:String):Annotation

Returns an Annotation object based on id passed in.

Parameters
id:String — The id of the annotation in the XML

Returns
Annotation
getSectionAt()method 
public function getSectionAt(sectionIndex:uint):Object

Returns the section properties as on object based on the section index passed in.

Parameters
sectionIndex:uint — The section index relating to the position of the section in XML

Returns
Object
init()method 
public function init(initProperties:Object):void

Initiates the AnnotationModule to create most of its children, to be created or removed at any time by the ModuleInitializer.

Parameters
initProperties:Object
loadConfigError()method 
public function loadConfigError(e:FaultEvent):void

Alerts that there was an error loading the configXML.

Parameters
e:FaultEvent
loadConfigXML()method 
public function loadConfigXML():void

A way to load the configuration XML manually or if the autoLoad is set to false.

parseConfigXML()method 
public function parseConfigXML(e:ResultEvent):void

Handles the loaded XML file and saves the results into the configXML property.

Parameters
e:ResultEvent — The result from the HTTPService call
Event detail
deInitCompleteevent 
Event object type: at.events.AnnotationEvent
AnnotationEvent.type property = at.events.AnnotationEvent.DEINIT_COMPLETE

Dispatched when the deInit() method has completed.

The AnnotationEvent.DEINIT_COMPLETE constant defines the value of the type property of the event object for a deInitComplete event.

initCompleteevent  
Event object type: at.events.AnnotationEvent
AnnotationEvent.type property = at.events.AnnotationEvent.INIT_COMPLETE

Dispatched when the AnnotationModule has completed the init() method to instantiate all of the children on the Module, and added the event listeners.

The AnnotationEvent.INIT_COMPLETE constant defines the value of the type property of the event object for a initComplete event.

showAnnotationDetailevent  

Dispatched when the AnnotationList displays a detail.

showAnnotationListevent  

Dispatched when the AnnotationList displays the list of annotations.