Grid can be setup to launch a popup when the user clicks or hovers. The popup class should have a public show method, that takes an object.This is the object bound to the row that triggers the click or hover event.

The parent object to use while calling PopupManager.addPopUp. Defaults to the grid, but you can use any other DisplayObject.

The popup class to launch. Should have a public show method that takes an object. This is the object bound to the row that triggers the click or hover event.

The height of the popup to launch when the clickBehavior is set.

The title of the popup to launch when the clickBehavior is set.

The width of the popup to launch when the clickBehavior is set.

The class that manages the collection filtering, paging and sorting. Needs to inherit from CollectionManipulator.

Text for the Copy All Rows

Text for the Copy Cell Menu

Text for the Copy Selected Row

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

Flag to use the columnWidthMode based column resizing. In cases where you are not using the column width mode property on any of the columns, set this to false. Defaults to true.

A Flag that will enable multiple named versions of preferences to be persisted. The UI will be modified to allow for this to happen. This is new functionality introduced in v2.9. The default renderers for the different popups can be retrieved from the 2.9 blog post.

A flag to indicate whether or not to enable paging functionality

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

When set to true, causes the grid to look for settings stored previously in the local shared object store if preferencePersistenceMode='client' or dispatch an event requesting settings from the server in preferencePersistenceMode='server'

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

The Export options object that is used to configure the excel export behavior - currently only supported in Ultimate

Returns a list of columns that have excludeFromExport=false (default)

The height of the filter row. If not set, defaults to the value of the rowHeight property

If you have enableFilters set to true but want the filter row to not appear, you can set this value.

The height of the footer row. If not set, defaults to the value of the rowHeight property

If you have enableFooters set to true but want the footer row to not appear, you can set this value.

Use this flag to show the pager control even if the enablePaging is set to false. This is used in a scenario where you wish to show buttons other than the paging buttons in the pager bar.

Override the base grouped columns

Flag to set if column groupes exist

The default exporter in flexicious is a pure CSV exporter. This property lets you hook in a native excel exporter using a libary like as3xls. Just like Alive PDF, as3xls is not embedded in to the core flexicious library, instead it is distributed as a part of the sample. Just like for pdf, you hook up the AlivePdfPrinter, you use the nativeExcelExporter to hookup an implementation of the flexicious expoter that interfaces with the as3xls library to provide native excel export

The current page index

Handle to the current IPager control.

A Class that implements com.flexicious.controls.interfaces.IPager. Defaults to a built in implementation

See also

The height of the pager row. If not set, defaults to the value of the rowHeight property

If you have enablePaging set to true but want the pager row to not appear, you can set this value.

The number of records to display per page

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

The Print options object that is used to configure the pdf behavior - currently only supported in Ultimate

A class that takes the PDF Pages as they are generated. This functionality was introduced in 2.9 to provide a responsive UI during the generation of the PDF. Previously, the print controller created image snapshots in memory, and handed them all to the pdf engine, which processed them individually by adding them to the display tree in one go. Instead, now, the step of the snapshot itself adds the image to the pdf doc and this whole thing runs inside a timer so the UI has an opportunity to update itself. First, you specify a class that implements IPDFPrinter as the pdfPrinter property. The AlivePdfPrinter is a sample implementation of IPDFPrinter. This class should expose the methods defined in the IPDFPrinter which are used as such: The beginDocument method is called when the Print controller is ready to send out the pages. For each page generated by the Print Controller, the addPage method is called. Once all pages are added to the doc, the endDocument method is called.

The renderer that shows up when the user clicks on the Word or Excel button - currently only supported in Ultimate

The renderer that shows up when the user clicks on the Open Settings button - currently only supported in Ultimate

The renderer that shows up when the user clicks on the Print or PDF button - currently only supported in Ultimate

The renderer that shows up when the user clicks on the Save Settings button - currently only supported in Ultimate

The renderer that shows up when the user clicks on the Settings button - currently only supported in Ultimate

String value that uniquely identifies this grid across the application. If you have multiple grids' with enablePreferencePersistence, and they happen to share the same value for the id field, e.g. id="grid1" they might overwrite each others' preferences. To combat this situation, we provide a property, which defaults to the id of the grid, but you can override to provide a globally unique key.

