| Package | at.display |
| Class | public class BookmarkButtonBarNavigator |
| Inheritance | BookmarkButtonBarNavigator  ButtonBarNavigator mx.containers.VBox |
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
| Property | Defined by | ||
|---|---|---|---|
 | buttonHeight : Number = 25
Sets the height for all buttons.
| ButtonBarNavigator | |
| buttonList : Array
A list of all of the Buttons in the
ButtonBarNavigator. | ButtonBarNavigator | |
| buttonsPerRow : 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 | ||
| cursor : IViewCursor
Cursor for the dataProvider.
| ButtonBarNavigator | |
| dataProvider : Object
Data to be used for the control.
| ButtonBarNavigator | |
| debugMode : Boolean = false
Outputs useful information for debugging this component for developers when
true. | ButtonBarNavigator | |
| enableButtons : Boolean
Returns whether all
Buttons are enabled in the ButtonBarNavigator
| ButtonBarNavigator | |
| labelField : String | BookmarkButtonBarNavigator | ||
| navigationManager : INavigationManager
Instance of the
INavigationManager class. | ButtonBarNavigator | |
| numRows : int
Read-only variable for the number of rows determined by the number of
<row>s in the navXML XMLList. | ButtonBarNavigator | |
| rowList : Array
A list of all of the rows in the
ButtonBarNavigator. | ButtonBarNavigator | |
| selectable : Boolean
When
true only one button can be selected at a time. | ButtonBarNavigator | |
| selectedChild : DisplayObject
Sets the selected
Button by DisplayObject. | ButtonBarNavigator | |
| selectedIndex : int
Sets the
selected property to the button at the index supplied. | ButtonBarNavigator | |
| selectedItem : Object
The
data from the currently selected Button in
the component. | ButtonBarNavigator | |
| spacerList : Array
A list of all of the
Spacer's created, if the attribute
"buttonBarVisualSpaceAfter" is set. | ButtonBarNavigator | |
| useDefaultNavigationBehavior : Boolean | ButtonBarNavigator | |
| useNumbers : Boolean = true
Tells the buttons to use numbers to identify the
label
of the button. | BookmarkButtonBarNavigator | ||
| validateNavigation : Boolean = true
If set to true, buttons automatically disable if they violate a navigation business constraint.
| ButtonBarNavigator | |
| Property | Defined by | ||
|---|---|---|---|
| numbersUsed : Boolean = false
A flag to determine if numbers were used, and not to
set them again
| BookmarkButtonBarNavigator | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| BookmarkButtonBarNavigator | ||
|
collectionChangeHandler(e:CollectionEvent):void
Updates the
label if the property in the
dataProvider changes. | ButtonBarNavigator | |
|
destroy():void
Removes the event listeners and all of the buttons and rows inside of
this component.
| ButtonBarNavigator | |
|
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 | |
| Method | Defined by | ||
|---|---|---|---|
|
buttonClickHandler(e:MouseEvent):void
Overrides
ButtonBarNavigator's buttonClickHandler. | BookmarkButtonBarNavigator | ||
|
createNavigation():void
Creates the entire button navigation.
| ButtonBarNavigator | |
|
externalChange(e:NavigationChangeEvent):void
Handles navigation changes if not by clicking on a button.
| ButtonBarNavigator | |
|
Handles a navigation change event when a
navigationManager is set. | ButtonBarNavigator | |
| callID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescallID:int [read-write]The current call id for the current indication.
The default value is -1.
public function get callID():int
public function set callID(value:int):void
| labelField | property |
labelField:String [read-write]Implementation
public function get labelField():String
public function set labelField(value:String):void
| numbersUsed | property |
protected var numbersUsed:Boolean = falseA flag to determine if numbers were used, and not to set them again
The default value is false.
| useNumbers | property |
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.
| BookmarkButtonBarNavigator | () | constructor |
public function BookmarkButtonBarNavigator()Constructor.
| 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:
MultiPathNavigationManager (extends SlideManager),
the button's associated slide XML (or sub XMLList) is given to the
supplied MultiPathNavigationManger's navigateToOffShoot()
method. Navigation validation is NOT applied in this instance, since the bookmark's
availability is assumed to always be present (if this is not the case, you can
use each of bookmarkBar button's associated slide xml with navigation's
currentNode, and pass to NavigationChangeValidator.validateChange
method if you want to disable any bookmark buttons based on valid navigation).navigationManager is type SlideManager, It uses the
SlideManager.navigateTo() method which navigates to the first slide with
matching dbid attribute of the associated slide node
or if it has a sub-list, uses the dbid attribute of the slide's first
child xml node in its sublist.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
e:MouseEvent — The event
|