com.flexicious.components.dashboard.print.PrintDashlet

Package	com.flexicious.components.dashboard.print
Class	public class PrintDashlet
Inheritance	PrintDashlet Dashlet spark.components.SkinnableContainer

A printable version of the dashlet that has a white background for ease of printing

Default MXML PropertymxmlContentFactory

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		allowInteractivity : Boolean [read-only] A flat that controls appearance of the buttons.	Dashlet
		dashboardContainer : DashboardContainer The Dashboard Container that this Dashlet belongs to.	Dashlet
		dragDropZone : DragDropZone The DragDropZone Container that this Dashlet belongs to.	Dashlet
		draggable : Boolean Flag to enable drag and drop behavior.	Dashlet
		enableAnimations : Boolean = true Flag to enable transitional animations when the dashlets are minimized and restored from the taskbar, closed, and restored from the picker.	Dashlet
		enableClose : Boolean A flag that the skin looks for to enable the close button.	Dashlet
		enableExpandCollapse : Boolean Flag to enable the expand and collapse functionality for this dashlet.	Dashlet
		enableIcon : Boolean [read-only] Flag to display an Icon in the title for this dashlet.	Dashlet
		enableMaximizeAndRestore : Boolean Flag to enable the maximize and restore functionality for this dashlet.	Dashlet
		enableMinimize : Boolean Flag to enable the minimize to task bar functionality.	Dashlet
		enableTitleBar : Boolean [read-only] Boolean flag to control the visibility of the title bar	Dashlet
		isCollapsed : Boolean [read-only] Whether the dashboard is collapsed	Dashlet
		isMaximized : Boolean [read-only] Returns true if this dashlet is maximized.	Dashlet
		isMinimized : Boolean [read-only] Whether the dashboard is minimized to taskbar	Dashlet
		isOpen : Boolean [read-only] Whether the dashboard is open	Dashlet
		itemRenderer : IFactory The factory for the content of this dashlet.	Dashlet
		itemRendererInstance : IVisualElement [read-only] The instance of the item renderer.	Dashlet
		moveable : Boolean Flag to enable move behavior.	Dashlet
		originalDashletInfo : DashletInfo State of the dashlet when it was initialized (the way the programmer initialized it)	Dashlet
		preCollapseDashletInfo : DashletInfo State of the dashlet when prior to being maximized	Dashlet
		preMaximizeDashletInfo : DashletInfo State of the dashlet when prior to being maximized	Dashlet
		resizable : Boolean Flag to enable resize behavior.	Dashlet
		spinner : ISpinner The spinner component.	Dashlet
		spinnerFactory : IFactory Factory responsible for instantiating a new spinner.	Dashlet
		spinnerLabel : String The label of the spinner control, you can use styles to control the appearance.	Dashlet
		title : String Title or caption displayed in the title bar.	Dashlet
		titleBarHeight : Number Height of the title bar	Dashlet
		uniqueIdentifier : String A key used to uniquely identify a zone.	Dashlet

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		PrintDashlet()	PrintDashlet
		animate(sizeFrom:Rectangle, sizeTo:Rectangle, endFunction:Function):void A method to animate the dashlet.	Dashlet
		clone(to:Dashlet = null, dlFactory:IFactory = null, propertiesToTransfer:Array = null, stylesToTransfer:Array = null):Dashlet Clones the current Dashlet.	Dashlet
		close(doAnimate:Boolean = true):void Sets the visible and include in layout flags to false	Dashlet
		collapse():void Reduces the height to the height of the title bar	Dashlet
		dispatchEvent(event:Event):Boolean [override] Whenever a dashboard event is dispatched at any dashlet, we also dispatch it from the dahsboard container so if someone wants to listen for an event at all dashlets.	Dashlet
		expand():void Expands the height to the height that the dashlet had prior to being collapsed	Dashlet
		gatherDashletInfo(dashletInfo:DashletInfo):void Initializes the dashlet info object passed in with the current state of the dashlet	Dashlet
		generatePreivew():Bitmap Generates a preview of this dashlet	Dashlet
		getExplicitOrMeasuredWidth():Number [override]	Dashlet
		getStyle(styleProp:String):* [override]	PrintDashlet
		hideSpinner():void Removes the spinner and sets the bodyContainer.alpha back to 1	Dashlet
		loadFromDashletInfo(dashletInfo:DashletInfo, expandHide:Boolean = false):void Loads the collapse, open, title, height, width, x and y from the specified dashlet info.	Dashlet
		maximize():void Maximizes the dashlet.	Dashlet
		minimizeToTaskBar():void Sets the visible and include in layout flags to false	Dashlet
		open(doAnimate:Boolean = true):void Sets the visible and include in layout flags to true	Dashlet
		restore():void Restores the component to its position prior to being maximized.	Dashlet
		restoreFromTaskBar():void Sets the visible and include in layout flags to true	Dashlet
		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 .	Dashlet

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		onDragGripMouseOver(event:MouseEvent):void	Dashlet
		onResizeGripMouseOver(event:MouseEvent):void	Dashlet

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
dashletClosed	Dispatched when the dashlet is closed	Dashlet
dashletClosing	Dispatched when the dashlet is is about to be closed.	Dashlet
dashletCollapsed	Dispatched when the dashlet is is about to be collapsed.	Dashlet
dashletCollapsing	Dispatched when the dashlet is collapsed	Dashlet
dashletExpanded	Dispatched when the dashlet is expanded	Dashlet
dashletExpanding	Dispatched when the dashlet is is about to be expanded.	Dashlet
dashletOpen	Dispatched when the dashlet is opened	Dashlet
dashletOpening	Dispatched when the dashlet is is about to be opened.	Dashlet
maximizeChanged	Dispatched when the dashlet is maximized or restored	Dashlet
maximized	Dispatched when the dashlet is maximized	Dashlet
restored	Dispatched when the dashlet is maximized	Dashlet

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
backgroundColors	Type: Array Format: Color In order to apply a gradient to the background.	Dashlet
borderAlpha	Type: Number CSS Inheritance: no Theme: spark The alpha of the border for this component.	Dashlet
borderColor	Type: uint Format: Color CSS Inheritance: no Theme: spark The color of the border for this component.	Dashlet
borderVisible	Type: Boolean CSS Inheritance: no Theme: spark Controls the visibility of the border for this component.	Dashlet
borderWeight	Type: Number Format: Length CSS Inheritance: no The stroke weight for the border.	Dashlet
cornerRadius	Type: Number Format: Length CSS Inheritance: no Theme: spark The radius of the corners for this component.	Dashlet
dropShadowVisible	Type: Boolean CSS Inheritance: no Theme: spark Controls the visibility of the drop shadow for this component.	Dashlet
icon	When enableIcon=true, this property speciies the icon to display.	Dashlet
spinnerColors	Type: Array Format: Color Colors for the spinners as an array.	Dashlet
spinnerGridAlpha	Type: Number Format: Length Background color of the grid when the spinner is active.	Dashlet
spinnerLabelBackgroundColor	Type: uint Format: Color Bacground color for the box in which the label is displayed.	Dashlet
spinnerLabelColor	Type: uint Format: Color CSS Inheritance: yes Label color for the spinner.	Dashlet
spinnerLabelfontFamily	Type: String CSS Inheritance: yes Label font family.	Dashlet
spinnerLabelfontSize	Type: Number Format: Length CSS Inheritance: yes Label font size.	Dashlet
spinnerLabelfontStyle	Type: String CSS Inheritance: yes Label font style.	Dashlet
spinnerLabelfontThickness	Type: Number CSS Inheritance: yes Label font thinkcness.	Dashlet
spinnerLabelfontWeight	Type: String CSS Inheritance: yes Label font weight.	Dashlet
spinnerRadius	Type: Number Format: Length Spinner radius , default value is 10.	Dashlet
spinnerThickness	Type: Number Format: Length Spinner thickness , default value is 5.	Dashlet

Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.

Hide Inherited Skin Parts

Show Inherited Skin Parts

	Description	Defined By
buttonGroup:mx.core.IVisualElement	Required: false Part Type: Static The skin part that holds the buttons	Dashlet
dragGrip:mx.core.IVisualElement	Required: false Part Type: Static The skin part that initiates the drag/drop behavior of this dashlet	Dashlet
resizeGrip:mx.core.IVisualElement	Required: false Part Type: Static The skin part that initiates the resize behavior of this dashlet	Dashlet
titleDisplay:spark.core.IDisplayText	Required: false Part Type: Static The skin part that defines the appearance of the title text in the container. See also spark.skins.spark.PanelSkin	Dashlet
topGroup:mx.core.IVisualElement	Required: false Part Type: Static The skin part that defines the appearance of the titlebar	Dashlet

Constructor Detail

PrintDashlet

()

Constructor

public function PrintDashlet()

Method Detail

getStyle

()

method

override public function getStyle(styleProp:String):*

Parameters

styleProp:String

Returns

*

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PrintDashlet	Properties \| Methods \| Events \| Styles Skin Parts