Packageat.display
Classpublic class CrumbDisplay
InheritanceCrumbDisplay Inheritance mx.containers.HBox

The CrumbDisplay is a visual trail of the current path into the program. Often this is called a breadcrumb. The CrumbDisplay 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.
CrumbDisplay
  debugMode : Boolean = false
CrumbDisplay
  manager : HistoryManager
Getter method that returns the history manager instantiated by tha variable _manager.
CrumbDisplay
  preventSave : Boolean = false
Variable that holds preventSave value as boolean.
CrumbDisplay
  transitionInEffect : Effect
Instantiates an effect class as transitionInEffect.
CrumbDisplay
  transitionOutEffect : Effect
Instantiates an effect class as transitionOutEffect.
CrumbDisplay
  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 CrumbDisplay that was clicked.
CrumbDisplay
Public Methods
 MethodDefined by
  
Constructor.
CrumbDisplay
  
addCrumb(label:String, state:Object):void
Method that adds a crumb item to the breadcrumb display.
CrumbDisplay
  
addCrumbAt(index:int, label:String, state:Object):void
Method that adds a crumb item to the breadcrumb display at a specific index.
CrumbDisplay
  
destroy():void
Removes all children and event listeners from CrumbDisplay.
CrumbDisplay
  
Method that updates the breadcrumb display.
CrumbDisplay
Protected Methods
 MethodDefined by
  
Method for updating display of breadcrumbs.
CrumbDisplay
  
classConstruct():Boolean
[static] Static method for construction of style classes for breadcrumb display purposes.
CrumbDisplay
  
clickHandler(e:MouseEvent):void
Method for handling mouse click of breadcrumbs from the display.
CrumbDisplay
  
Method for committing properties of breadcrumbs.
CrumbDisplay
  
Method for creating children of the breadcrumb manager.
CrumbDisplay
  
invalideChildList(e:EffectEvent = null):void
Method for tracing out list of invalid breadcrumb children within debug mode.
CrumbDisplay
  
Method for loading state of application upon event HistoryChangedEvent.
CrumbDisplay
  
onManagerUpdateCrumbDisplay(e:Event = null):void
Method that calls the method updateCrumbDisplay.
CrumbDisplay
  
Method for starting transition in effect for breadcrumbs.
CrumbDisplay
  
Method for starting transition out effect for breadcrumbs.
CrumbDisplay
Events
 EventSummaryDefined by
    CrumbDisplay
    CrumbDisplay
    CrumbDisplay
    CrumbDisplay
Styles
 StyleDescriptionDefined by
  
breadDisplayItemStyleName
Type: String
This defines the styleName for the last button in the CrumbDisplay. The default value is "breadDisplayStyle".
CrumbDisplay
  
crumbDisplayItemStyleName
Type: String
This defines the styleName for the middle button(s) in the CrumbDisplay. The default value is "crumbDisplayStyle".
CrumbDisplay
  
homeDisplayItemStyleName
Type: String
This defines the styleName for the "Home" button in the CrumbDisplay. The default value is "homeDisplayStyle".
CrumbDisplay
Property detail
crumbChangeEffectproperty
public var crumbChangeEffect:Effect

Instantiates an effect class as crumbChangeEffect.

debugModeproperty 
public var debugMode:Boolean = false
managerproperty 
manager:HistoryManager  [read-write]

Getter method that returns the history manager instantiated by tha 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 CrumbDisplay that was clicked. If true, clicking only passes on the event of buttons, allowing custom click handling for special case code.

Constructor detail
CrumbDisplay()constructor
public function CrumbDisplay()

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
 
state:Object
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
 
label:String
 
state:Object
classConstruct()method 
protected static function classConstruct():Boolean

Static method for construction of style classes for breadcrumb display purposes.

Returns
Boolean
clickHandler()method 
protected function clickHandler(e:MouseEvent):void

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

Parameters
e:MouseEvent
commitProperties()method 
protected override function commitProperties():void

Method for committing properties of breadcrumbs.

createChildren()method 
protected override function createChildren():void

Method for creating children of the breadcrumb manager. Instantiates ApplicationCrumbManager as singleton.

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:HistoryChangedEventHistoryChangedEvent
onManagerUpdateCrumbDisplay()method 
protected function onManagerUpdateCrumbDisplay(e:Event = null):void

Method that calls the method updateCrumbDisplay.

Parameters
e:Event (default = null)
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