Packagecom.flexicious.nestedtreedatagrid.behaviors.columnheader
Classpublic class ColumnHeaderOperationBehavior
InheritanceColumnHeaderOperationBehavior Inheritance Object

A class that is responsible for associating the column header menu with header cells The default list of operations is the static variable on this class. You can override this default list globally by modifying this list, or you can associate individual column header operations with each column.


Public Properties
 PropertyDefined By
  COL_HEADER_ADD_TO_SORT_ACTION : ToolbarAction
[static] This is the add to sort action.
ColumnHeaderOperationBehavior
  COL_HEADER_CLEAR_FILTER_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_HIDE_COLUMN_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_LEFT_LOCK_COLUMN_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_REMOVE_FROM_SORT_ACTION : ToolbarAction
[static] This is the add to sort action.
ColumnHeaderOperationBehavior
  COL_HEADER_REMOVE_SORT_ACTION : ToolbarAction
[static] This is the remove sort order action.
ColumnHeaderOperationBehavior
  COL_HEADER_RIGHT_LOCK_COLUMN_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_SHOW_HIDE_COLUMNS_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_SIZE_ALL_COLS_TO_FIT_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_SIZE_COL_TO_FIT_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  COL_HEADER_SORT_ASCENDING_ACTION : ToolbarAction
[static] This is the sort ascending toolbar action.
ColumnHeaderOperationBehavior
  COL_HEADER_SORT_DESCENDING_ACTION : ToolbarAction
[static] This is the sort descending toolbar action.
ColumnHeaderOperationBehavior
  COL_HEADER_SORT_SETTINGS_ACTION : ToolbarAction
[static] This is the sort settings action.
ColumnHeaderOperationBehavior
  COL_HEADER_SWAP_SORT_ORDER_ACTION : ToolbarAction
[static] This is the swap sort order action.
ColumnHeaderOperationBehavior
  COL_HEADER_UNLOCK_COLUMN_ACTION : ToolbarAction
[static] This is the hide column action.
ColumnHeaderOperationBehavior
  currentHeaderCell : FlexDataGridHeaderCell
The column we are currently acting upon
ColumnHeaderOperationBehavior
  DEFAULT_COLUMN_HEADER_OPERATIONS : Array
[static] Default set of actions.
ColumnHeaderOperationBehavior
  dropdownIcon : IUIComponent
The icon for the dropdopwn
ColumnHeaderOperationBehavior
  dropdownIconRenderer : IFactory
The renderer factory used to instantiate an instance of the dropdown icon.
ColumnHeaderOperationBehavior
  enabled : Boolean = false
Is the column header behavior enabled?
ColumnHeaderOperationBehavior
  grid : FlexDataGrid
The grid associated with this behavior
ColumnHeaderOperationBehavior
  hideDisabledOptions : Boolean = false
If set to true, hides the menu operations that are not applicable to the current column instead of disabling them.
ColumnHeaderOperationBehavior
  iconaddtosort : Class
[static]
ColumnHeaderOperationBehavior
  iconHideColumn : Class
[static]
ColumnHeaderOperationBehavior
  iconremoveallsorts : Class
[static]
ColumnHeaderOperationBehavior
  iconremovefromsort : Class
[static]
ColumnHeaderOperationBehavior
  iconscrollLeft : Class
[static]
ColumnHeaderOperationBehavior
  iconscrollRight : Class
[static]
ColumnHeaderOperationBehavior
  iconSizeColToFit : Class
[static]
ColumnHeaderOperationBehavior
  iconSizeToFit : Class
[static]
ColumnHeaderOperationBehavior
  iconsortDescending : Class
[static]
ColumnHeaderOperationBehavior
  iconsortsettings : Class
[static]
ColumnHeaderOperationBehavior
  iconswapsort : Class
[static]
ColumnHeaderOperationBehavior
  iconunlock : Class
[static]
ColumnHeaderOperationBehavior
  menu : Menu
The menu to setup
ColumnHeaderOperationBehavior
  triggerCell : IFlexDataGridCell
The cell that triggered the move
ColumnHeaderOperationBehavior
Public Methods
 MethodDefined By
  
ColumnHeaderOperationBehavior(grid:FlexDataGrid)
ColumnHeaderOperationBehavior
  
isEnabledFunction(action:ToolbarAction, grid:FlexDataGrid):Boolean
[static]
ColumnHeaderOperationBehavior
  
killIcon():void
Removes the icon from the cell
ColumnHeaderOperationBehavior
  
onToolbarActionExecuted(action:ToolbarAction, grid:FlexDataGrid):Boolean
[static]
ColumnHeaderOperationBehavior
Protected Methods
 MethodDefined By
  
onCellMouseClick(event:Event):void
ColumnHeaderOperationBehavior
  
onCellMouseOut(event:FlexDataGridEvent):void
Handler for cell mouse out
ColumnHeaderOperationBehavior
  
onCellMouseOver(event:FlexDataGridEvent):void
Handler for cell mouse over
ColumnHeaderOperationBehavior
  
onGridMouseOut(event:MouseEvent):void
ColumnHeaderOperationBehavior
  
onMenuItemClick(event:MenuEvent):void
ColumnHeaderOperationBehavior
Property Detail
COL_HEADER_ADD_TO_SORT_ACTIONproperty
public static var COL_HEADER_ADD_TO_SORT_ACTION:ToolbarAction

This is the add to sort action. Only avaialble if multi column sort is on.

