Packageat.display
Classpublic class AnnotatedDocument
InheritanceAnnotatedDocument Inheritance mx.containers.VBox

Part of the AnnotationModule that shows the availble annotations from a configuration XML file loaded in to the Module. This component talks to the Module and the AnnotatedDocument in the Module.

See also

at.modules.AnnotationModule


Public Properties
 PropertyDefined by
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
AnnotatedDocument
  documentCSS : StyleSheet
This is the CSS document for the text field to diplsay the mainDocument.
AnnotatedDocument
  documentURL : String
The url for the html file that will be loaded in.
AnnotatedDocument
  mainDocumentHTML : String
The holder for the html that is loaded in to be displayed in as htmlText in the component's TextArea.
AnnotatedDocument
  mainDocumentTitle : String
The text to be displayed in the documentTitle Label.
AnnotatedDocument
Protected Properties
 PropertyDefined by
  annotationHighlights : Highlighter
The highlighter for the TextArea.
AnnotatedDocument
  currentAnnotationHighlight : Highlighter
The currently selected highlighted annotation.
AnnotatedDocument
  documentTextArea : TextArea
The TextArea where the mainDocumentHTML is loaded in as htmlText.
AnnotatedDocument
  documentTitle : Label
The Label to display the title above the html document.
AnnotatedDocument
  httpService : HTTPService
Loads the html file.
AnnotatedDocument
Public Methods
 MethodDefined by
  
Constructor.
AnnotatedDocument
  
getAnnotationText(annotationID:String):String
Returns the text of the annotation based on an id found in an anchor tag.
AnnotatedDocument
  
highlightAnnotation(annotationID:String, customHighlighter:Highlighter = null):Boolean
Highlights the annotation based on a secified attribute in an anchor tag and a passed in highlighter.
AnnotatedDocument
  
Highlights all of the annotations in the TextArea.
AnnotatedDocument
  
load():Boolean
Loads the html file into the component.
AnnotatedDocument
  
setCurrentAnnotation(annotationID:String):Boolean
Sets the currently selected annotation to the passed in id.
AnnotatedDocument
Protected Methods
 MethodDefined by
  
getAnnotations():XMLList
Returns a list of all of the anchor tags in the loaded html document.
AnnotatedDocument
Styles
 StyleDescriptionDefined by
  
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.
AnnotatedDocument
  
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.
AnnotatedDocument
Property detail
annotationHighlightsproperty
protected var annotationHighlights:Highlighter

The highlighter for the TextArea.

currentAnnotationHighlightproperty 
protected var currentAnnotationHighlight:Highlighter

The currently selected highlighted annotation.

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.

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
documentTextAreaproperty 
protected var documentTextArea:TextArea

The TextArea where the mainDocumentHTML is loaded in as htmlText.

documentTitleproperty 
protected var documentTitle:Label

The Label to display the title above the html document.

documentURLproperty 
documentURL:String  [read-write]

The url for the html file that will be loaded in.

The default value is null.

Implementation
    public function get documentURL():String
    public function set documentURL(value:String):void
httpServiceproperty 
protected var httpService:HTTPService

Loads the html file.

mainDocumentHTMLproperty 
mainDocumentHTML:String  [read-write]

The holder for the html that is loaded in to be displayed in as htmlText in the component's TextArea.

The default value is null.

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

The text to be displayed in the documentTitle Label.

The default value is "".

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

Constructor.

Method detail
getAnnotations()method
protected function getAnnotations():XMLList

Returns a list of all of the anchor tags in the loaded html document.

Returns
XMLList
getAnnotationText()method 
public function getAnnotationText(annotationID:String):String

Returns the text of the annotation based on an id found in an anchor tag.

Parameters
annotationID:Stringid of an attribute in an anchor tag

Returns
String
highlightAnnotation()method 
public function highlightAnnotation(annotationID:String, customHighlighter:Highlighter = null):Boolean

Highlights the annotation based on a secified attribute in an anchor tag and a passed in highlighter.

Parameters
annotationID:Stringid of an attribute in an anchor tag
 
customHighlighter:Highlighter (default = null) — A Highligher object

Returns
Boolean
highlightAnnotations()method 
public function highlightAnnotations():Boolean

Highlights all of the annotations in the TextArea.

Returns
Boolean
load()method 
public function load():Boolean

Loads the html file into the component.

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

Sets the currently selected annotation to the passed in id.

Parameters
annotationID:Stringid of an attribute in an anchor tag

Returns
Boolean