Packageat.display
Classpublic class MultiColumnView
InheritanceMultiColumnView Inheritance mx.containers.HBox
SubclassesRepbag

The MultiColumnView is a tri-tiered menu component.

The component expands on the right side. MultiColumnViewEvents are dispatched before, during, and after the size adjustment - for use in positioning on the right side of the screen.

The MultiColumnView can display icons for each item in the component. That ability requires attributes icon and childrenIcon on the dataProvider. Those icon properties must point to a file relative to the application. Example: assets/presentations/icons/icon.png



Public Properties
 PropertyDefined by
  columnWidth : Number
Sets the width for all columns in the MultiColumnView.
MultiColumnView
  dataProvider : Object
The MultiColumnView component expects tiers of data.
MultiColumnView
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
MultiColumnView
  indicationID : int
The id of the current indication for the current brand.
MultiColumnView
  itemRenderer : IFactory
The itemRenderer for the component.
MultiColumnView
  rowCount : int
Sets the number of visible rows for all columns.
MultiColumnView
  selectionVisible : Boolean
Determines whether or not the selectionLayer is visible in each of the List items.
MultiColumnView
Protected Properties
 PropertyDefined by
  menu1 : MultiColumnViewCustomList
The first tier in the menu.
MultiColumnView
  menu2 : MultiColumnViewCustomList
The second tier.
MultiColumnView
  menu3 : MultiColumnViewCustomList
The third tier.
MultiColumnView
  oldWidth : Number = -1
Holder for the old width of the component before a resize.
MultiColumnView
  resizeTo : Number
Sets the size to resize the component.
MultiColumnView
Public Methods
 MethodDefined by
  
Constructor.
MultiColumnView
  
getLevelWidth(value:int):Number
Gets the width that the component should be based on the index provided.
MultiColumnView
  
reset():void
Resets the component to one viewable column.
MultiColumnView
Protected Methods
 MethodDefined by
  
childAddHandler(e:ChildExistenceChangedEvent):void
MultiColumnView
  
clickHandler(e:ListEvent):void
Handles the click for every item in each list.
MultiColumnView
  
effectEndHandler(e:EffectEvent):void
Handles the end of a resize of the component.
MultiColumnView
  
effectStartHandler(e:EffectEvent):void
Handles the start of a resize of the component.
MultiColumnView
  
outHandler(e:ListEvent):void
Handles the mouse out event of each list.
MultiColumnView
  
overHandler(e:ListEvent):void
Handles the mouse over event of each list.
MultiColumnView
  
resizeHandler(e:ResizeEvent):void
Handles the resizing of the component during the resize.
MultiColumnView
  
scrollHandler(e:ScrollEvent):void
Handles the scrolling of the component.
MultiColumnView
Events
 EventSummaryDefined by
   Dispatched when an item in any tier is clicked.MultiColumnView
   The event is dispatched after the component has been resized.MultiColumnView
   This event is dispatched before the component starts to resize itself.MultiColumnView
   Dispatched repeatedly when the component changes size horizontally.MultiColumnView
Styles
 StyleDescriptionDefined by
  
menu1ListStyleName
Type: String
The styleName property for the first column List in the component. The default value is "menuListStyle".
MultiColumnView
  
menu2ListStyleName
Type: String
The styleName property for the second column List in the component. The default value is "menuListStyle".
MultiColumnView
  
menu3ListStyleName
Type: String
The styleName property for the third column List in the component. The default value is "menuListStyle".
MultiColumnView
Property detail
columnWidthproperty
columnWidth:Number  [read-write]

Sets the width for all columns in the MultiColumnView.

The default value is 160.

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

Implementation
    public function get columnWidth():Number
    public function set columnWidth(value:Number):void
dataProviderproperty 
dataProvider:Object  [read-write]

The MultiColumnView component expects tiers of data.

The data format must be in a XMLList type of structure, and can have any combination of nodes and children nodes.

To display visuals next to the nodes, it requires that the data have icon and childrenIcon file paths to show icons. The icon will display on the left of the text, and the childrenIcon will display on the right and will only be visible when the node has children nodes.

The default value is null.

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

Example
<node...>
     <node.../>
     <node.../>
   </node>
   <node.../>
   <node.../>
   <node...>
     <node.../>
     <node.../>
   </node>

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.

indicationIDproperty 
indicationID:int  [read-write]

The id of the current indication for the current brand.

By setting an indicationID, the component will automatically set the dataProvider by calling the DataInterface.getRepBag(indicationID) method to set the data.

The default value is -1.

Implementation
    public function get indicationID():int
    public function set indicationID(value:int):void
itemRendererproperty 
itemRenderer:IFactory  [read-write]

The itemRenderer for the component. The renderer is a List item renderer.

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

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

See also

menu1property 
protected var menu1:MultiColumnViewCustomList

The first tier in the menu.

menu2property 
protected var menu2:MultiColumnViewCustomList

The second tier.

menu3property 
protected var menu3:MultiColumnViewCustomList

The third tier.

oldWidthproperty 
protected var oldWidth:Number = -1

Holder for the old width of the component before a resize.

The default value is -1.

resizeToproperty 
resizeTo:Number  [read-write]

Sets the size to resize the component.

The default value is -1.

Implementation
    protected function get resizeTo():Number
    protected function set resizeTo(value:Number):void
rowCountproperty 
rowCount:int  [read-write]

Sets the number of visible rows for all columns.

The default value is 8.

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

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

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

The selectionLayer is a protected property in the List. 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
Constructor detail
MultiColumnView()constructor
public function MultiColumnView()

Constructor.

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

Handles the click for every item in each list.

Parameters
e:ListEvent — The list click event
effectEndHandler()method 
protected function effectEndHandler(e:EffectEvent):void

Handles the end of a resize of the component.

Parameters
e:EffectEvent — The effect event
effectStartHandler()method 
protected function effectStartHandler(e:EffectEvent):void

Handles the start of a resize of the component.

Parameters
e:EffectEvent — The effect event
getLevelWidth()method 
public function getLevelWidth(value:int):Number

Gets the width that the component should be based on the index provided.

Parameters
value:int — The index (1, 2, or 3)

Returns
Number
outHandler()method 
protected function outHandler(e:ListEvent):void

Handles the mouse out event of each list.

Parameters
e:ListEvent — The list event
overHandler()method 
protected function overHandler(e:ListEvent):void

Handles the mouse over event of each list.

Parameters
e:ListEvent — The list event
reset()method 
public function reset():void

Resets the component to one viewable column.

resizeHandler()method 
protected function resizeHandler(e:ResizeEvent):void

Handles the resizing of the component during the resize.

Parameters
e:ResizeEvent — The resize event
scrollHandler()method 
protected function scrollHandler(e:ScrollEvent):void

Handles the scrolling of the component.

Parameters
e:ScrollEvent — The scroll event
Event detail
itemClickevent 
Event object type: mx.events.ItemClickEvent

Dispatched when an item in any tier is clicked.

resizeEndevent  
Event object type: at.events.MultiColumnViewEvent

The event is dispatched after the component has been resized.

resizeStartevent  
Event object type: at.events.MultiColumnViewEvent

This event is dispatched before the component starts to resize itself.

resizingevent  
Event object type: at.events.MultiColumnViewEvent

Dispatched repeatedly when the component changes size horizontally.