Packageat.display
Classpublic class ImageNavigator
InheritanceImageNavigator Inheritance mx.containers.Box
ImplementsINavigationUIDataChange

The ImageNavigator class is a INavigationUI component that requires a navigation dataProvider to operate.

This can be combined with a navigationManager to automatically handle navigation.

Default MXML PropertydataProvider

See also

at.display.INavigationUIDataChange


Public Properties
 PropertyDefined by
  columnWidth : Number
The width of the image, plus any desired padding for the image.
ImageNavigator
  cursor : IViewCursor
Cursor for the dataProvider.
ImageNavigator
  dataProvider : Object
Data to be used for the control.
ImageNavigator
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
ImageNavigator
  disableOrHideButtons : String
When set to disable, the next and previous Buttons will be enabled/disabled when they can be used to click to display more items in the list, based on the number of items in the list.
ImageNavigator
  displayOrder : String
Sets the order in which the previousButton, nextButton and imageList are displayed.
ImageNavigator
  imageCount : uint
Number of images to be displayed.
ImageNavigator
  imageList : ImageTileList
TileList for the image tiles.
ImageNavigator
  itemRenderer : IFactory
[write-only] The itemRenderer for the component.
ImageNavigator
  navigationManager : INavigationManager
Instance of the INavigationManager class.
ImageNavigator
  nextButton : Button
Next button.
ImageNavigator
  numItems : int
[read-only] The number of items in the current dataProvider.
ImageNavigator
  previousButton : Button
Previous button.
ImageNavigator
  rowHeight : Number
The height of the image, plus any desired padding for the image.
ImageNavigator
  selectedChild : DisplayObject
The selected image in the component.
ImageNavigator
  selectedIndex : int
Highlights the specified index in the list.
ImageNavigator
  selectedItem : Object
The data from the currently selected image in the component.
ImageNavigator
  selectionVisible : Boolean
Determines whether or not the selectionLayer is visible in each of the TileList items.
ImageNavigator
  updateOnExternalNavigation : Boolean
When navigating, a navigation manager changes sections as it navigates.
ImageNavigator
  useDefaultNavigationBehavior : Boolean
ImageNavigator
Protected Properties
 PropertyDefined by
  currentPage : int
The current page of images in the TileList.
ImageNavigator
Public Methods
 MethodDefined by
  
Constructor.
ImageNavigator
  
destroy():void
Removes all event listeners and removes all children.
ImageNavigator
  
Sets the current section based on a navigation event.
ImageNavigator
Protected Methods
 MethodDefined by
  
clickHandler(e:ListEvent):void
Handles the click from the list of items, it talks to the navigationManager and requests the clicked item index.
ImageNavigator
  
viewNextGroup(e:MouseEvent = null):void
Handler for the click of the Next Button by setting the currentPosition.
ImageNavigator
  
viewPrevGroup(e:MouseEvent):void
Handler for the click for the previousButton by setting the scroll index in the list.
ImageNavigator
Events
 EventSummaryDefined by
   Dispatched when an item was clicked.ImageNavigator
   Dispatched when an image has been selected.ImageNavigator
   Dispatched when the user clicks on an item in the control.ImageNavigator
Styles
 StyleDescriptionDefined by
  
nextButtonStyleName
Type: String   CSS Inheritance: no
Specifies the styleName for the nextButton button. The default value is "nextButtonStyle".
ImageNavigator
  
previousButtonStyleName
Type: String   CSS Inheritance: no
Specifies the styleName for the previousButton button. The default value is "previousButtonStyle".
ImageNavigator
  
tileListStyleName
Type: String   CSS Inheritance: no
Specifies the styleName for the TileList. The default value is "tileListStyle".
ImageNavigator
Property detail
columnWidthproperty
columnWidth:Number  [read-write]

The width of the image, plus any desired padding for the image.

The default value is 100.

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

Implementation
    public function get columnWidth():Number
    public function set columnWidth(value:Number):void
currentPageproperty 
currentPage:int  [read-write]

The current page of images in the TileList.

Implementation
    protected function get currentPage():int
    protected function set currentPage(value:int):void
cursorproperty 
public var cursor:IViewCursor

Cursor for the dataProvider.

dataProviderproperty 
dataProvider:Object  [read-write]

Data to be used for the control.

The image to be used is specified in the imageNavigatorThumbnailFilename property.

The default value is null.

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

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void

Example
   <slide imageNavigatorThumbnailFilename="path/to/thumbnail/patient1.jpg" />
   <slide imageNavigatorThumbnailFilename="path/to/thumbnail/patient2.png" />
   <slide imageNavigatorThumbnailFilename="path/to/thumbnail/patient3.png" />
   

debugModeproperty 
public var debugMode:Boolean = false

Outputs useful information for debugging this component for developers when true.

The output is typically in the form of trace statements and Alerts.

The default value is false.

disableOrHideButtonsproperty 
disableOrHideButtons:String  [read-write]

When set to disable, the next and previous Buttons will be enabled/disabled when they can be used to click to display more items in the list, based on the number of items in the list. The default value is hide which will hide the next and previous Buttons when they cannot be used to click.

The default value is "hide".

Implementation
    public function get disableOrHideButtons():String
    public function set disableOrHideButtons(value:String):void
displayOrderproperty 
displayOrder:String  [read-write]

