com.adobe.coreUI.controls.WhiteBoard

	Property	Defined by
		allowSave : Boolean Returns true if saving is allowed	WhiteBoard
		currentPropertiesToolBar : IWBPropertiesToolBar [read-only] The current properties tool bar	WhiteBoard
		model : WBModel Determines the model used in this white board	WhiteBoard
		popupPropertiesToolBar : Boolean = true Returns if the properties tool bar is popped up.	WhiteBoard
		popupShapesToolBar : Boolean = true Returns if the shapes tool bar is popped up.	WhiteBoard
		shapesToolBar : UIComponent The shapes tool Bar	WhiteBoard
		zoomLevel : Number Returns the zoom level	WhiteBoard

	Method	Defined by
		hideSelection():void Hides the selection container	WhiteBoard
		showSelection():void Shows the selection	WhiteBoard

Summary	Defined by
endDrawingShape	Dispatched when one is finished drawing a shape on the canvas.	WhiteBoard
propertiesToolbarAdd	Dispatched when the property tool bar is added.	WhiteBoard
propertiesToolbarRemove	Dispatched when the property tool bar is removed.	WhiteBoard

Styles

Style Description Defined by

	Style	Description	Defined by
		backgroundAlpha	Type: Number CSS Inheritance: no Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style. Valid values range from 0.0 to 1.0. The default value is `1.0`.	WhiteBoard
		backgroundColor	Type: uint Format: Color CSS Inheritance: no Background color of a component. You can have both a `backgroundColor` and a `backgroundImage` set. Some components do not have a background. The DataGrid control ignores this style. The default value is `undefined`, which means it is not set. If both this style and the `backgroundImage` style are `undefined`, the component has a transparent background. For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color. The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's `fillAlphas` property to 1, as the following example shows: <mx:Container backgroundColor="0x66CC66"/> <mx:ControlName ... fillAlphas="[1,1]"/> </mx:Container>	WhiteBoard

backgroundAlpha

Type: Number CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. The default value is 1.0.

WhiteBoard

backgroundColor

Type: uint Format: Color CSS Inheritance: no
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

   <mx:Container backgroundColor="0x66CC66"/>
       <mx:ControlName ... fillAlphas="[1,1]"/>
   </mx:Container>

WhiteBoard

Property detail

allowSave

property

allowSave:Boolean [read-write]

Returns true if saving is allowed

Implementation
public function get allowSave():Boolean
public function set allowSave(value:Boolean):void

currentPropertiesToolBar

property

currentPropertiesToolBar:IWBPropertiesToolBar [read-only]

The current properties tool bar

Implementation
public function get currentPropertiesToolBar():IWBPropertiesToolBar

model

property

model:WBModel [read-write]

Determines the model used in this white board

Implementation
public function get model():WBModel
public function set model(value:WBModel):void

popupPropertiesToolBar

property

public var popupPropertiesToolBar:Boolean = true

Returns if the properties tool bar is popped up.

popupShapesToolBar

property

public var popupShapesToolBar:Boolean = true

Returns if the shapes tool bar is popped up.

shapesToolBar

property

shapesToolBar:UIComponent [read-write]

The shapes tool Bar

Implementation
public function get shapesToolBar():UIComponent
public function set shapesToolBar(value:UIComponent):void

zoomLevel

property

zoomLevel:Number [read-write]

Returns the zoom level

Implementation
public function get zoomLevel():Number
public function set zoomLevel(value:Number):void

Method detail

hideSelection

()

method

public function hideSelection():void

Hides the selection container

showSelection

()

method

public function showSelection():void

Shows the selection

Event detail

endDrawingShape

event

Event object type: com.adobe.events.WBCanvasEvent

Dispatched when one is finished drawing a shape on the canvas.

propertiesToolbarAdd

event

Event object type: com.adobe.events.WBCanvasEvent

Dispatched when the property tool bar is added.

propertiesToolbarRemove

event

Event object type: com.adobe.events.WBCanvasEvent

Dispatched when the property tool bar is removed.

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/coreUI/controls/WhiteBoard.html

LCCS API Reference Player 10.1	All Packages \| All Classes \| Index \| Frames No Frames
Class WhiteBoard	Properties \| Methods \| Events \| Styles

Package	com.adobe.coreUI.controls
Class	public class WhiteBoard
Inheritance	WhiteBoard mx.core.UIComponent
Subclasses	SharedWhiteBoard