import FlexDataGridCheckBoxColumn from 'flexicious-react-datagrid/js/flexgrid/grids/FlexDataGridCheckBoxColumn.js'

public class | source

FlexDataGridCheckBoxColumn

Extends:

react~React.Component → EventDispatcher → FlexDataGridColumn → FlexDataGridCheckBoxColumn

A column to add checkbox selection to the grid.

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	allowSelectAll: boolean Flag to enable/disable the top level select checkbox.
public	enableDataCellOptmization: boolean
public	enableLabelAndCheckBox: boolean Flag to show checkbox as well as a display label.
public	excludeFromExport: boolean
public	excludeFromPrint: boolean
public	excludeFromSettings: boolean
public	headerPaddingLeft: number
public	headerPaddingRight: number
public	headerRenderer: null
public	itemRenderer: null
public	paddingLeft: number
public	paddingRight: number
public	radioButtonMode: boolean In single select datagrids, set this to true for the icon to appear as if it is a radio button
public	resizable: boolean
public	sortable: boolean

Method Summary

Public Methods
public	getClassNames(): string[]
public	getEnableRadioButtonMode(): boolean In single select datagrids, set this to true for the icon to appear as if it is a radio button
public	getEnableSelectAll(): boolean Flag to enable/disable the top level select checkbox.
public	newInstance(): flexiciousNmsp.FlexDataGridCheckBoxColumn For printing, we need to be a IFactory
public	setEnableRadioButtonMode(value: boolean) In single select datagrids, set this to true for the icon to appear as if it is a radio button
public	setEnableSelectAll(value: boolean)

Inherited Summary

From class EventDispatcher
public	[prop]: *
public	dead: boolean
public	eventListeners: Array A list of event listeners for this event dispatcher object.
public	typeCache: {}
public	addEventListener(context: , type: , listener: *) Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
public	constructed()
public	dispatchEvent(event: *): boolean Dispatches an event into the event flow.
public	getClassNames(): string[]
public	getStyle(prop: ): Gets the value of the prop property on this object
public	hasEventListener(type: *): Boolean Returns true if an event listener exists
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.
public	kill() Removes all event listeners
public	killArray(arr: *) Given an array of event dispatchers, calls the kill method on each of them.
public	removeEventListener(type: , listener: ) Removes a listener from the EventDispatcher object.
public	setStyle(prop: , val: ) Sets the value of the prop property on this object