Sets the order in which the previousButton, nextButton and imageList are displayed.

The default value is "prevListNext".

Implementation
    public function get displayOrder():String
    public function set displayOrder(value:String):void

See also

ImageNavigatorDisplayOrder
imageCountproperty 
imageCount:uint  [read-write]

Number of images to be displayed. The ImageNavigator will show this number or less, given the number of images in the currently selected section.

The default value is 4.

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

Implementation
    public function get imageCount():uint
    public function set imageCount(value:uint):void
imageListproperty 
public var imageList:ImageTileList

TileList for the image tiles.

itemRendererproperty 
itemRenderer:IFactory  [write-only]

The itemRenderer for the component.

The default for this component is at.display.ImageNavigatorItemRenderer.

Implementation
    public function set itemRenderer(value:IFactory):void

See also

navigationManagerproperty 
navigationManager:INavigationManager  [read-write]

Instance of the INavigationManager class. Adding the SlideManager allows for the button bar to navigate. The SlideManager typically is referenced from a PresentationModule.

Implementation
    public function get navigationManager():INavigationManager
    public function set navigationManager(value:INavigationManager):void

See also

at.display.PresentationModule
nextButtonproperty 
public var nextButton:Button

Next button. Clicking will display the next set of images based on the imageCount Will only be visible if there is an available number of images.

numItemsproperty 
numItems:int  [read-only]

The number of items in the current dataProvider.

The default value is 0.

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

Implementation
    public function get numItems():int
previousButtonproperty 
public var previousButton:Button

Previous button. Clicking will display the previous set of images based on the imageCount. Will only be visible if there is an available number of images.

rowHeightproperty 
rowHeight:Number  [read-write]

The height of the image, plus any desired padding for the image.

The default value is 75.

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

Implementation
    public function get rowHeight():Number
    public function set rowHeight(value:Number):void
selectedChildproperty 
selectedChild:DisplayObject  [read-write]

The selected image in the component.

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

Implementation
    public function get selectedChild():DisplayObject
    public function set selectedChild(value:DisplayObject):void
selectedIndexproperty 
selectedIndex:int  [read-write]

Highlights the specified index in the list.

The default value is -1.

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

Implementation
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void
selectedItemproperty 
selectedItem:Object  [read-write]

The data from the currently selected image in the component.

The default value is null.

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

Implementation
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void
selectionVisibleproperty 
selectionVisible:Boolean  [read-write]

Determines whether or not the selectionLayer is visible in each of the TileList items.

The selectionLayer is a protected property in the TileList. To determine whether or not something is selected, this is drawn behind the object. This setting is false by default, meaning this indicator is hidden from view.

The default value is false.

Implementation
    public function get selectionVisible():Boolean
    public function set selectionVisible(value:Boolean):void
updateOnExternalNavigationproperty 
updateOnExternalNavigation:Boolean  [read-write]

When navigating, a navigation manager changes sections as it navigates. If true the ImageNavigator will automatically update navXML with the current section. If false it will not update, ensuring it keeps the navXML loaded into it.

The default value is false.

Implementation
    public function get updateOnExternalNavigation():Boolean
    public function set updateOnExternalNavigation(value:Boolean):void
useDefaultNavigationBehaviorproperty 
useDefaultNavigationBehavior:Boolean  [read-write]

The default value is true.

Implementation
    public function get useDefaultNavigationBehavior():Boolean
    public function set useDefaultNavigationBehavior(value:Boolean):void
Constructor detail
ImageNavigator()constructor
public function ImageNavigator()

Constructor.

Method detail
clickHandler()method
protected function clickHandler(e:ListEvent):void

Handles the click from the list of items, it talks to the navigationManager and requests the clicked item index.

Parameters
e:ListEvent — The click event from the TileList
destroy()method 
public function destroy():void

Removes all event listeners and removes all children.

externalNavigationHandler()method 
public function externalNavigationHandler(e:NavigationChangeEvent):void

Sets the current section based on a navigation event. This is where the navXML is updated if updateOnExternalNavigation is true. It also sets the selectedIndex if the section is the same, but the navigation is to a separate item in that section.

Parameters
e:NavigationChangeEvent — The navigation event
viewNextGroup()method 
protected function viewNextGroup(e:MouseEvent = null):void

Handler for the click of the Next Button by setting the currentPosition.

Parameters
e:MouseEvent (default = null) — The click event
viewPrevGroup()method 
protected function viewPrevGroup(e:MouseEvent):void

Handler for the click for the previousButton by setting the scroll index in the list.

Parameters
e:MouseEvent — The click event
Event detail
changeSelectedevent 
Event object type: at.events.NavigationUIEvent
NavigationUIEvent.type property = at.events.NavigationUIEvent.CHANGE_SELECTED

Dispatched when an item was clicked.

The NavigationalUIEvent.CHANGE_SELECTED constant defines the value of the type property of the event object for a changeSelected event.

focusSetevent  
Event object type: at.events.NavigationUIEvent
NavigationUIEvent.type property = at.events.NavigationUIEvent.FOCUS_SET

Dispatched when an image has been selected. Occurs at the same time as the itemClick.

The NavigationalUIEvent.FOCUS_SET constant defines the value of the type property of the event object for a focusSet event.

itemClickevent  
Event object type: mx.events.ItemClickEvent

Dispatched when the user clicks on an item in the control.