The number of milliseconds to wait before issuing an autorefresh call. Defaults to 30000 (30 seconds)

Timer instance to work with the auto refresh mechanism

Layout of the content group.

The default value is VerticalLayout.

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

The Dashlet that is currently maximized. Null if none.

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

The dashlet that initiated the drag operation

The dashlet that initiated the move operation

The dashlet that initiated the drag operation

A function that gets executed when the drag drop operation is complete. Takes 2 Dashlet objects, the initiator, and the target.

An array of drag drop zones. User can drag and drop widgets in the zones defined.

A function that determines whether drop should be shown. When a dashlet is dragged, it can be dropped on another dashlet or a drag drop zone. This function should take a IUIComponent, which could be either a drag drop zone or a dashlet, and return true or false on basis of whether the target dashlet or drag drop zone is capable of accepting drag drop from the dashlet that is currently being dragged. You can access this via dashboardContinaer.dashletBeingDragged

The dashlet or dropzone that the drag operation ended on. Can be either a Dashlet or a DragDropZone

If flag is set to true, grid will dispatch an AUTO_REFRESH event every autoRefreshInterval milliseconds. Setting this to true automatically sets teh enableRefresh flag

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

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.

Enables the print operation. This is simply a flag that the pager control looks for to show or hide the pdf button.

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.

Enables the print operation. This is simply a flag that the pager control looks for to show or hide the print button.

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

Flag to show the refresh icon. Setting this to true does not automatically set enableAutoRefresh.

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

Boolean flag to control whether the settings icon is visible.

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

Flag to draw a task bar UI at the bottom. Please ensure you set enableMinimize on your dashlets so it can be minimized to taskbar. Also, please ensure that your dashboard skin has a taskbar skinpart. See the default dashboard skin for an example. You can customize the appearance of the task bar via the skin.

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

In cases where you have a dashboard with tile layout, the user can control the number of rows and columns that the dashboard should show. This in turn controls the number of dashlets that are shown on the screen. The dashlets are sized on basis of how many rows and columns are requested. When this flag is set to true, we assume there is a single drag drop zone, and it has a tile layout.

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

Boolean flag to control whether user is allowed to toggle the title bars of all the dashlets.

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

Last time the auto refresh timer was triggered

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

Layout of the maximized Content Group.

The default value is VerticalLayout.

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

A list of all dashlets taht are currently closed (or minimized) by the user.

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

During a resize operation we do not allow the user to resize the dashllet less then this number

During a resize operation we do not allow the user to resize the dashllet less then this number

Returns a list of open dashlets

During the move operation, the original left and top co-ordinates of this dashlet

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.

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

During the move operation, the reference point where move started

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.

Title or caption displayed in the title bar.

The default value is "".

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

Height of the title bar

Function that actually runs the pdf. Defaults to defaultPdfHandlerFunction

Function that actually runs the print. Defaults to defaultPrintHandlerFunction

The skin part that defines the appearance of the titlebar

A key used to uniquely identify a zone. Defaults to the title Used in print and preference persistence to identify drag drop zones.

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.

Whether to use addElement or addChild;

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

The constructor

Adds the specified drag drop zones to the content group

Parameters

Clones the current dashboard.

Parameters

Gets the class responsible for handling the PrintUI for the Dashboard. Should be a IPrintComponent.

Gets the class responsible for handling the PrintUI for the Dashlet. Should be a IPrintComponent

Default handler for the Print Button. Calls var po:PrintOptions=PrintOptions.create(true); po.printOptionsViewrenderer = new ClassFactory(DashboardPrintPreview); po.showWarningMessage=false; DashboardPrintController.instance().print(this.grid,po)

Default handler for the Print Button. Calls var po:PrintOptions=PrintOptions.create(); po.printOptionsViewrenderer = new ClassFactory(ExtendedPrintOptionsView); ExtendedPrintController.instance().print(this.grid,po)

returns UserSettingsOptions.create(this);

Handle for the auto refresh.

Parameters

Called when the drag enters over a cell. Use the dropAcceptRejectFunction to control behavior

Parameters

Triggered when drag is starting.

Parameters

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

Returns the dashlet by unique identifier

Parameters

Returns the zone by unique identifier

Parameters

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

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

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.

Given an array of row and column count, initializes the getTileLayout() layout to the requestedRowCount as the first item in the array, and requestedColumnCount as the second item in the array

Parameters

Maximizes the provided dashlet.

Parameters

Parameters

Called when the DragEnter event is dispatched over any of the cells. The event is passes in as is.

Parameters

Called when the DragDrop event is dispatched over any of the cells. The event is passes in as is.

Parameters

Parameters

Default handler for the Save Settings Popup Calls var popup:DashboardSaveSettingsPopup=new DashboardSaveSettingsPopup(); UIUtils.addPopUp(popup,this as DisplayObject); popup.dashboard=this;

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

Parameters

Start the resize

Parameters

Restores the provided dashlet.

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

Parameters

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

Called to show the drop indicator below the passed in cells row. IF you wish to see custom drop signs, override this function.

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

Shows the given toaster message

Parameters

Toggles the visibility of the titlebars of the dashlets.

Dispatched when the auto refresh interval elapses with enableAutoRefresh=true or when the user clicks the refresh button

Dispatched when the grid is about to be generated for the print, or the preview. The event has a handle to the grid that is being printed, as well as the PrintDataGrid instance. This lets you perform custom logic on the PrintDataGrid before the print occurs.

Fired when the grid needs to clear its preferences.

Dispatched when the dashlet is closed

Dispatched when the dashlet is is about to be closed. Can be cancelled

Dispatched when the dashlet is is about to be collapsed. Can be cancelled

Dispatched when the dashlet is collapsed

Dispatched when the dashlet is is about to start drag and drop. Can be cancelled

Dispatched when the dashlets resize has been dropped over a zone or another dashlet

Dispatched when the dashlet is expanded

Dispatched when the dashlet is is about to be expanded. Can be cancelled

Dispatched when the dashlet is is about to be start moving. Can be cancelled

Dispatched when the dashlets move has completed

Dispatched when the dashlet is opened

Dispatched when the dashlet is is about to be opened. Can be cancelled

Dispatched when the dashlet is is about to start resizing. Can be cancelled

Dispatched when the dashlets resize has completed

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

Dispatched when the dashlet is maximized or restored

Dispatched when the dashlet is maximized

Dispatched when the user clicks the 'Generate PDF' button on the Print Preview. In response to this user action, the grid simply prints it output to a byte array of page images. This byte array can then be sent to any pdf generation library either on the client or the server, for example Alive PDF. We provide integration code for AlivePDF out of the box.

Fired when the grid needs to persist its preferences.

Fired right before preferences are being loaded and applied.

Dispatched when the grid is sent to the printer.

Dispatched when the dashlet is maximized