From class FlexDataGridColumn
public	[styleProp]: *
public	activeCellColor: * [Style(name="activeCellColor", type="uint", format="Color", inherit="yes")] The color of the cell directly under the mouse or if using keyboard navigation, current keyboard seed.
public	alternatingItemColors: * [Style(name="alternatingItemColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the backgrounds of the items in the grid.
public	alternatingTextColors: * [Style(name="alternatingTextColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the text of the items in the grid.
public	backgroundColor: * [Style(name="backgroundColor", type="Array", arrayType="uint", format="Color", inherit="no")] Background color, the color of the fill area.
public	blankValuesLabel: string 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.
public	cellBackgroundColorFunction: Function this member was deprecated. Use the grid.cellBackgroundColorFunction instead. A function that can be used to control the background color of each cell in this column.
public	cellBorderFunction: Function A function that lets you control the border drawing mechanism for cell.
public	cellCustomDrawFunction: Function A function that lets you control the background drawing mechanism for cell.
public	cellDisabledFunction: Function A function that can be used to control the enabled flag of each cell in this column.
public	cellTextColorFunction: Function A function that can be used to control the Text color of each cell in this column.
public	clearFilterOnIconClick: boolean
public	color: * [Style(name="color", type="uint", format="Color", inherit="yes")] Color of text in the component, including the component label.
public	columnGroupClosedIcon: * [Style(name="columnGroupClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed column group.
public	columnGroupColors: * [Style(name="columnGroupColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the Column Groups background gradient.
public	columnGroupDrawTopBorder: * [Style(name="columnGroupDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border
public	columnGroupHorizontalGridLineColor: * [Style(name="columnGroupHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	columnGroupHorizontalGridLineThickness: * [Style(name="columnGroupHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the header horizontal grid lines.
public	columnGroupHorizontalGridLines: * [Style(name="columnGroupHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	columnGroupOpenIcon: * [Style(name="columnGroupOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open column group.
public	columnGroupRollOverColors: * [Style(name="columnGroupRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the Column Groups.
public	columnGroupStyleName: * [Style(name="columnGroupStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the column groups.
public	columnGroupVerticalGridLineColor: * [Style(name="columnGroupVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	columnGroupVerticalGridLineThickness: * [Style(name="columnGroupVerticalGridLineThickness", type="Number", format="Length")] Thickness of the header vertical grid lines.
public	columnGroupVerticalGridLines: * [Style(name="columnGroupVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	columnTextColor: * [Style(name="columnTextColor", type="uint", format="Color", inherit="yes")] The color of the cell text of each cell in this column.
public	columnWidthModeFitToContentExcludeHeader: boolean Whether or not to include the header text in the calculation of the column width.
public	columnWidthModeFitToContentWidthCalculator: Function A function that takes column, data provider and returns a number that represents, in pixel terms the width that needs to be applied to the column.
public	columnWidthOffset: boolean 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.
public	dataField: * The name of the field or property in the data provider item associated with the column.
public	disabledColor: * [Style(name="disabledColor", type="uint", format="Color", inherit="yes")] Color of text in the component if it is disabled.
public	disabledIcon: * [Style(name="disabledIcon")] When enableIcon=true, this property specifies the icon to display when enabled=false.
public	disclosureClosedIcon: * [Style(name="disclosureClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed branch node of the navigation tree.
public	disclosureOpenIcon: * [Style(name="disclosureOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open branch node of the navigation tree.
public	draggable: boolean Flag that indicates whether the user is allowed to resize the width of the column.
public	editItemColor: * [Style(name="editItemColor", type="Array", arrayType="uint", format="Color")] The colors to use for the backgrounds of the items in the grid in the editable mode.
public	editTextColor: * [Style(name="editTextColor", format="Color")] The colors to use for the text of the items in the editable grid.
public	editorDataField: string The name of the property of the item editor that contains the new data for the list item.
public	editorStyleName: * [Style(name="editorStyleName", type="String")] Style to apply to the item editor.
public	enableCellClickRowSelect: boolean Flag to enable selection of a row when a cell within that row is clicked.
public	enableExpandCollapseIcon: boolean 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.
public	enableFilterAutoComplete: boolean When filterControl=textInput, setting this flag to true will set the enableAutoComplete flag on the associated TextInput control Not Supported
public	enableHierarchicalNestIndent: boolean For grouped datagrids, when a single column represents entities from various nest levels, its nice to visually indent them.
public	enableIcon: boolean Flag to enable/disable icons within this cell.
public	enableLocalStyles: boolean Added to avoid flicker
public	enableRecursiveSearch: boolean For Grouped datagrids, searching on this column will cause match current item, as well as any of its children.
public	excludeFromExport: boolean If set to true, this column wont be included in the export mechanism by default.
public	excludeFromPrint: boolean If set to true, this column wont be included in the print mechanism by default.
public	excludeFromQuickFind: boolean If set to true, this column wont be included in the quick find mechanism by default.
public	excludeFromSettings: boolean If set to true, this column wont be included in the settings popup by default.
public	excludeFromTransposedMode: boolean Exclude this column from transposed mode.
public	expandCollapseIconBottom: * [Style(name="expandCollapseIconBottom", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom
public	expandCollapseIconLeft: * [Style(name="expandCollapseIconLeft", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom
public	expandCollapseIconRight: * [Style(name="expandCollapseIconRight", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom
public	expandCollapseIconTop: * [Style(name="expandCollapseIconTop", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom
public	filterCellRenderer: flexiciousNmsp.ClassFactory Container for the footer renderer.
public	filterColors: * [Style(name="filterColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background for the filter.
public	filterComboBoxBuildFromGrid: boolean Flag, if set to true, will automatically build this collection on basis of distinct values in the grid.
public	filterComboBoxDataField: String Used in conjunction with the @filterComboBoxDataProvider field, used to set the value of the data field for the associated ISelectFilterControl
public	filterComboBoxDataProvider: object Dataprovider to use to build the list of values to dipsplay in the filter control, only applicable if the filterControl is a
public	filterComboBoxLabelField: String Used in conjunction with the @filterComboBoxDataProvider field, used to set the value of the label field for the associated ISelectFilterControl
public	filterComboBoxWidth: number Returns the width of the dropdown.
public	filterCompareFunction: Function A function that takes an item, and a filterExpression, and returns true or false on basis of whether the provided item matches the filterExpression.
public	filterComparisionType: String This is usually automatically set, you dont have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion. Values : auto,string,number,boolean,date
public	filterConverterFunction: Function A function that takes an item, and returns a processed value for comparison.
public	filterDateRangeOptions: Array Applicable only when the filtercontrol is a
public	filterDrawTopBorder: * [Style(name="filterDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	filterHorizontalGridLineColor: * [Style(name="filterHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	filterHorizontalGridLineThickness: * [Style(name="filterHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the filter horizontal grid lines.
public	filterHorizontalGridLines: * [Style(name="filterHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	filterIcon: * [Style(name="filterIcon")] When filterControl=textInput, the icon that is displayed inside the textbox, based on the insideIconPosition property.
public	filterIconPosition: * [Style(name="filterIconPosition", type="String", enumeration="left,right")] When filterControl=textInput, the position of the icon that is displayed inside the textbox.
public	filterOperation: String The operator to apply when doing the conversion.
public	filterPaddingBottom: * [Style(name="filterPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	filterPaddingLeft: * [Style(name="filterPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	filterPaddingRight: * [Style(name="filterPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	filterPaddingTop: * [Style(name="filterPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	filterRollOverColors: * [Style(name="filterRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the filter.
public	filterTriggerEvent: String The event that the filter triggers on.
public	filterVerticalGridLineColor: * [Style(name="filterVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	filterVerticalGridLineThickness: * [Style(name="filterVerticalGridLineThickness", type="Number", format="Length")] Thickness of the filter vertical grid lines.
public	filterVerticalGridLines: * [Style(name="filterVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	filterWaterMark: String
public	footerAlign: String The alignment of the footer label
public	footerCellRenderer: flexiciousNmsp.ClassFactory Container for the footer renderer.
public	footerColors: * [Style(name="footerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the footer background gradient.
public	footerDrawTopBorder: * [Style(name="footerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	footerFormatter: Formatter Formatter for the footer label.
public	footerHorizontalGridLineColor: * [Style(name="footerHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	footerHorizontalGridLineThickness: * [Style(name="footerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the footer horizontal grid lines.
public	footerHorizontalGridLines: * [Style(name="footerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	footerLabel: null Label for the footer
public	footerLabelFunction: Function A function that will return the footer label
public	footerLabelFunction2: Function
public	footerOperation: String The operation to apply to the footer.
public	footerOperationPrecision: number Precision for the footer label
public	footerPaddingBottom: * [Style(name="footerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	footerPaddingLeft: * [Style(name="footerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	footerPaddingRight: * [Style(name="footerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	footerPaddingTop: * [Style(name="footerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	footerRenderer: * A renderer for the footer
public	footerRollOverColors: * [Style(name="footerRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the footer.
public	footerStyleName: * [Style(name="footerStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
public	footerVerticalGridLineColor: * [Style(name="footerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	footerVerticalGridLineThickness: * [Style(name="footerVerticalGridLineThickness", type="Number", format="Length")] Thickness of the footer vertical grid lines.
public	footerVerticalGridLines: * [Style(name="footerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	footerWordWrap: boolean Flag that controls whether or not to show variable sized footers.
public	format: String Used by the doFormat method.
public	formatter: flexiciousNmsp.Formatter Used by the doFormat method.
public	formatterCurrencySymbol: String For currency formatter, the currency symbol.
public	formatterDateFormatString: String For date formatters, the date format.
public	formatterPrecision: number For number and currency formatters, the default number of digits after the decimal point.
public	grid: *
public	hasComplexDisplay: boolean Performance optimization, is set to true if there is a complex fieldname or a labelFunction or labelFunction2
public	headerAlign: String The alignment of the header label enumeration="left,right,center", defaultValue="left"
public	headerCellRenderer: flexiciousNmsp.ClassFactory Container for the header renderer.
public	headerColors: * [Style(name="headerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the header background gradient.
public	headerDrawTopBorder: * [Style(name="headerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border
public	headerHorizontalGridLineColor: * [Style(name="headerHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	headerHorizontalGridLineThickness: * [Style(name="headerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the header horizontal grid lines.
public	headerHorizontalGridLines: * [Style(name="headerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	headerIcon: * [Style(name="headerIcon")] When enableIcon=true, this property specifies the icon to display.
public	headerLabelFunction2: Function
public	headerPaddingBottom: * [Style(name="headerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	headerPaddingLeft: * [Style(name="headerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	headerPaddingRight: * [Style(name="headerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	headerPaddingTop: * [Style(name="headerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	headerRenderer: flexiciousNmsp.ClassFactory Storage for the headerRenderer property.
public	headerRollOverColors: * [Style(name="headerRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the header.
public	headerStyleName: * [Style(name="headerStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
public	headerTextForExportFunction: Function The default function for excel export.
public	headerTextFunction: Function A function that determines the header text for a column.
public	headerVerticalGridLineColor: * [Style(name="headerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	headerVerticalGridLineThickness: * [Style(name="headerVerticalGridLineThickness", type="Number", format="Length")] Thickness of the header vertical grid lines.
public	headerVerticalGridLines: * [Style(name="headerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	headerWordWrap: boolean Flag that controls whether or not to show variable sized headers.
public	hideHeaderText: boolean The header text is used in the column picker, export, etc.
public	hideText: boolean In scenarios where you only want to display the icon, set enableIcon=true, and hideText=true;
public	horizontalGridLineColor: * [Style(name="horizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	horizontalGridLineThickness: * [Style(name="horizontalGridLineThickness", type="Number", format="Length", inherit="yes")] Thickness of the horizontal grid lines.
public	horizontalGridLines: * [Style(name="horizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	icon: * [Style(name="icon")] When enableIcon=true, this property specifies the icon to display.
public	iconBottom: * [Style(name="iconBottom", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom
public	iconFunction: Function If enableIcon=true, icon function for the icon.
public	iconHandCursor: boolean If enableIcon=true, enables hand cursor on the icon
public	iconHeight: * [Style(name="iconHeight", type="Number")] When enableIcon=true, To position the icon correctly, we need to know the height and width of the icon Since the icon is not yet drawn, sometimes we do not know how big the icon will be.
public	iconLeft: * [Style(name="iconLeft", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom
public	iconMouseOverDelay: number The delay to wait until dispatching the iconMouseOver event when the user mouse the mouse over the icon.
public	iconPlacementFunction: Function A function that allows you to position the icon when you provide an iconFunction or iconUrl.
public	iconRight: * [Style(name="iconRight", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom
public	iconToolTip: string If enableIcon=true, tooltip for the icon
public	iconToolTipFunction: Function If enableIcon=true, tooltip function for the icon.
public	iconTooltipRenderer: flexiciousNmsp.ClassFactory The renderer factory for the icon tooltip.
public	iconTop: * [Style(name="iconTop", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom
public	iconWidth: * [Style(name="iconWidth", type="Number")] When enableIcon=true, To position the icon correctly, we need to know the height and width of the icon Since the icon is not yet drawn, sometimes we do not know how big the icon will be.
public	isEditableFunction: Function this member was deprecated. Use grid.cellEditableFunction A function that takes a IFlexDataGridCell, and returns true if this cell is editable.
public	itemEditor: flexiciousNmsp.ClassFactory A class factory for the instances of the item editor to use for the column, when it is editable.
public	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.
public	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.
public	itemEditorValidatorFunction: Function Function to call before committing the value of the item editor to the data provider.
public	itemRenderer: flexiciousNmsp.ClassFactory The class factory for item renderer instances that display the data for each item in the column.
public	level: flexiciousNmsp.FlexDataGridColumnLevel
public	linkText: * this member was deprecated.
public	minWidth: number The mininum width that a column can receive.
public	multiColumnSortNumberHeight: * [Style(name="multiColumnSortNumberHeight", type="Number", inherit="no")] The height of the numeric value representing the order of the column sort.
public	multiColumnSortNumberStyleName: * [Style(name="multiColumnSortNumberStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the numeric value representing the order of the column sort.
public	multiColumnSortNumberWidth: number
public	overIcon: * [Style(name="overIcon")] When enableIcon=true, this property specifies the icon to display.
public	paddingBottom: * [Style(name="paddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	paddingLeft: * [Style(name="paddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	paddingRight: * [Style(name="paddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	paddingTop: * [Style(name="paddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	pagerColors: * [Style(name="pagerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the pager background gradient.
public	pagerDrawTopBorder: * [Style(name="pagerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	pagerHorizontalGridLineColor: * [Style(name="pagerHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	pagerHorizontalGridLineThickness: * [Style(name="pagerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the pager horizontal grid lines.
public	pagerHorizontalGridLines: * [Style(name="pagerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	pagerPaddingBottom: * [Style(name="pagerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	pagerPaddingLeft: * [Style(name="pagerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	pagerPaddingRight: * [Style(name="pagerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	pagerPaddingTop: * [Style(name="pagerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	pagerRollOverColors: * [Style(name="pagerRollOverColors",type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the pager.
public	pagerVerticalGridLineColor: * [Style(name="pagerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	pagerVerticalGridLineThickness: * [Style(name="pagerVerticalGridLineThickness", type="Number", format="Length")] Thickness of the pager vertical grid lines.
public	pagerVerticalGridLines: * [Style(name="pagerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	percentWidth: number On creation complete, will use this to distribute the width of the grid among the visible columns in the specified ratio.
public	rendererColors: * [Style(name="rendererColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the renderer background gradient.
public	rendererDrawTopBorder: * [Style(name="rendererDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	rendererHorizontalGridLineColor: * [Style(name="rendererHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	rendererHorizontalGridLineThickness: * [Style(name="rendererHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the renderer horizontal grid lines.
public	rendererHorizontalGridLines: * [Style(name="rendererHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	rendererPaddingBottom: * [Style(name="rendererPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	rendererPaddingLeft: * [Style(name="rendererPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	rendererPaddingRight: * [Style(name="rendererPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.
public	rendererPaddingTop: * [Style(name="rendererPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.
public	rendererRollOverColors: * [Style(name="rendererRollOverColors", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over a level renderer.
public	rendererVerticalGridLineColor: * [Style(name="rendererVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	rendererVerticalGridLineThickness: * [Style(name="rendererVerticalGridLineThickness", type="Number", format="Length")] Thickness of the renderer vertical grid lines.
public	rendererVerticalGridLines: * [Style(name="rendererVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	resizable: boolean Flag that indicates whether the user is allowed to resize the width of the column.
public	responseVisibleDirty: boolean A flag used to the identify that the responsive behaviour touched this columns visiblity, So later we can restore the column visiblity on grid resize.
public	responsivePriority: number in which priority level column should be hidden.
public	rollOverColor: * [Style(name="rollOverColor", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the row.
public	rowBackgroundColorFunction: Function
public	selectable: boolean Flag that indicates whether the items in the column are selectable.
public	selectionColor: * [Style(name="selectionColor", type="uint", format="Color", inherit="yes")] The color of the background for the row when the user selects an item renderer in the row.
public	selectionDisabledColor: * [Style(name="selectionDisabledColor", type="uint", format="Color", inherit="yes")] The color of the background of a renderer when the component is disabled.
public	showClearIconWhenHasText: boolean 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.
public	showIconOnCellHover: boolean If set to true, icon only shows when user hovers over the cell.
public	showIconOnRowHover: boolean If set to true, icon only shows when user hovers over the row.
public	sortArrowSkin: * [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the arrow that indicates the column sort direction.
public	sortCaseInsensitive: boolean To sort this column insensitive of case.
public	sortCompareFunction: Function A callback function that gets called when sorting the data in the column.
public	sortNumeric: boolean To sort this column numerically.
public	sortable: boolean Flag that indicates whether the user can click on the header of this column to sort the data provider.
public	textAlign: String [Style(name="textAlign", type="String", enumeration="left,center,right", inherit="yes")] Alignment of text within a container.
public	textDisabledColor: * [Style(name="textDisabledColor", type="uint", format="Color", inherit="yes")] The color of the text of a renderer when the component is disabled.
public	textRollOverColor: * [Style(name="textRollOverColor", type="uint", format="Color", inherit="yes")] Color of the text when the user rolls over a row.
public	textSelectedColor: * [Style(name="textSelectedColor", type="uint", format="Color", inherit="yes")] Color of the text when the user selects a row.
public	truncateToFit: boolean If this propery is true, the text that does not fit in the available size is truncated with "...".
public	useCurrentDataProviderForFilterComboBoxValues: boolean Not supported
public	useFilterDataProviderForItemEditor: boolean For list based item editors, setting this flag will use the dataprovider from the filter mechanism for the item editor.
public	useHandCursor: boolean Uses a special itemrenderer, which causes the mouse to turn into a hand cursor on hover.
public	useIconRollOverTimer: boolean Prior to dispatching the icon roll over, we use a timer so accidental roll over does not cause popups.
public	useLabelFunctionForFilterCompare: boolean Flag, that defaults to true, indicates that in client filter mode, use the label function to perform the search (opposed) comparison to using the raw value of the "searchField" property of the column.
public	useLabelFunctionForSortCompare: boolean When you set to true, a custom sortCompareFunction is applied that uses the labelFunction instead of the dataField.
public	useUnderLine: boolean When true, if the renderer supports the text decoration style property, sets it to underline.
public	verticalGridLineColor: * [Style(name="verticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	verticalGridLineThickness: * [Style(name="verticalGridLineThickness", type="Number", format="Length", inherit="yes")] Thickness of the vertical grid lines.
public	verticalGridLines: * [Style(name="verticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	wordWrap: boolean Flag to indicate that the text in this column can flow into multiple lines, based upon the width of the column.
public	calculateFooterValue(dataProvider: *, cell: flexiciousNmsp.FlexDataGridDataCell): String a. The default text of the footer is calculated on basis of the following logic: i. First we check to see if a footerLabelFunction2 is specified on the column.
public	defaultIconFunction(cell: flexiciousNmsp.FlexDataGridDataCell, state: string): * Default Icon tooltip function.
public	defaultIconTooltipFunction(cell: flexiciousNmsp.FlexDataGridDataCell): string Default Icon tooltip function.
public	defaultLabelFunction(col: flexiciousNmsp.FlexDataGridDataCell, dataProvider: *): String Checks to see the value of the columns footerOperation.
public	deriveRenderer(chromeType: ): Depending on the specified chrome type, gets the appropriate renderer.
public	dispatchEvent(event: ): 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...
public	doFormat(retVal: ): The doFormat method returns formatted value on basis of the format properties (See description below) If the input is null, returns null.
public	getAdjacentColumn(num: number): flexiciousNmsp.FlexDataGridColumn
public	getClassNames(): string[]
public	getClickBehavior(): * Unused, for legacy purposes only
public	getColIndex(): number
public	getColumnLockMode(): * In addition to the left locked and unlocked columns supported by the regular Flex DataGrid, Flexicious Ultimate supports right locked columns.
public	getColumnLockMode(): * In addition to the left locked and unlocked columns supported by the regular Flex DataGrid, Flexicious Ultimate supports right locked columns.
public	getColumnWidthMode(): * The columnWidthMode property on the column specifies how the column widths are applied.
public	getDataCellRenderer(): * Container for the item renderer.
public	getDataField(): string The name of the field or property in the data provider item associated with the column.
public	getDistinctValues(dp: object, collection: Array, addedCodes: Array, lvl: flexiciousNmsp.FlexDataGridColumnLevel): Array Returns this list of distinct values for this column, in a list of arraycollection which will have properties data and label.
public	getEditable(): boolean Flag that indicates whether the items in the column are editable.
public	getFilterControl(): * A control that implements IFilterControl
public	getFilterRenderer(): * The actual control to render inside the header column.
public	getHeaderText(cell: flexiciousNmsp.FlexDataGridDataCell): string Text for the header of this column.
public	getIconField(): string The property on the model object that returns the url to the icon, if you wish to show different icons for each cell.
public	getIndex(): number
public	getIsElastic(): boolean Returns true if the column is not right locked or IFixedWidth.
public	getIsFirstRightLocked(): boolean
public	getIsFirstUnLocked(): boolean
public	getIsLastLeftLocked(): boolean
public	getIsLastUnLocked(): boolean
public	getIsLastleftLocked(): boolean
public	getIsLastrightLocked(): boolean
public	getIsLeftLocked(): boolean Returns true if the column is left locked.
public	getIsLocked(): boolean Returns true if the column is left or right locked.
public	getIsRightLocked(): boolean Returns true if the column is right locked.
public	getIsSortable(): boolean MX and Spark Grids implement the sortable differently, so to match the interface.
public	getLabel(): string For support in pickers
public	getLabelFunction(value: *): Function A function that determines the text to display in this column.
public	getLabelFunction2(value: *): Function A specialized function that determines the text to display in this column, and takes the actual cell being (a) evaluated parameter.
public	getLevel(value: *): flexiciousNmsp.FlexDataGridColumnLevel
public	getNestDepth(): * Gets the nest depth of the associated level.
public	getOwner(): flexiciousNmsp.FlexDataGrid
public	getPersistenceKey(): string this method was deprecated. - now defaults to the uniqueIdentifier. 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.
public	getSearchField(): string The field that the filter should search on.
public	getSortField(): string Similar to searchField, if you want to override what the database actually sorts when you sort this column
public	getSortFieldName(): string Similar to searchField, if you want to override what the database actually sorts when you sort this column
public	getStyleValue(styleProp: string): object Gets the style value for the provided style property at the current level.
public	getUniqueIdentifier(): * A key used to uniquely identify a column.
public	getVisible(): boolean Flag that indicates whether the column is visible.
public	getWidth(): number The width of the column, in pixels.
public	getX(): number Current X position of this column relative to the container for its cells.
public	hasCustomItemRenderer(): boolean
public	isValidStyleValue(val: *): boolean A function that is used when we have complex properties in the datafield.
public	itemToLabel(data: object, cell: flexiciousNmsp.FlexDataGridCell): * Returns the String that the item renderer displays for the given data object.
public	itemToLabelCommon(item: object): String
public	kill()
public	labelFunctionSortCompare(obj1: object, obj2: object): boolean
public	setColumnLockMode(val: *)
public	setColumnLockMode(val: *)
public	setColumnWidthMode(val: ):
public	setDataCellRenderer(value: *)
public	setDataField(value: *)
public	setEditable(value: boolean)
public	setFilterControl(val: *) The filter control to associate with this column.
public	setFilterRenderer(value: *)
public	setFooterFormatter(val: ): Formatter for the footer label
public	setHeaderText(value: string)
public	setIconField(value: string)
public	setLabelFunction(value: Function)
public	setLabelFunction2(value: Function)
public	setPersistenceKey(val: *)
public	setSearchField(val: *)
public	setSortField(val: *)
public	setStyle(styleProp: string, value: *)
public	setUniqueIdentifier(value: string)
public	setVisible(value: boolean)
public	setWidth(value: number)
public	setX(value: number)

Public Constructors

public constructor() source

Override:

FlexDataGridColumn#constructor

Public Members

public allowSelectAll: boolean source

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.

Properties:

Name	Type	Attribute	Description
allowSelectAll	*

public enableDataCellOptmization: boolean source

Properties:

Name	Type	Attribute	Description
enableDataCellOptmization	*

public enableLabelAndCheckBox: boolean source

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)

Properties:

Name	Type	Attribute	Description
enableLabelAndCheckBox	*

public excludeFromExport: boolean source

If set to true, this column wont be included in the export mechanism by default.

Override:

FlexDataGridColumn#excludeFromExport

Properties:

Name	Type	Attribute	Description
excludeFromExport	*

public excludeFromPrint: boolean source

If set to true, this column wont be included in the print mechanism by default.

Override:

FlexDataGridColumn#excludeFromPrint

Properties:

Name	Type	Attribute	Description
excludeFromPrint	*

public excludeFromSettings: boolean source

If set to true, this column wont be included in the settings popup by default.

Override:

FlexDataGridColumn#excludeFromSettings

Properties:

Name	Type	Attribute	Description
excludeFromSettings	*

public headerPaddingLeft: number source

[Style(name="headerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.

Override:

FlexDataGridColumn#headerPaddingLeft

Properties:

Name	Type	Attribute	Description
headerPaddingLeft	*

public headerPaddingRight: number source

[Style(name="headerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.

Override:

FlexDataGridColumn#headerPaddingRight

Properties:

Name	Type	Attribute	Description
headerPaddingRight	*

public headerRenderer: null source

Storage for the headerRenderer property.

Override:

FlexDataGridColumn#headerRenderer

Properties:

Name	Type	Attribute	Description
headerRenderer	*

public itemRenderer: null source

The class factory for item renderer instances that display the data for each item in the column. You can specify a ClassFactory ustom item renderer component as the value of this property.

The default item renderer is a TextView class, which displays the item data as text.

Each Data Cell in the grid is contains an instance of this class.

Override:

FlexDataGridColumn#itemRenderer

Properties:

Name	Type	Attribute	Description
itemRenderer	*

public paddingLeft: number source

[Style(name="paddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the controls left border and the left edge of its content area.

Override:

FlexDataGridColumn#paddingLeft

Properties:

Name	Type	Attribute	Description
paddingLeft	*

public paddingRight: number source

[Style(name="paddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the controls right border and the right edge of its content area.

Override:

FlexDataGridColumn#paddingRight

Properties:

Name	Type	Attribute	Description
paddingRight	*

public radioButtonMode: boolean source

In single select datagrids, set this to true for the icon to appear as if it is a radio button

Properties:

Name	Type	Attribute	Description
radioButtonMode	*

public resizable: boolean source

Flag that indicates whether the user is allowed to resize the width of the column. Please note, left and right locked columns are not resizable

Override:

FlexDataGridColumn#resizable

Properties:

Name	Type	Attribute	Description
resizable	*

public sortable: boolean source

Flag that indicates whether the user can click on the header of this column to sort the data provider.

Override:

FlexDataGridColumn#sortable

Properties:

Name	Type	Attribute	Description
sortable	*

Public Methods

public getClassNames(): string[] source

Override:

FlexDataGridColumn#getClassNames

Return:

string[]

public getEnableRadioButtonMode(): boolean source

In single select datagrids, set this to true for the icon to appear as if it is a radio button

Return:

boolean

public getEnableSelectAll(): boolean source

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.

Return:

boolean

public newInstance(): flexiciousNmsp.FlexDataGridCheckBoxColumn source

For printing, we need to be a IFactory

Return:

flexiciousNmsp.FlexDataGridCheckBoxColumn

public setEnableRadioButtonMode(value: boolean) source

In single select datagrids, set this to true for the icon to appear as if it is a radio button

Params:

Name	Type	Attribute	Description
value	boolean

public setEnableSelectAll(value: boolean) source

Params:

Name	Type	Attribute	Description
value	boolean