Package | at.display |
Class | public class CrumbDisplay |
Inheritance | CrumbDisplay ![]() |
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.
Property | Defined 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 |
Method | Defined 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 | ||
updateCrumbDisplay():void
Method that updates the breadcrumb display.
| CrumbDisplay |
Method | Defined by | ||
---|---|---|---|
_updateDisplay():void
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 | ||
commitProperties():void
Method for committing properties of breadcrumbs.
| CrumbDisplay | ||
createChildren():void
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 | ||
onHistoryChanged(e:HistoryChangedEvent):void
Method for loading state of application upon event
HistoryChangedEvent . | CrumbDisplay | ||
onManagerUpdateCrumbDisplay(e:Event = null):void
Method that calls the method
updateCrumbDisplay . | CrumbDisplay | ||
startTransitionIn():void
Method for starting transition in effect for breadcrumbs.
| CrumbDisplay | ||
startTransitionOut():void
Method for starting transition out effect for breadcrumbs.
| CrumbDisplay |
Event | Summary | Defined by | ||
---|---|---|---|---|
CrumbDisplay | ||||
CrumbDisplay | ||||
CrumbDisplay | ||||
CrumbDisplay |
crumbChangeEffect | property |
public var crumbChangeEffect:Effect
Instantiates an effect class as crumbChangeEffect
.
debugMode | property |
public var debugMode:Boolean = false
manager | property |
manager:HistoryManager
[read-write]
Getter method that returns the history manager instantiated by tha variable _manager
.
public function get manager():HistoryManager
public function set manager(value:HistoryManager):void
preventSave | property |
public var preventSave:Boolean = false
Variable that holds preventSave
value as boolean.
The default value is false
.
transitionInEffect | property |
public var transitionInEffect:Effect
Instantiates an effect class as transitionInEffect
.
transitionOutEffect | property |
public var transitionOutEffect:Effect
Instantiates an effect class as transitionOutEffect
.
useDefaultClickBehavior | property |
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.
CrumbDisplay | () | constructor |
public function CrumbDisplay()
Constructor.
_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.
Parameterslabel: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.
Parametersindex:int |
|
label:String |
|
state:Object |
classConstruct | () | method |
protected static function classConstruct():Boolean
Static method for construction of style classes for breadcrumb display purposes.
ReturnsBoolean |
clickHandler | () | method |
protected function clickHandler(e:MouseEvent):void
Method for handling mouse click of breadcrumbs from the display. Dispatches ItemClickEvent
.
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.
Parameterse:EffectEvent (default = null ) — EffectEvent
|
onHistoryChanged | () | method |
protected function onHistoryChanged(e:HistoryChangedEvent):void
Method for loading state of application upon event HistoryChangedEvent
.
e:HistoryChangedEvent — HistoryChangedEvent
|
onManagerUpdateCrumbDisplay | () | method |
protected function onManagerUpdateCrumbDisplay(e:Event = null):void
Method that calls the method updateCrumbDisplay
.
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.
changeTransitionIn | event |
changeTransitionOut | event |
historyChanged | event |
historyItemAdded | event |