String value "server" or "client". When this property is set to client(default), the grid uses a shared object on the client to store preference settings. When it is set to server, the grid fires an event, preferencesChanged, which contains a XML string representation of the preference values. This can then be persisted on the backend, tied to a specific user id.

Returns an XML representation of the preferences specified in the preferencesToPersist property and values being the actual values. When

Returns true if the load preferences has been called.

A flag to indicate that the preferences for this grid has been set. Used by the clear preferences button to enable or disable itself.

A comma delimited string of the following values: columnOrder,columnVisiblity,columnWidth,filter,sort,verticalScroll,horizontalScroll Each represents a setting that can potentially be persisted.

Returns a list of columns that have excludeFromPrint=false (default)

The Print options object that is used to configure the print behavior - currently only supported in Ultimate

The state of the select all header checkbox.

The property(attribute) of the type(class) of the objects contained within the collection bound to the dataProvider. Example, "employeeId" property would be the selectedKeyField of the class "Employee.as". This is then used by the selectedKeys and selectedObjects properties to return the appropriate collection.

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

Gets the keys of the objects selected by the user when used in conjunction with the selectedKeyField object

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

Gets the objects selected by the user when used in conjunction with the selectedKeyField object

Returns a list of columns that have excludeFromPrint=false (default)

Factory responsible for instantiating a new spinner. Defaults to com.flexicious.Spinner. Needs to implement com.flexicious.interfaces.ISpinner, and extend UIComponent

The label of the spinner control, you can use styles to control the appearance.

The total number of records (needs to be set only in server mode, because there is no way for the grid to know how many records on the server match the filter criteria) In client mode, the count of the data provider is used instead.

Returns columns x through columns.count, where x=lockedColumnCount

If set to true, uses the newer preference persistence scheme introduced in Flexicious 2.0, which stores the preferences as custom string as opposed to XML, making it a lot less verbose.

Flag that indicates to use the module factory of the grid to show popups. Use this when you are using modules and your parent application is not under your control. Please note, you will still need to ensure that the parent application imports PopupManager. http://bugs.adobe.com/jira/browse/SDK-873

Hook for the client to plug in their own UserSettings. See the UserSettingsOptions class for details.

The Export options object that is used to configure the word export behavior - currently only supported in Ultimate

Constructor Adds event listeners to manage runtime addition, removal and resizing of columns.

Adds the specified context menu item to the context menu.

Parameters

Adds a default sort to the grid.

Parameters

Selects the given item.

Parameters

In here, we make UI adjustments, basically reducing the space that the grid takes to accomodate the filter, pager and footer rows, if enabled.

Parameters

Parameters

Calls clear on all internal filter controls, resetting the state

Clears the checkbox selections when used in conjunction with SelectAllCheckBoxHeaderColumn see com.flexicious.grids.columns.SelectAllCheckBoxHeaderColumn

Parameters

During the commit phase, we inspect the changed properties and add/remove controls accordingly.

Override the createChildren method, and: If filters are enabled, add the filter row If footers are enabled, add the footer row If the pager is enabled, create a pager using the pagerRenderer property If the copy items are enabled, add the context menu items to copy

Parameters

Creates the popup.

Parameters

Gets the class responsible for handling the PrintUI should be a IPrintDataGrid

returns UserSettingsOptions.create(this);

By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference. This works well in most cases, but in some cases, where the data needed to build selection comboboxes (for filters) is built from the dataprovider, it makes sense to wait until the dataprovider is loaded to parse and set the preferences, otherwise the grid will end up ignoring saved preferences for filters that have dropdown based UI. In this case set autoLoadPreferences to true, and manually call loadPreferences when the data is received from the server and the dataprovider is set. grid:FlexDataGrid autoLoadPreferences=”false” And then, when you set the dataprovider: dgReport.dataProvider=dp; if(!dgReport.preferencesLoaded){ dgReport.loadPreferences(); }

When enableMultiplePreferences = true, this represents the currently applied preference

Parameters

Parameters

Given a field to search for, return the column that has it's searchField set to the provided value.

Parameters

Parameters

Parameters

Used by filter to identify where relative position for each control for tabbing

Parameters

When enableMultiplePreferences = true, this represents a list of all preferences saved for this grid.

Gets the item that was under the mouse last

Parameters