COL_HEADER_CLEAR_FILTER_ACTIONproperty 
public static var COL_HEADER_CLEAR_FILTER_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_HIDE_COLUMN_ACTIONproperty 
public static var COL_HEADER_HIDE_COLUMN_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_LEFT_LOCK_COLUMN_ACTIONproperty 
public static var COL_HEADER_LEFT_LOCK_COLUMN_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_REMOVE_FROM_SORT_ACTIONproperty 
public static var COL_HEADER_REMOVE_FROM_SORT_ACTION:ToolbarAction

This is the add to sort action. Only avaialble if multi column sort is on.

COL_HEADER_REMOVE_SORT_ACTIONproperty 
public static var COL_HEADER_REMOVE_SORT_ACTION:ToolbarAction

This is the remove sort order action. Only avaialble if multi column sort is on.

COL_HEADER_RIGHT_LOCK_COLUMN_ACTIONproperty 
public static var COL_HEADER_RIGHT_LOCK_COLUMN_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_SHOW_HIDE_COLUMNS_ACTIONproperty 
public static var COL_HEADER_SHOW_HIDE_COLUMNS_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_SIZE_ALL_COLS_TO_FIT_ACTIONproperty 
public static var COL_HEADER_SIZE_ALL_COLS_TO_FIT_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_SIZE_COL_TO_FIT_ACTIONproperty 
public static var COL_HEADER_SIZE_COL_TO_FIT_ACTION:ToolbarAction

This is the hide column action.

COL_HEADER_SORT_ASCENDING_ACTIONproperty 
public static var COL_HEADER_SORT_ASCENDING_ACTION:ToolbarAction

This is the sort ascending toolbar action.

COL_HEADER_SORT_DESCENDING_ACTIONproperty 
public static var COL_HEADER_SORT_DESCENDING_ACTION:ToolbarAction

This is the sort descending toolbar action.

COL_HEADER_SORT_SETTINGS_ACTIONproperty 
public static var COL_HEADER_SORT_SETTINGS_ACTION:ToolbarAction

This is the sort settings action. Only avaialble if multi column sort is on.

COL_HEADER_SWAP_SORT_ORDER_ACTIONproperty 
public static var COL_HEADER_SWAP_SORT_ORDER_ACTION:ToolbarAction

This is the swap sort order action. Only avaialble if multi column sort is on.

COL_HEADER_UNLOCK_COLUMN_ACTIONproperty 
public static var COL_HEADER_UNLOCK_COLUMN_ACTION:ToolbarAction

This is the hide column action.

currentHeaderCellproperty 
public var currentHeaderCell:FlexDataGridHeaderCell

The column we are currently acting upon

DEFAULT_COLUMN_HEADER_OPERATIONSproperty 
public static var DEFAULT_COLUMN_HEADER_OPERATIONS:Array

Default set of actions.

dropdownIconproperty 
public var dropdownIcon:IUIComponent

The icon for the dropdopwn

dropdownIconRendererproperty 
public var dropdownIconRenderer:IFactory

The renderer factory used to instantiate an instance of the dropdown icon.

enabledproperty 
public var enabled:Boolean = false

Is the column header behavior enabled?

gridproperty 
public var grid:FlexDataGrid

The grid associated with this behavior

hideDisabledOptionsproperty 
public var hideDisabledOptions:Boolean = false

If set to true, hides the menu operations that are not applicable to the current column instead of disabling them.

iconaddtosortproperty 
public static var iconaddtosort:Class

iconHideColumnproperty 
public static var iconHideColumn:Class

iconremoveallsortsproperty 
public static var iconremoveallsorts:Class

iconremovefromsortproperty 
public static var iconremovefromsort:Class

iconscrollLeftproperty 
public static var iconscrollLeft:Class

iconscrollRightproperty 
public static var iconscrollRight:Class

iconSizeColToFitproperty 
public static var iconSizeColToFit:Class

iconSizeToFitproperty 
public static var iconSizeToFit:Class

iconsortDescendingproperty 
public static var iconsortDescending:Class

iconsortsettingsproperty 
public static var iconsortsettings:Class

iconswapsortproperty 
public static var iconswapsort:Class

iconunlockproperty 
public static var iconunlock:Class

menuproperty 
public var menu:Menu

The menu to setup

triggerCellproperty 
public var triggerCell:IFlexDataGridCell

The cell that triggered the move

Constructor Detail
ColumnHeaderOperationBehavior()Constructor
public function ColumnHeaderOperationBehavior(grid:FlexDataGrid)



Parameters
grid:FlexDataGrid
Method Detail
isEnabledFunction()method
public static function isEnabledFunction(action:ToolbarAction, grid:FlexDataGrid):Boolean

Parameters

action:ToolbarAction
 
grid:FlexDataGrid

Returns
Boolean
killIcon()method 
public function killIcon():void

Removes the icon from the cell

onCellMouseClick()method 
protected function onCellMouseClick(event:Event):void

Parameters

event:Event

onCellMouseOut()method 
protected function onCellMouseOut(event:FlexDataGridEvent):void

Handler for cell mouse out

Parameters

event:FlexDataGridEvent

onCellMouseOver()method 
protected function onCellMouseOver(event:FlexDataGridEvent):void

Handler for cell mouse over

Parameters

event:FlexDataGridEvent

onGridMouseOut()method 
protected function onGridMouseOut(event:MouseEvent):void

Parameters

event:MouseEvent

onMenuItemClick()method 
protected function onMenuItemClick(event:MenuEvent):void

Parameters

event:MenuEvent

onToolbarActionExecuted()method 
public static function onToolbarActionExecuted(action:ToolbarAction, grid:FlexDataGrid):Boolean

Parameters

action:ToolbarAction
 
grid:FlexDataGrid

Returns
Boolean



Copyright 2012 Flexicious LLC. All rights reserved.

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