| Package | com.flexicious.components.dashboard.print |
| Class | public class PrintDashboardContainer |
| Inheritance | PrintDashboardContainer  DashboardContainer DashboardBase spark.components.SkinnableContainer |
| Implements | com.flexicious.grids.dependencies.IPrintComponent |
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
 | allowInteractivity : Boolean [read-only]
A flat that controls appearance of the buttons. | DashboardBase | |
| autoLoadPreferences : Boolean = true | DashboardContainer | |
| autoRefreshInterval : Number
The number of milliseconds to wait before issuing an autorefresh call. | DashboardContainer | |
| contentLayoutFunction : Function
Layout of the content group. | DashboardContainer | |
| currentMaximizedDashlet : Dashlet [read-only]
The Dashlet that is currently maximized. | DashboardContainer | |
| dashboardBeingPrinted : DashboardContainer
The original dashboard being printed
| PrintDashboardContainer | ||
| dashletBeingDragged : Dashlet
The dashlet that initiated the drag operation
| DashboardContainer | |
| dashletBeingMoved : Dashlet
The dashlet that initiated the move operation
| DashboardContainer | |
| dashlets : Array
A list of all available dashlets
| DashboardBase | |
| dragDropCompleteFunction : Function
A function that gets executed when the drag drop operation is complete. | DashboardContainer | |
| dragDropZones : Array
An array of drag drop zones. | DashboardContainer | |
| dropAcceptRejectFunction : Function
A function that determines whether drop should be shown. | DashboardContainer | |
| dropDashletOrDropZone : IUIComponent
The dashlet or dropzone that the drag operation ended on. | DashboardContainer | |
| elementsToBlur : Array [read-only] | DashboardContainer | |
| elementToCenter : IUIComponent [read-only] | DashboardContainer | |
| enableAutoRefresh : Boolean
If flag is set to true, grid will dispatch an AUTO_REFRESH event every autoRefreshInterval milliseconds. | DashboardContainer | |
| enableMultiplePreferences : Boolean
A Flag that will enable multiple named versions of preferences to be persisted. | DashboardContainer | |
| enablePdf : Boolean
Enables the print operation. | DashboardContainer | |
| enablePreferencePersistence : Boolean
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'
| DashboardContainer | |
| enablePrint : Boolean
Enables the print operation. | DashboardContainer | |
| enableRefresh : Boolean
Flag to show the refresh icon. | DashboardContainer | |
| enableSettings : Boolean
Boolean flag to control whether the settings icon is visible. | DashboardContainer | |
| enableTaskBar : Boolean [read-only]
Flag to draw a task bar UI at the bottom. | DashboardContainer | |
| enableTileLayoutRowColumns : Boolean
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. | DashboardContainer | |
| enableTitleToggle : Boolean
Boolean flag to control whether user is allowed to toggle the title bars
of all the dashlets. | DashboardContainer | |
| excelOptions : ExportOptions
The Export options object that is used to configure the excel export behavior - currently only supported in Ultimate
| DashboardContainer | |
| lastAutoRefresh : Date
Last time the auto refresh timer was triggered
| DashboardContainer | |
| maximizedContentLayoutFunction : Function
Layout of the maximized Content Group. | DashboardContainer | |
| mimimizedDashlets : Array [read-only]
A list of all dashlets taht are currently closed (or minimized) by the user. | DashboardContainer | |
| minDashletHeight : Number = 190
During a resize operation we do not allow the user to resize the dashllet
less then this number
| DashboardContainer | |
| minDashletWidth : Number = 190
During a resize operation we do not allow the user to resize the dashllet
less then this number
| DashboardContainer | |
| openDashlets : Array [read-only]
Returns a list of open dashlets
| DashboardContainer | |
| pdfOptions : PrintOptions
The Print options object that is used to configure the pdf behavior - currently only supported in Ultimate
| DashboardContainer | |
| pdfPrinter : IPDFPrinter
A class that takes the PDF Pages as they are generated. | DashboardContainer | |
| popupFactoryExportOptions : IFactory
The renderer that shows up when the user clicks on the Word or Excel button - currently only supported in Ultimate
| DashboardContainer | |
| popupFactoryOpenSettingsPopup : IFactory
The renderer that shows up when the user clicks on the Open Settings button - currently only supported in Ultimate
| DashboardContainer | |
| popupFactoryPrintOptions : IFactory
The renderer that shows up when the user clicks on the Print or PDF button - currently only supported in Ultimate
| DashboardContainer | |
| popupFactorySaveSettingsPopup : IFactory
The renderer that shows up when the user clicks on the Save Settings button - currently only supported in Ultimate
| DashboardContainer | |
| popupFactorySettingsPopup : IFactory
The renderer that shows up when the user clicks on the Settings button - currently only supported in Ultimate
| DashboardContainer | |
| preferencePersistenceKey : String
String value that uniquely identifies this grid across the application. | DashboardContainer | |
| preferencePersistenceMode : String
String value "server" or "client". | DashboardContainer | |
| preferences : String
Returns an XML representation of the preferences specified in
the preferencesToPersist property and values being the actual
values. | DashboardContainer | |
| preferencesLoaded : Boolean [read-only]
Returns true if the load preferences has been called. | DashboardContainer | |
| preferencesSet : Boolean
A flag to indicate that the preferences for this grid
has been set. | DashboardContainer | |
| preferencesToPersist : String
A comma delimited string of the following values:
columnOrder,columnVisiblity,columnWidth,filter,sort,verticalScroll,horizontalScroll
Each represents a setting that can potentially be persisted. | DashboardContainer | |
| printComponentFactory : IFactory | DashboardContainer | |
| printOptions : PrintOptions
The Print options object that is used to configure the print behavior - currently only supported in Ultimate
| DashboardContainer | |
| showSpinnerOnCreationComplete : Boolean | DashboardContainer | |
| spinner : ISpinner | DashboardContainer | |
| spinnerBehavior : SpinnerBehavior | DashboardContainer | |
| spinnerFactory : IFactory
Factory responsible for instantiating a new spinner. | DashboardContainer | |
| spinnerLabel : String
The label of the spinner control, you can use styles
to control the appearance. | DashboardContainer | |
| spinnerParent : Object [read-only] | DashboardContainer | |
| title : String
Title or caption displayed in the title bar. | DashboardContainer | |
| titleBarHeight : Number
Height of the title bar
| DashboardContainer | |
| toolbarPdfHandlerFunction : Function
Function that actually runs the pdf. | DashboardContainer | |
| toolbarPrintHandlerFunction : Function
Function that actually runs the print. | DashboardContainer | |
| tooltipBehavior : TooltipBehavior | DashboardContainer | |
| topGroup : IUIComponent
The skin part that defines the appearance of the titlebar
| DashboardContainer | |
| uniqueIdentifier : String
A key used to uniquely identify a zone. | DashboardContainer | |
| useCompactPreferences : Boolean
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. | DashboardContainer | |
| useElements : Boolean [read-only]
Whether to use addElement or addChild;
| DashboardContainer | |
| useModuleFactory : Boolean [read-only]
Flag that indicates to use the module factory of the grid to show popups. | DashboardContainer | |
| userSettingsOptionsFunction : Function
Hook for the client to plug in their own UserSettings. | DashboardContainer | |
| validNextPage : Boolean [read-only] | PrintDashboardContainer | ||
| wordOptions : ExportOptions
The Export options object that is used to configure the word export behavior - currently only supported in Ultimate
| DashboardContainer | |
| Method | Defined By | ||
|---|---|---|---|
| PrintDashboardContainer | |||
| clearPreferences():void | DashboardContainer | |
| clone(to:DashboardContainer = null, dbFactory:IFactory = null, dzFactory:IFactory = null, dlFactory:IFactory = null, propertiesToTransfer:Array = null, stylesToTransfer:Array = null):DashboardContainer
Clones the current dashboard. | DashboardContainer | |
| createPrintComponentFactory():IFactory
Gets the class responsible for handling the PrintUI for the Dashboard. | DashboardContainer | |
| createPrintDashletFactory():IFactory
Gets the class responsible for handling the PrintUI for the Dashlet. | DashboardContainer | |
| defaultPdfHandlerFunction():void
Default handler for the Print Button. | DashboardContainer | |
| defaultPrintHandlerFunction():void
Default handler for the Print Button. | DashboardContainer | |
| dispatchAutoRefreshEvent(event:Event):void
Handle for the auto refresh. | DashboardContainer | |
|
Triggered when drag is starting. | DashboardContainer | |
| getAutoLoadPreferences():Boolean
By default, when the grid's creation complete event is dispatched, the grid will go
in and load the saved preference. | DashboardContainer | |
|
When enableMultiplePreferences = true, this represents the currently applied preference
| DashboardContainer | |
| getDashletByUniqueIdentifier(id:String):Dashlet
Returns the dashlet by unique identifier
| DashboardContainer | |
| getDragDropZoneByUniqueIdentifier(id:String):DragDropZone
Returns the zone by unique identifier
| DashboardContainer | |
|
When enableMultiplePreferences = true, this represents a list of all preferences saved for this
grid. | DashboardContainer | |
| getTileLayout():TileLayout | DashboardContainer | |
| getUIComponentBitmapData(target:IUIComponent):Image
Drag and Drop support, create a image representation of the dashlet being dragged. | DashboardBase | |
| DashboardContainer | ||
| hideSpinner():void
Removes the spinner and sets the bodyContainer.alpha back to 1
| DashboardContainer | |
| loadPreferences():void
Loads preference values from the Shared object, called automatically in
preferencePersistenceMode=client. | DashboardContainer | |
| loadTileLayout(arr:Array):void
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
| DashboardContainer | |
|
Maximizes the provided dashlet. | DashboardContainer | |
nextPage():void | PrintDashboardContainer | ||
| onSaveSettingsPopup():void
Default handler for the Save Settings Popup
Calls var popup:DashboardSaveSettingsPopup=new DashboardSaveSettingsPopup();
UIUtils.addPopUp(popup,this as DisplayObject);
popup.dashboard=this;
| DashboardContainer | |
| persistPreferences(name:String = Default, isDefault:Boolean = false):void
Persists the preferences as Shared Objects when preferencePersistenceMode=client
or dispatches an event with the preference information when preferencePersistenceMode=server
| DashboardContainer | |
| resizeBegin(event:MouseEvent, dashlet:Dashlet):void
Start the resize
| DashboardContainer | |
| restore():void
Restores the provided dashlet. | DashboardContainer | |
| setCurrentPreferenceInfo(val:PreferenceInfo, applyPreferences:Boolean = true):void
When enableMultiplePreferences = true, applies the given preference as the current
preference. | DashboardContainer | |
| setGridPreferencesInfo(val:GridPreferencesInfo, applyPreferences:Boolean = true):void
Sets the multiple preferences array. | DashboardContainer | |
| showSpinner(msg:String):void
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 . | DashboardContainer | |
| showToaster(message:String, toasterPosition:String, toasterRenderer:IFactory = null, animationDuration:Number = 1000, visibleDuration:Number = 5000, moveAnimate:Boolean = true, fadeAnimate:Boolean = true):void [override]
Shows the given toaster message
| DashboardContainer | |
| toggleTitleBars():void
Toggles the visibility of the titlebars of the dashlets. | DashboardContainer | |
| Method | Defined By | ||
|---|---|---|---|
| addDragDropZones(dragDropZones:Array):void
Adds the specified drag drop zones to the content group
| DashboardContainer | |
applyRatio(srcComp:IUIComponent, dstComp:IUIComponent, wRatio:Number, hRatio:Number):void
Resize dstComponent to the ratios of the srcComponent
| PrintDashboardContainer | ||
|
returns UserSettingsOptions.create(this);
| DashboardContainer | |
| dragAcceptReject(cell:IUIComponent, event:MouseEvent = null):void
Called when the drag enters over a cell. | DashboardContainer | |
| getPeristenceKey():String | DashboardContainer | |
| onCreationComplete(event:FlexEvent):void [override] | DashboardContainer | |
| onDashletDraggingMouseMove(event:MouseEvent):void
Called when the DragEnter event is dispatched over any of the cells. | DashboardContainer | |
| onDragDrop(event:DragEvent):void [override]
Called when the DragDrop event is dispatched over any of the cells. | DashboardContainer | |
| onDragDropStageMouseUpHandler(event:MouseEvent):void | DashboardContainer | |
onResized(event:ResizeEvent):void | PrintDashboardContainer | ||
partAdded(partName:String, instance:Object):void [override] | PrintDashboardContainer | ||
| setPreferences(arrayCollection:ArrayCollection):void
Takes an array collection of preferences and applies them to the grid. | DashboardContainer | |
| showDropIndicator(dashletOrDragDropZone:IUIComponent, event:MouseEvent = null):void
Called to show the drop indicator below the passed in cells row. | DashboardContainer | |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| dashboardBeingPrinted | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var dashboardBeingPrinted:DashboardContainerThe original dashboard being printed
| validNextPage | property |
validNextPage:Boolean [read-only] public function get validNextPage():Boolean| PrintDashboardContainer | () | Constructor |
public function PrintDashboardContainer()| applyRatio | () | method |
protected function applyRatio(srcComp:IUIComponent, dstComp:IUIComponent, wRatio:Number, hRatio:Number):voidResize dstComponent to the ratios of the srcComponent
Parameters
srcComp:IUIComponent | |
dstComp:IUIComponent | |
wRatio:Number | |
hRatio:Number |
| nextPage | () | method |
public function nextPage():void| onResized | () | method |
protected function onResized(event:ResizeEvent):voidParameters
event:ResizeEvent |
| partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):voidParameters
partName:String | |
instance:Object |