Package | com.flexicious.nestedtreedatagrid |
Class | public class FlexDataGridCheckBoxColumn |
Inheritance | FlexDataGridCheckBoxColumn FlexDataGridColumn mx.styles.CSSStyleDeclaration |
Implements | IFixedWidth, mx.core.IFactory |
Property | Defined By | ||
---|---|---|---|
allowSelectAll : Boolean = true
Flag to enable/disable the top level select checkbox. | FlexDataGridCheckBoxColumn | ||
blankValuesLabel : String = [None]
Value for the blank item in multi select combobox filter control
Please note, there is a space in the front of this string so it shows up
right below the "All" option. | FlexDataGridColumn | ||
calculatedHeaderHeight : Number
The height on basis of the data to be displayed. | FlexDataGridColumn | ||
cellBackgroundColorFunction : Function
A function that can be used to control the background color of each cell in this column. | FlexDataGridColumn | ||
cellBorderFunction : Function
A function that lets you control the border drawing mechanism for each cell. | FlexDataGridColumn | ||
cellCustomDrawFunction : Function
A function that lets you control the background drawing mechanism for each cell. | FlexDataGridColumn | ||
cellDisabledFunction : Function
A function that can be used to control the enabled flag of each cell in this column. | FlexDataGridColumn | ||
cellTextColorFunction : Function
A function that can be used to control the Text color of each cell in this column. | FlexDataGridColumn | ||
clearFilterOnIconClick : Boolean
For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to
true will clear the text on icon click. | FlexDataGridColumn | ||
clickBehavior : String [read-only]
Unused, for legacy purposes only
| FlexDataGridColumn | ||
columnGroup : FlexDataGridColumnGroup
The group, if any that this column belongs to. | FlexDataGridColumn | ||
columnLockMode : String
In addition to the left locked and unlocked columns supported by the regular Flex DataGrid, Flexicious Ultimate supports right locked columns.
The grid supports the following selection modes:
1) LOCK_MODE_LEFT
2) LOCK_MODE_RIGHT
3) LOCK_MODE_NONE
If set to left, the column will be locked to the left and not scroll horizontally.
If set to right, the column will be locked to the right, and not scroll horizontally.
Please note, column lock modes only make sense if the horizontalScrollPolicy of the grid is set
to "on" or "auto", since if there is no horizontal scrollbar, locked columns behave like unlocked columns,
because there is no horizontal scroll. | FlexDataGridColumn | ||
columnWidthMode : String
The columnWidthMode property on the column specifies how the column widths are applied. | FlexDataGridColumn | ||
columnWidthModeFitToContentExcludeHeader : Boolean
Whether or not to include the header text in the calculation of the column width. | FlexDataGridColumn | ||
columnWidthOffset : int
A value in pixels, that may be used to add/remove width
that gets calculated when you use the columnWidthMode property
Use if you have custom renderers or icons. | FlexDataGridColumn | ||
dataCellRenderer : IFactory
Container for the item renderer. | FlexDataGridColumn | ||
dataField : String
The property to display in this column. | FlexDataGridColumn | ||
draggable : Boolean
Flag that indicates whether the user is allowed to resize
the width of the column. | FlexDataGridColumn | ||
editable : Boolean
Flag that indicates whether the items in the column are editable. | FlexDataGridColumn | ||
editorDataField : String
The name of the property of the item editor that contains the new
data for the list item. | FlexDataGridColumn | ||
enableCellClickRowSelect : Boolean
Flag to enable selection of a row when a cell within that row is clicked. | FlexDataGridColumn | ||
enableDataCellOptmization : Boolean
Flag to turn on the highly optimized FlexDataGridDataCell3. | FlexDataGridColumn | ||
enableExpandCollapseIcon : Boolean = false
For hierarchical datagrids, instead of having a separate column for icons,
this flag will be used to embed an icon based on disclosureOpenIcon and disclosureClosedIcon
within this column that will control the expand collapse of the row. | FlexDataGridColumn | ||
enableFilterAutoComplete : Boolean
When filterControl=textInput, setting this flag to true will set the enableAutoComplete flag on the associated TextInput control
| FlexDataGridColumn | ||
enableHierarchicalNestIndent : Boolean
For grouped datagrids, when a single column represents entities from various nest levels, its nice
to visually indent them. | FlexDataGridColumn | ||
enableIcon : Boolean
Flag to enable/disable icons within this cell.
For columns that have icons (with or without text), you can
Set enableIcons=true.
If it will be the same icon for each cell, just set the "icon" style property on the column.
If it will be different icons based on some logic, you can either provide that via the iconField property, or specify an iconFunction.
If the cell will contain just an icon and no text, then set hideText/hideHeaderText to true.
If the header also needs an icon, use the headerIconUrl property.
Specify (iconLeft or iconRight) and (iconTop or iconBottom). | FlexDataGridColumn | ||
enableLabelAndCheckBox : Boolean
Flag to show checkbox as well as a display label. | FlexDataGridCheckBoxColumn | ||
enableLocalStyles : Boolean = true
Added to avoid flicker
| FlexDataGridColumn | ||
enableRadioButtonMode : Boolean
In single select datagrids, set this to true for the icon to appear as if it is a radio button
| FlexDataGridCheckBoxColumn | ||
enableRecursiveSearch : Boolean = false
For Grouped datagrids, searching on this column will cause match current item, as well as any of its children. | FlexDataGridColumn | ||
enableSelectAll : Boolean
Flag to enable/disable the top level select checkbox. | FlexDataGridCheckBoxColumn | ||
excludeFromExport : Boolean
If set to true, this column wont be included in the
export mechanism by default. | FlexDataGridColumn | ||
excludeFromPrint : Boolean
If set to true, this column wont be included in the
print mechanism by default. | FlexDataGridColumn | ||
excludeFromSettings : Boolean
If set to true, this column wont be included in the settings popup by default. | FlexDataGridColumn | ||
filterCellRenderer : IFactory
Container for the footer renderer. | FlexDataGridColumn | ||
filterComboBoxBuildFromGrid : Boolean
Flag, if set to true, will automatically build this
collection on basis of distinct values in the grid. | FlexDataGridColumn | ||
filterComboBoxDataField : String
Used in conjunction with the | FlexDataGridColumn | ||
filterComboBoxDataProvider : ArrayCollection
Dataprovider to use to build the list of values to dipsplay in
the filter control, only applicable if the filterControl is a
| FlexDataGridColumn | ||
filterComboBoxLabelField : String
Used in conjunction with the | FlexDataGridColumn | ||
filterComboBoxWidth : Number
Returns the width of the dropdown. | FlexDataGridColumn | ||
filterCompareFunction : Function = null
A function that takes an item, and a filterExpression, and returns true or false on basis of whether the provided
item matches the filterExpression. | FlexDataGridColumn | ||
filterComparisionType : String
This is usually automatically set, you dont have to manually set it,
unless you're sending strings as Date objects. | FlexDataGridColumn | ||
filterControl : String
A control that implements | FlexDataGridColumn | ||
filterConverterFunction : Function = null
A function that takes an item, and returns a processed value for comparison. | FlexDataGridColumn | ||
filterDateRangeOptions : Array
Applicable only when the filtercontrol is a
| FlexDataGridColumn | ||
filterOperation : String
The operator to apply when doing the conversion. | FlexDataGridColumn | ||
filterRenderer : IFactory
The actual control
to render inside the header column. | FlexDataGridColumn | ||
filterTriggerEvent : String
The event that the filter triggers on. | FlexDataGridColumn | ||
filterWaterMark : String
Applicable only if the filter control is TextInput. | FlexDataGridColumn | ||
footerAlign : String
The alignment of the footer label
| FlexDataGridColumn | ||
footerCellRenderer : IFactory
Container for the footer renderer. | FlexDataGridColumn | ||
footerFormatter : Formatter
Formatter for the footer label
| FlexDataGridColumn | ||
footerLabel : String
The label of the footer
| FlexDataGridColumn | ||
footerLabelFunction : Function
A function that will return the footer label
| FlexDataGridColumn | ||
footerLabelFunction2 : Function
Similar to footerLabelFunction, but takes the footer cell instead of the column. | FlexDataGridColumn | ||
footerOperation : String
The operation to apply to the footer
| FlexDataGridColumn | ||
footerOperationPrecision : int
Precision for the footer label
| FlexDataGridColumn | ||
footerRenderer : IFactory
A renderer for the footer
| FlexDataGridColumn | ||
footerWordWrap : Boolean
The alignment of the header label
| FlexDataGridColumn | ||
format : String
Used by the doFormat method. | FlexDataGridColumn | ||
formatter : Object
Used by the doFormat method. | FlexDataGridColumn | ||
formatterCurrencySymbol : String
For currency formatter, the currency symbol. | FlexDataGridColumn | ||
formatterDateFormatString : String
For date formatters, the date format. | FlexDataGridColumn | ||
formatterPrecision : Number = 2
For number and currency formatters, the default number of digits after the decimal point. | FlexDataGridColumn | ||
hasComplexDisplay : Boolean = false
Performance optimization, is set to true if there is a complex fieldname or a labelFunction or labelFunction2
| FlexDataGridColumn | ||
headerAlign : String
The alignment of the header label
| FlexDataGridColumn | ||
headerCellRenderer : IFactory
Container for the header renderer. | FlexDataGridColumn | ||
headerMenuActions : Array
A list of ToolbarActions to show when the user hovers their mouse over the header cell of this column. | FlexDataGridColumn | ||
headerRenderer : IFactory
The class factory for item renderer instances that display the
column header for the column. | FlexDataGridColumn | ||
headerText : String
Text for the header of this column. | FlexDataGridColumn | ||
headerToolTip : String
Tooltip to apply to the header. | FlexDataGridColumn | ||
headerWordWrap : Boolean
The alignment of the header label
| FlexDataGridColumn | ||
hideHeaderText : Boolean = false
The header text is used in the column picker, export, etc. | FlexDataGridColumn | ||
hideText : Boolean = false
In scenarios where you only want to display the icon, set enableIcon=true, and hideText=true;
| FlexDataGridColumn | ||
iconField : String
The property on the model object that returns the url to the icon,
if you wish to show different icons for each cell. | FlexDataGridColumn | ||
iconFunction : Function
If enableIcon=true, icon function for the icon. | FlexDataGridColumn | ||
iconHandCursor : Boolean = false
If enableIcon=true, enables hand cursor on the icon
| FlexDataGridColumn | ||
iconMouseOverDelay : Number = 500
The delay to wait until dispatching the iconMouseOver event when the user mouse the mouse over the icon. | FlexDataGridColumn | ||
iconToolTip : String
If enableIcon=true, tooltip for the icon
| FlexDataGridColumn | ||
iconToolTipFunction : Function
If enableIcon=true, tooltip function for the icon. | FlexDataGridColumn | ||
iconTooltipRenderer : IFactory = null
The renderer factory for the icon tooltip. | FlexDataGridColumn | ||
isEditableFunction : Function
A function that takes a IFlexDataGridCell, and returns true if this cell is editable. | FlexDataGridColumn | ||
isElastic : Boolean [read-only]
Returns true if the column is not right locked or IFixedWidth. | FlexDataGridColumn | ||
isFirstRightLocked : Boolean [read-only] | FlexDataGridColumn | ||
isFirstUnLocked : Boolean [read-only] | FlexDataGridColumn | ||
isLastleftLocked : Boolean [read-only] | FlexDataGridColumn | ||
isLastrightLocked : Boolean [read-only] | FlexDataGridColumn | ||
isLastUnLocked : Boolean [read-only] | FlexDataGridColumn | ||
isLeftLocked : Boolean [read-only]
Returns true if the column is left locked. | FlexDataGridColumn | ||
isLocked : Boolean [read-only]
Returns true if the column is left or right locked. | FlexDataGridColumn | ||
isRightLocked : Boolean [read-only]
Returns true if the column is right locked. | FlexDataGridColumn | ||
isSortable : Boolean [read-only]
MX and Spark Grids implement the sortable differently, so to match the interface. | FlexDataGridColumn | ||
itemEditor : IFactory
A class factory for the instances of the item editor to use for the
column, when it is editable. | FlexDataGridColumn | ||
itemEditorApplyOnValueCommit : Boolean
In Edit mode, we only apply the new value to the model object when the user
either hits the enter key or the tab key after typing input. | FlexDataGridColumn | ||
itemEditorManagesPersistence : Boolean
Indicates that the item editors manage their own persitence and populating the dataprovider
back with their changes, so the editorDataField is ignored and the DataGrid does not write
back the value from the editor into the data provider. | FlexDataGridColumn | ||
itemEditorValidatorFunction : Function
Function to call before committing the value of the item editor
to the data provider. | FlexDataGridColumn | ||
itemRenderer : IFactory
Each Cell in the grid is contains an instance of this class. | FlexDataGridColumn | ||
label : String [read-only]
For support in pickers
| FlexDataGridColumn | ||
labelFunction : Function
A function that determines the text to display in this column. | FlexDataGridColumn | ||
labelFunction2 : Function
A specialized function that determines the text to display in this column, and takes the actual cell being evaluated as a parameter. | FlexDataGridColumn | ||
level : FlexDataGridColumnLevel | FlexDataGridColumn | ||
linkText : String
Deprecated. | FlexDataGridColumn | ||
minWidth : Number
The mininum width that a column can receive. | FlexDataGridColumn | ||
nestDepth : Number [read-only]
Gets the nest depth of the associated level. | FlexDataGridColumn | ||
owner : DisplayObjectContainer [read-only] | FlexDataGridColumn | ||
percentWidth : Number
On creation complete, will use this to distribute
the width of the grid among the visible columns in
the specified ratio. | FlexDataGridColumn | ||
persistenceKey : String
For datagrids where there are multiple columns with the same header text,
this field may be specified so that the persistence mechanism does not
overwrite it. | FlexDataGridColumn | ||
radioButtonMode : Boolean = false
In single select datagrids, set this to true for the icon to appear as if it is a radio button
| FlexDataGridCheckBoxColumn | ||
resizable : Boolean
Flag that indicates whether the user is allowed to resize
the width of the column. | FlexDataGridColumn | ||
searchField : String
The field that the filter should search on. | FlexDataGridColumn | ||
selectable : Boolean
Flag that indicates whether the items in the column are selectable. | FlexDataGridColumn | ||
showClearIconWhenHasText : Boolean = false
For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to
true will clear show the icon only when there is text in the box. | FlexDataGridColumn | ||
showIconOnCellHover : Boolean = false
If set to true, icon only shows when user hovers over the cell. | FlexDataGridColumn | ||
showIconOnRowHover : Boolean = false
If set to true, icon only shows when user hovers over the row. | FlexDataGridColumn | ||
sortable : Boolean = true
Flag that indicates whether the user can click on the
header of this column to sort the data provider. | FlexDataGridColumn | ||
sortCaseInsensitive : Boolean = false
To sort this column insensitive of case. | FlexDataGridColumn | ||
sortCompareFunction : Function
A callback function that gets called when sorting the data in
the column. | FlexDataGridColumn | ||
sortField : String
Similar to searchField, if you want to override what the database
actually sorts when you sort this column
| FlexDataGridColumn | ||
sortFieldName : String [read-only] | FlexDataGridColumn | ||
sortNumeric : Boolean = false
To sort this column numerically. | FlexDataGridColumn | ||
styleOverrides : Object [read-only]
For 3.5 Compatibility
| FlexDataGridColumn | ||
truncateToFit : Boolean
If this propery is true, the text that does not fit in the available size
is truncated with "...". | FlexDataGridColumn | ||
uniqueIdentifier : String
A key used to uniquely identify a column. | FlexDataGridColumn | ||
useCurrentDataProviderForFilterComboBoxValues : Boolean
Not supported
| FlexDataGridColumn | ||
useFilterDataProviderForItemEditor : Boolean
For list based item editors, setting this flag will use the dataprovider from the
filter mechanism for the item editor. | FlexDataGridColumn | ||
useHandCursor : Boolean | FlexDataGridColumn | ||
useIconRollOverTimer : Boolean = true
Prior to dispatching the icon roll over, we use a timer so accidental roll over does not cause popups. | FlexDataGridColumn | ||
useLabelFunctionForFilterCompare : Boolean
Flag, that defaults to true, indicates that in client filter mode,
use the label function to perform the search comparison as opposed to using the
raw value of the "searchField" property of the column. | FlexDataGridColumn | ||
useLabelFunctionForSortCompare : Boolean
When you set to true, a custom sortCompareFunction is applied that uses the labelFunction instead
of the dataField. | FlexDataGridColumn | ||
useUnderLine : Boolean
When true, if the renderer supports the text decoration style property, sets it to underline. | FlexDataGridColumn | ||
visible : Boolean
Flag that indicates whether the column is visible. | FlexDataGridColumn | ||
width : Number
The width of the column, in pixels. | FlexDataGridColumn | ||
wordWrap : Boolean
Flag to indicate that the text in this column can flow into multiple lines, based
upon the width of the column. | FlexDataGridColumn | ||
x : Number
Current X position of this column relative to the container for its cells. | FlexDataGridColumn |
Method | Defined By | ||
---|---|---|---|
FlexDataGridCheckBoxColumn | |||
deriveRenderer(chromeType:int = 5):IFactory
Depending on the specified chrome type, gets the appropriate renderer. | FlexDataGridColumn | ||
dispatchEvent(event:Event):Boolean [override]
Whenever a tree datagrid event is dispatched at any column,
we also dispatch it from the level so if someone wants
to listen for an event at all columns... | FlexDataGridColumn | ||
doFormat(retVal:String):String
The doFormat method returns formatted value on basis of the format properties (See description below)
If the input is null, returns null. | FlexDataGridColumn | ||
getAdjacentColumn(num:int):FlexDataGridColumn | FlexDataGridColumn | ||
getDistinctValues(dp:Object, collection:Array = null, addedCodes:Array = null, lvl:FlexDataGridColumnLevel = null):Array
Returns this list of distinct values for this column,
in a list of arraycollection which will have properties
data and label. | FlexDataGridColumn | ||
getStyleValue(styleProp:String):*
Gets the style value for the provided style property at the current
level. | FlexDataGridColumn | ||
isValidStyleValue(val:*):Boolean | FlexDataGridColumn | ||
itemToLabel(data:Object, cell:IFlexDataGridCell = null):String
Returns the String that the item renderer displays for the given data object. | FlexDataGridColumn | ||
newInstance():*
For printing, we need to be a IFactory
| FlexDataGridCheckBoxColumn | ||
showPopup(popupData:Object):Object
Unused, for legacy purposes only
| FlexDataGridColumn |
allowSelectAll | property |
public var allowSelectAll:Boolean = true
Flag to enable/disable the top level select checkbox. You would use this if you need the checkbox selection behavior, but do not wish for the user to be able to select all.
enableLabelAndCheckBox | property |
enableLabelAndCheckBox:Boolean
Flag to show checkbox as well as a display label. In header cells, shows checkbox and headerText. When you set this to true, the column width mode switches from fixed to none, and the width switches from 25 to 100 (default column width)
public function get enableLabelAndCheckBox():Boolean
public function set enableLabelAndCheckBox(value:Boolean):void
enableRadioButtonMode | property |
enableRadioButtonMode:Boolean
In single select datagrids, set this to true for the icon to appear as if it is a radio button
public function get enableRadioButtonMode():Boolean
public function set enableRadioButtonMode(value:Boolean):void
enableSelectAll | property |
enableSelectAll:Boolean
Flag to enable/disable the top level select checkbox. You would use this if you need the checkbox selection behavior, but do not wish for the user to be able to select all.
public function get enableSelectAll():Boolean
public function set enableSelectAll(value:Boolean):void
radioButtonMode | property |
public var radioButtonMode:Boolean = false
In single select datagrids, set this to true for the icon to appear as if it is a radio button
FlexDataGridCheckBoxColumn | () | Constructor |
public function FlexDataGridCheckBoxColumn()
newInstance | () | method |
public function newInstance():*
For printing, we need to be a IFactory
Returns* —
|