Packageat.display
Classpublic class BreadcrumbDisplay
InheritanceBreadcrumbDisplay Inheritance mx.containers.HBox

The BreadcrumbDisplay is a visual trail of the current path into the program. Often this is called a breadcrumb. The BreadcrumbDisplay is made of Buttons surrounded in an HBox. It requires a HistoryManager to operate correctly.



Public Properties
 PropertyDefined by
  crumbChangeEffect : Effect
Instantiates an effect class as crumbChangeEffect.
BreadcrumbDisplay
  debugMode : Boolean = false
BreadcrumbDisplay
  manager : HistoryManager
The historyManager instantiated by the variable _manager.
BreadcrumbDisplay
  preventSave : Boolean = false
Variable that holds preventSave value as boolean.
BreadcrumbDisplay
  transitionInEffect : Effect
Instantiates an effect class as transitionInEffect.
BreadcrumbDisplay
  transitionOutEffect : Effect
Instantiates an effect class as transitionOutEffect.
BreadcrumbDisplay
  useDefaultClickBehavior : Boolean = true
A switch that if left to it's default state of false, jumps to the state of the associated button in the BreadcrumbDisplay that was clicked.
BreadcrumbDisplay
Protected Properties
 PropertyDefined by
  isInvalid : Boolean = false
Hold the isInvalid value as boolean.
BreadcrumbDisplay
Public Methods
 MethodDefined by
  
Constructor.
BreadcrumbDisplay
  
addCrumb(label:String, state:Object):void
Method that adds a crumb item to the breadcrumb display.
BreadcrumbDisplay
  
addCrumbAt(index:int, label:String, state:Object):void
Method that adds a crumb item to the breadcrumb display at a specific index.
BreadcrumbDisplay
  
destroy():void
Removes all children and event listeners from CrumbDisplay.
BreadcrumbDisplay
  
Method that updates the breadcrumb display.
BreadcrumbDisplay
Protected Methods
 MethodDefined by
  
Method for updating display of breadcrumbs.
BreadcrumbDisplay
  
clickHandler(e:MouseEvent):void
Method for handling mouse click of breadcrumbs from the display.
BreadcrumbDisplay
  
invalideChildList(e:EffectEvent = null):void
Method for tracing out list of invalid breadcrumb children within debug mode.
BreadcrumbDisplay
  
Method for loading state of application upon event HistoryChangedEvent.
BreadcrumbDisplay
  
onManagerUpdateCrumbDisplay(e:Event = null):void
Method that calls the method updateCrumbDisplay.
BreadcrumbDisplay
  
Method for starting transition in effect for breadcrumbs.
BreadcrumbDisplay
  
Method for starting transition out effect for breadcrumbs.
BreadcrumbDisplay
Events
 EventSummaryDefined by
    BreadcrumbDisplay
    BreadcrumbDisplay
    BreadcrumbDisplay
    BreadcrumbDisplay
Styles
 StyleDescriptionDefined by
  
breadDisplayItemStyleName
Type: String
This defines the styleName for the last button in the BreadcrumbDisplay. The default value is "breadDisplayStyle".
BreadcrumbDisplay
  
crumbDisplayItemStyleName
Type: String
This defines the styleName for the middle button(s) in the BreadcrumbDisplay. The default value is "crumbDisplayStyle".
BreadcrumbDisplay
  
homeDisplayItemStyleName
Type: String
This defines the styleName for the "Home" button in the BreadcrumbDisplay. The default value is "homeDisplayStyle".
BreadcrumbDisplay
Property detail
crumbChangeEffectproperty
public var crumbChangeEffect:Effect

Instantiates an effect class as crumbChangeEffect.

The default value is null.

debugModeproperty 
public var debugMode:Boolean = false
isInvalidproperty 
protected var isInvalid:Boolean = false

Hold the isInvalid value as boolean.

The default value is false.

managerproperty 
manager:HistoryManager  [read-write]

The historyManager instantiated by the variable _manager.

Implementation
    public function get manager():HistoryManager
    public function set manager(value:HistoryManager):void
preventSaveproperty 
public var preventSave:Boolean = false

Variable that holds preventSave value as boolean.

The default value is false.

transitionInEffectproperty 
public var transitionInEffect:Effect

Instantiates an effect class as transitionInEffect.

transitionOutEffectproperty 
public var transitionOutEffect:Effect

Instantiates an effect class as transitionOutEffect.

useDefaultClickBehaviorproperty 
public var useDefaultClickBehavior:Boolean = true

A switch that if left to it's default state of false, jumps to the state of the associated button in the BreadcrumbDisplay that was clicked. If true, clicking only passes on the event of buttons, allowing custom click handling for special case code.

Constructor detail
BreadcrumbDisplay()constructor
public function BreadcrumbDisplay()

Constructor.

Method detail
_updateDisplay()method
protected function _updateDisplay():void

Method for updating display of breadcrumbs.

addCrumb()method 
public function addCrumb(label:String, state:Object):void

Method that adds a crumb item to the breadcrumb display.

Parameters
label:String — The label for the button
 
state:Object — The state the button will navigate to
addCrumbAt()method 
public function addCrumbAt(index:int, label:String, state:Object):void

Method that adds a crumb item to the breadcrumb display at a specific index.

Parameters
index:int — The index in the list for the crumb
 
label:String — The label for the button
 
state:Object — The state the button will navigate to
clickHandler()method 
protected function clickHandler(e:MouseEvent):void

Method for handling mouse click of breadcrumbs from the display. Dispatches ItemClickEvent.

Parameters
e:MouseEvent — The mouse event
destroy()method 
public function destroy():void

Removes all children and event listeners from CrumbDisplay.

invalideChildList()method 
protected function invalideChildList(e:EffectEvent = null):void

Method for tracing out list of invalid breadcrumb children within debug mode.

Parameters
e:EffectEvent (default = null)EffectEvent
onHistoryChanged()method 
protected function onHistoryChanged(e:HistoryChangedEvent):void

Method for loading state of application upon event HistoryChangedEvent.

Parameters
e:HistoryChangedEvent — The HistoryChangedEvent
onManagerUpdateCrumbDisplay()method 
protected function onManagerUpdateCrumbDisplay(e:Event = null):void

Method that calls the method updateCrumbDisplay.

Parameters
e:Event (default = null) — The event
startTransitionIn()method 
protected function startTransitionIn():void

Method for starting transition in effect for breadcrumbs.

startTransitionOut()method 
protected function startTransitionOut():void

Method for starting transition out effect for breadcrumbs.

updateCrumbDisplay()method 
public function updateCrumbDisplay():void

Method that updates the breadcrumb display.

Event detail
changeTransitionInevent 
changeTransitionOutevent  
historyChangedevent  
historyItemAddedevent