Removes the spinner and sets the listContent.alpha back to 1

Need to invalidte our children when we invalidate.

Parameters

From the filter row, if the user clicks up or down arrow, we pass control to the datagrid to update the selection accordingly.

Parameters

Loads preference values from the Shared object, called automatically in preferencePersistenceMode=client. In server mode, you can directly set the preferences property to the string XML value persisted earlier.

Parameters

Method to handle the click for the copy cell menu item Copies the current cell in tab delimited format into the clipboard

Parameters

We just pass on this event for our callers (this is no longer used, it was used for lazy loading.

Parameters

Parameters

If we add anything above list content, the halo rectangle around the focus objects does not account for that. So in this function we move the focus rectangle accordingly.

Parameters

For popup support, we keep track of what the user is hovering over.

Parameters

Adds the copy menu

Parameters

Method to handle the click for the copy table menu item Copies the current page in tab delimited format into the clipboard

Parameters

Not applicable to classic, only used by Ultimate.

Parameters

Persists the preferences as Shared Objects when preferencePersistenceMode=client or dispatches an event with the preference information when preferencePersistenceMode=server

Parameters

If you want to control when the filter runs, set the filterTriggerEvent="none" on each of the columns, and call this function to trigger the filter

Used by state persistence to load sort settings that were persisted previously.

Parameters

The non filtered dataprovider is used in various places including: 1) The combobox filters use these to create a list of options to search from 2) The footer operations use them to apply formulas to the entire collection as opposed to whats on the current page 3) The print functionality uses them to calculate footer and header totals If the data provider changes as a result of your code, you should call this method before calling refreshLayout, in order to show the correct data.

Parameters

Resets the position of each of the filter controls, the position, height and width of the filter and footer container rows, as well as the pager control This is done automatically when the columns are resized, or the list changes, or the grid is resized. But this method may be used from the calling code if required.

Removes the specified context menu item

Parameters

Recalculates column widths on basis of columnWidthMode. This method changes the widths only only if user has not persisted preferences or the force parameter is true.

Parameters

Sets the enabled/disabled flag on the specified context menu item.

Parameters

Sets the visible flag on the specified context menu item.

Parameters

When enableMultiplePreferences = true, applies the given preference as the current preference.

Parameters

Parameters

Parameters

Parameters

Sets the focus on the next focusable filter control, starting at column index 0.

Sets the multiple preferences array. On basis of the applyPreferences parameter, loops through the preferences and sets the preferences value to the first preference where isDefault=true.

Parameters

Takes an array collection of preferences and applies them to the grid.

Parameters

Launches the actual popup.

Parameters

Shows the spinner with default values defined below: Label: "Loading please wait" X Position : center X of the grid Y Position : center Y of the grid Grid Alpa when the spinner is active : 0.3 Spinner appearance can be modified using styles .

Parameters

Parameters

Dispatched when the grid is finished exporting. At this point, the textWritten variable of the dispatched event is available to you, to customize the generated text if you need to.

Dispatched right after a grid has printed. Contains a handle to the printOptions object that contains both the grid being printed extendedDataGrid - (IExtendedDataGrid) and printDataGrid (IPrintDatagrid). You can use it to make modifications to the grid being printed.

Dispatched when the grid is about to be exported

Dispatched right before a grid is about to print. Contains a handle to the printOptions object that contains both the grid being printed extendedDataGrid - (IExtendedDataGrid) and printDataGrid (IPrintDatagrid). You can use it to make modifications to the grid being printed.

Fired when the grid needs to clear its preferences.

Fired when the enableFilters Flag changes

Fired when the enableFooters Flag changes

Fired when the enablePaging Flag changes

Fired when the enablePreferencePersistence Flag changes

Fired when the filter is applied. Only applicable in filterPageSortMode=client.

Fired when the grid's page, sort or filter state changes.

Fired In preferencePersistenceMode=server , when the grid needs to load its preferences. Fired In preferencePersistenceMode=client , when the grid has successfully loaded preferences.

Fired when the Page Size changes

Fired when the grid needs to persist its preferences.

Fired right before preferences are being loaded and applied.

Fired only in server mode, when the grid needs to print or export more data than is currently loaded in memory.

Fired when the select all checkbox is changed

Fired when the checkbox selection changes