Packageat.display
Classpublic class BookmarkButtonBarNavigator
InheritanceBookmarkButtonBarNavigator Inheritance ButtonBarNavigator Inheritance mx.containers.VBox

The BookmarkButtonBarNavigator extends the ButtonBarNavigator to show a list of all the bookmarks for a call.

The component can accept any dataProvider but the easiest way to load the calls is to provide the callID. This will talk to the DataInterface and pull down the bookmarks for the current call.

The BookmarkButtonBarNavigator sets it's useNumbers property to true by default. This will set the label on the buttons to sequential numbers for the buttons, instead of using the labelField property. The buttonsPerRow is set by default to [100] to show all the bookmarks in a single row.

See also

at.display.ButtonBarNavigator


Public Properties
 PropertyDefined by
 InheritedbuttonHeight : Number = 25
Sets the height for all buttons.
ButtonBarNavigator
 InheritedbuttonList : Array
A list of all of the Buttons in the ButtonBarNavigator.
ButtonBarNavigator
 InheritedbuttonsPerRow : Array
Determines how many buttons will be displayed per row based on the values in an Array.
ButtonBarNavigator
  callID : int
The current call id for the current indication.
BookmarkButtonBarNavigator
 Inheritedcursor : IViewCursor
Cursor for the dataProvider.
ButtonBarNavigator
 InheriteddataProvider : Object
Data to be used for the control.
ButtonBarNavigator
 InheriteddebugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
ButtonBarNavigator
 InheritedenableButtons : Boolean
Returns whether all Buttons are enabled in the ButtonBarNavigator
ButtonBarNavigator
  labelField : String
BookmarkButtonBarNavigator
 InheritednavigationManager : INavigationManager
Instance of the INavigationManager class.
ButtonBarNavigator
 InheritednumRows : int
Read-only variable for the number of rows determined by the number of <row>s in the navXML XMLList.
ButtonBarNavigator
 InheritedrowList : Array
A list of all of the rows in the ButtonBarNavigator.
ButtonBarNavigator
 Inheritedselectable : Boolean
When true only one button can be selected at a time.
ButtonBarNavigator
 InheritedselectedChild : DisplayObject
Sets the selected Button by DisplayObject.
ButtonBarNavigator
 InheritedselectedIndex : int
Sets the selected property to the button at the index supplied.
ButtonBarNavigator
 InheritedselectedItem : Object
The data from the currently selected Button in the component.
ButtonBarNavigator
 InheritedspacerList : Array
A list of all of the Spacer's created, if the attribute "buttonBarVisualSpaceAfter" is set.
ButtonBarNavigator
 InheriteduseDefaultNavigationBehavior : Boolean
ButtonBarNavigator
  useNumbers : Boolean = true
Tells the buttons to use numbers to identify the label of the button.
BookmarkButtonBarNavigator
 InheritedvalidateNavigation : Boolean = true
If set to true, buttons automatically disable if they violate a navigation business constraint.
ButtonBarNavigator
Protected Properties
 PropertyDefined by
  numbersUsed : Boolean = false
A flag to determine if numbers were used, and not to set them again
BookmarkButtonBarNavigator
Public Methods
 MethodDefined by
  
Constructor.
BookmarkButtonBarNavigator
 Inherited
collectionChangeHandler(e:CollectionEvent):void
Updates the label if the property in the dataProvider changes.
ButtonBarNavigator
 Inherited
destroy():void
Removes the event listeners and all of the buttons and rows inside of this component.
ButtonBarNavigator
 Inherited
setSelected(value:Object):void
This method sets currently selected button's property selected to true, while setting false to all other buttons if selectable is true.
ButtonBarNavigator
Protected Methods
 MethodDefined by
  
buttonClickHandler(e:MouseEvent):void
Overrides ButtonBarNavigator's buttonClickHandler.
BookmarkButtonBarNavigator
 Inherited
Creates the entire button navigation.
ButtonBarNavigator
 Inherited
Handles navigation changes if not by clicking on a button.
ButtonBarNavigator
 Inherited
Handles a navigation change event when a navigationManager is set.
ButtonBarNavigator
Events
 EventSummaryDefined by
 Inherited Dispatched when an button was clicked.ButtonBarNavigator
 Inherited Dispatched when all of the buttons have been created based on a new dataProvider.ButtonBarNavigator
 Inherited Dispatched when an button has been selected.ButtonBarNavigator
 Inherited Dispatched when the user clicks on an item in the control.ButtonBarNavigator
Styles
 StyleDescriptionDefined by
 Inherited Type: String   CSS Inheritance: no
This defines the styleName for each button.
ButtonBarNavigator
 Inherited Type: String   CSS Inheritance: no
This defines the styleName for each of the row(s) of buttons.
ButtonBarNavigator
 Inherited Type: int
The amout of padding in pixels horizontally between each Button.
ButtonBarNavigator
 Inherited Type: uint
When a Button's selected property is true, the Button defaults to the normal text color for the control.
ButtonBarNavigator
 Inherited Type: int
The amout of padding in pixels vertically between each row of Buttons.
ButtonBarNavigator
Property detail
callIDproperty
callID:int  [read-write]

The current call id for the current indication.

The default value is -1.

Implementation
    public function get callID():int
    public function set callID(value:int):void
labelFieldproperty 
labelField:String  [read-write]Implementation
    public function get labelField():String
    public function set labelField(value:String):void
numbersUsedproperty 
protected var numbersUsed:Boolean = false

A flag to determine if numbers were used, and not to set them again

The default value is false.

useNumbersproperty 
public var useNumbers:Boolean = true

Tells the buttons to use numbers to identify the label of the button.

When set to true the buttons will ignore labelField property to set the label for the buttons. Instead they will count 1 - n as the label for the buttons.

The default value is true.

Constructor detail
BookmarkButtonBarNavigator()constructor
public function BookmarkButtonBarNavigator()

Constructor.

Method detail
buttonClickHandler()method
protected override function buttonClickHandler(e:MouseEvent):void

Overrides ButtonBarNavigator's buttonClickHandler. Executed when a button is clicked.

If useDefaultNavigationBehavior is true, one of the two possible scenarios will follow:

Both of these scenarios dispatched an item click event when a button is clicked and the associated slide (and subsequent sub-list if applicable) is in the ITEM_CLICK event's item property

Parameters
e:MouseEvent — The event