Packagecom.flexicious.components
Classpublic class BreadCrumb
InheritanceBreadCrumb Inheritance mx.containers.HBox

A class that draws a stack of links to demonstrate a breadcrumb control.


Public Properties
 PropertyDefined By
  atMax : Boolean
[read-only] Returns true if the maxDepth has been reached
BreadCrumb
  atRoot : Boolean
[read-only] Returns true if the root breadcrumb is the only one active
BreadCrumb
  breadCrumbSeperatorCharacter : String = >
Character that seperates the breadcrumbs.
BreadCrumb
  dataField : String = data
The property on the dataprovider that should be used as the code value for the breadcrumb.
BreadCrumb
  dataProvider : Array
A list of objects that have the labelField and dataField properties.
BreadCrumb
  empty : Boolean
[read-only] Returns true if there are no breadcrumbs
BreadCrumb
  itemRenderer : IFactory
The item renderer for each of the clickable links in the breadcrumbs.
BreadCrumb
  labelField : String = label
The property on the dataprovider that should map to the text of the labels
BreadCrumb
  labelFunction : Function = null
A function that determines the text to display on the breadcrumb.
BreadCrumb
  maxDepth : int
[read-only] The maximum number of breadcrumbs that can be added to this list
BreadCrumb
Public Methods
 MethodDefined By
  
getAllPopups():Array
Gets a list of all Popup Children
BreadCrumb
  
getBreadCrumbs():Array
Gets all the instantiated breadcrumbs
BreadCrumb
  
popTo(item:*, useDataField:Boolean = false):Boolean
Removes all breadcrumbs upto the specified item
BreadCrumb
  
popupToPopup(item:*):void
Removes all the popups opened after the passed in one in the popup list
BreadCrumb
  
push(nv:Object):void
Adds a breadcrumb to the list
BreadCrumb
  
rebuild():void
Redraws all the breadcrumbs
BreadCrumb
  
removeAllPopups():void
Gets a list of all Popup Children
BreadCrumb
  
reset():void
Removes all the breadcrumbs
BreadCrumb
Events
 Event Summary Defined By
  
breadCrumbClick
Dispatched when the user clicks on a breadcrumb.BreadCrumb
  
breadCrumbRemove
Dispatched when all the breadcrumbs are about to be destroyed.BreadCrumb
  
breadCrumbsBuilt
Dispatched when all the breadcrumbs have been built.BreadCrumb
Styles
 Style Description Defined By
  
breadCrumbOverStyleName
Type: String CSS Inheritance: no
Style to apply to each of the breadcrumbs on mouse over 		BreadCrumb
  
breadCrumbStyleName
Type: String CSS Inheritance: no
Style to apply to each of the breadcrumbs 		BreadCrumb
Property Detail
atMaxproperty
atMax:Boolean  [read-only]

Returns true if the maxDepth has been reached

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


Implementation
    public function get atMax():Boolean
atRootproperty 
atRoot:Boolean  [read-only]

Returns true if the root breadcrumb is the only one active

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


Implementation
    public function get atRoot():Boolean
breadCrumbSeperatorCharacterproperty 
public var breadCrumbSeperatorCharacter:String = >

Character that seperates the breadcrumbs. Defaults to '> '

dataFieldproperty 
public var dataField:String = data

The property on the dataprovider that should be used as the code value for the breadcrumb. This value is then used when you call the popTo method passing in a parameter to use the dataField

dataProviderproperty 
dataProvider:Array

A list of objects that have the labelField and dataField properties.

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


Implementation
    public function get dataProvider():Array
    public function set dataProvider(value:Array):void
emptyproperty 
empty:Boolean  [read-only]

Returns true if there are no breadcrumbs

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


Implementation
    public function get empty():Boolean
itemRendererproperty 
public var itemRenderer:IFactory

The item renderer for each of the clickable links in the breadcrumbs.

labelFieldproperty 
public var labelField:String = label

The property on the dataprovider that should map to the text of the labels

labelFunctionproperty 
public var labelFunction:Function = null

A function that determines the text to display on the breadcrumb.

maxDepthproperty 
maxDepth:int  [read-only]

The maximum number of breadcrumbs that can be added to this list

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


Implementation
    public function get maxDepth():int
Method Detail
getAllPopups()method
public function getAllPopups():Array

Gets a list of all Popup Children

Returns
Array
getBreadCrumbs()method 
public function getBreadCrumbs():Array

Gets all the instantiated breadcrumbs

Returns
Array
popTo()method 
public function popTo(item:*, useDataField:Boolean = false):Boolean

Removes all breadcrumbs upto the specified item

Parameters

item:*
 
useDataField:Boolean (default = false)

Returns
Boolean
popupToPopup()method 
public function popupToPopup(item:*):void

Removes all the popups opened after the passed in one in the popup list

Parameters

item:*

push()method 
public function push(nv:Object):void

Adds a breadcrumb to the list

Parameters

nv:Object

rebuild()method 
public function rebuild():void

Redraws all the breadcrumbs

removeAllPopups()method 
public function removeAllPopups():void

Gets a list of all Popup Children

reset()method 
public function reset():void

Removes all the breadcrumbs

Event Detail
breadCrumbClick Event
Event Object Type: com.flexicious.events.BreadCrumbEvent

Dispatched when the user clicks on a breadcrumb.

breadCrumbRemove Event  
Event Object Type: com.flexicious.events.BreadCrumbEvent

Dispatched when all the breadcrumbs are about to be destroyed.

breadCrumbsBuilt Event  
Event Object Type: com.flexicious.events.BreadCrumbEvent

Dispatched when all the breadcrumbs have been built. These can then be accessed using the getBreadCrumbs method.




Copyright 2012 Flexicious LLC. All rights reserved.

Mon Jun 24 2013, 11:00 PM -04:00