Packagecom.adobe.portfolio.components.supportClasses
Classpublic class CanvasList
InheritanceCanvasList Inheritance spark.components.List
Implements IListenAndWatch
Subclasses Footer, Header

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
  autoGeneratedLabel : String = CANVAS_PROPERTIES
CanvasList
  autoGeneratedLabelKey : String = canvasProperties
CanvasList
  autoGenerateProperties : Boolean = false
CanvasList
  backgroundColor : uint
[read-only]
CanvasList
  backgroundGradientColor : uint
[read-only]
CanvasList
  backgroundGradientType : String
[read-only]
CanvasList
  backgroundOpacity : Number
[read-only]
CanvasList
  dataURL : String
CanvasList
  dirty : Boolean
CanvasList
  heightIfPresent : Number
CanvasList
  swfClass : String
CanvasList
  widthIfPresent : Number
CanvasList
Protected Properties
 PropertyDefined By
  addedPropertyBindings : Boolean = false
CanvasList
  addImageWatcher : ChangeWatcher
CanvasList
  addTextWatcher : ChangeWatcher
CanvasList
  backgroundColorWatcher : ChangeWatcher
CanvasList
  backgroundGradientIntensityWatcher : ChangeWatcher
CanvasList
  backgroundGradientTypeWatcher : ChangeWatcher
CanvasList
  backgroundOpacityWatcher : ChangeWatcher
CanvasList
  templateWatcher : ChangeWatcher
CanvasList
Public Methods
 MethodDefined By
  
CanvasList
  
CanvasList
  
applyPresetPositions(presetDataSet:Vector.<CanvasItemData>):void
CanvasList
  
loseContext():Boolean
CanvasList
  
CanvasList
  
CanvasList
  
CanvasList
  
takeContext():Boolean
CanvasList
Protected Methods
 MethodDefined By
  
addImageAction(value:uint):void
CanvasList
  
CanvasList
  
CanvasList
  
addTextAction(value:uint):void
CanvasList
  
CanvasList
  
CanvasList
  
[override]
CanvasList
  
CanvasList
  
onAddImageButtonClick(event:MouseEvent):void
CanvasList
  
onAddTextButtonClick(event:MouseEvent):void
CanvasList
  
onMouseRoll(event:MouseEvent):void
CanvasList
  
CanvasList
  
onRemoveButtonClick(event:MouseEvent):void
CanvasList
  
onRemoveItem(event:Event):void
CanvasList
  
onRendererChange(event:RendererExistenceEvent):void
CanvasList
  
partAdded(partName:String, instance:Object):void
[override] Called when a skin has added a skin part for this instance.
CanvasList
  
partRemoved(partName:String, instance:Object):void
[override] Called when a skin has removed a skin part for this instance.
CanvasList
  
CanvasList
  
setAuthoringMode(value:Boolean):void
CanvasList
  
setBackgroundColor(value:Number):void
CanvasList
  
CanvasList
  
CanvasList
  
setBackgroundOpacity(value:Number):void
CanvasList
  
CanvasList
  
setCanvasXML(value:String):void
CanvasList
  
CanvasList
  
CanvasList
  
CanvasList
  
CanvasList
  
CanvasList
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.


 Skin Part Description Defined By
  
addImageButton:spark.components.Button
Required: false Part Type: Static

CanvasList
  
addTextButton:spark.components.Button
Required: false Part Type: Static

CanvasList
  
removeButton:spark.components.Button
Required: false Part Type: Static

CanvasList
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
  
authoringNormal
CanvasList
  
authoringOver
CanvasList
  
authoringOverAndSelected
CanvasList
  
authoringSelected
CanvasList
Public Constants
 ConstantDefined By
  BLANK_PRESET_NAME : String = blank
[static]
CanvasList
  CUSTOM_PRESET_NAME : String = custom
[static]
CanvasList
  SKIN_PART_ADD_IMAGE_BUTTON : String = addImageButton
[static]
CanvasList
  SKIN_PART_ADD_TEXT_BUTTON : String = addTextButton
[static]
CanvasList
  SKIN_PART_REMOVE_BUTTON : String = removeButton
[static]
CanvasList
  SKIN_STATE_AUTHORING_NORMAL : String = authoringNormal
[static]
CanvasList
  SKIN_STATE_AUTHORING_OVER : String = authoringOver
[static]
CanvasList
  SKIN_STATE_AUTHORING_OVER_AND_SELECTED : String = authoringOverAndSelected
[static]
CanvasList
  SKIN_STATE_AUTHORING_SELECTED : String = authoringSelected
[static]
CanvasList
  SKIN_STATE_NORMAL : String = normal
[static]
CanvasList
  XML_ELEMENT_NAME : String = CanvasItems
[static]
CanvasList
Protected Constants
 ConstantDefined By
  collectionManager : CollectionManager
The navigator's CollectionManager instance.
CanvasList
Property Detail
addedPropertyBindingsproperty
protected var addedPropertyBindings:Boolean = false

addImageWatcherproperty 
protected var addImageWatcher:ChangeWatcher

addTextWatcherproperty 
protected var addTextWatcher:ChangeWatcher

autoGeneratedLabelproperty 
public var autoGeneratedLabel:String = CANVAS_PROPERTIES

autoGeneratedLabelKeyproperty 
public var autoGeneratedLabelKey:String = canvasProperties

autoGeneratePropertiesproperty 
public var autoGenerateProperties:Boolean = false

backgroundColorproperty 
backgroundColor:uint  [read-only]

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


Implementation
    public function get backgroundColor():uint
backgroundColorWatcherproperty 
protected var backgroundColorWatcher:ChangeWatcher

backgroundGradientColorproperty 
backgroundGradientColor:uint  [read-only]

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


Implementation
    public function get backgroundGradientColor():uint
backgroundGradientIntensityWatcherproperty 
protected var backgroundGradientIntensityWatcher:ChangeWatcher

backgroundGradientTypeproperty 
backgroundGradientType:String  [read-only]

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


Implementation
    public function get backgroundGradientType():String
backgroundGradientTypeWatcherproperty 
protected var backgroundGradientTypeWatcher:ChangeWatcher

backgroundOpacityproperty 
backgroundOpacity:Number  [read-only]

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


Implementation
    public function get backgroundOpacity():Number
backgroundOpacityWatcherproperty 
protected var backgroundOpacityWatcher:ChangeWatcher

dataURLproperty 
dataURL:String


Implementation
    public function get dataURL():String
    public function set dataURL(value:String):void
dirtyproperty 
dirty:Boolean


Implementation
    public function get dirty():Boolean
    public function set dirty(value:Boolean):void
heightIfPresentproperty 
heightIfPresent:Number

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


Implementation
    public function get heightIfPresent():Number
    public function set heightIfPresent(value:Number):void
swfClassproperty 
swfClass:String

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


Implementation
    public function get swfClass():String
    public function set swfClass(value:String):void
templateWatcherproperty 
protected var templateWatcher:ChangeWatcher

widthIfPresentproperty 
widthIfPresent:Number

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


Implementation
    public function get widthIfPresent():Number
    public function set widthIfPresent(value:Number):void
Constructor Detail
CanvasList()Constructor
public function CanvasList()



Method Detail
addImageAction()method
protected function addImageAction(value:uint):void

Parameters

value:uint

addImageItem()method 
protected function addImageItem():void

addListenAndWatch()method 
public function addListenAndWatch():void

addPropertyBindings()method 
protected function addPropertyBindings():void

addTextAction()method 
protected function addTextAction(value:uint):void

Parameters

value:uint

addTextItem()method 
protected function addTextItem():void

applyPresetPositions()method 
public function applyPresetPositions(presetDataSet:Vector.<CanvasItemData>):void

Parameters

presetDataSet:Vector.<CanvasItemData>

generatePropertyContext()method 
protected function generatePropertyContext():PropertyContext

Returns
PropertyContext
getCurrentSkinState()method 
override protected function getCurrentSkinState():String

Returns
String
getTemplateProperty()method 
protected function getTemplateProperty():PropertyListValue

Returns
PropertyListValue
loseContext()method 
public function loseContext():Boolean

Returns
Boolean
onAddImageButtonClick()method 
protected function onAddImageButtonClick(event:MouseEvent):void

Parameters

event:MouseEvent

onAddTextButtonClick()method 
protected function onAddTextButtonClick(event:MouseEvent):void

Parameters

event:MouseEvent

onMouseRoll()method 
protected function onMouseRoll(event:MouseEvent):void

Parameters

event:MouseEvent

onNavHostEvent()method 
protected function onNavHostEvent(event:NavHostEvent):void

Parameters

event:NavHostEvent

onRemoveButtonClick()method 
protected function onRemoveButtonClick(event:MouseEvent):void

Parameters

event:MouseEvent

onRemoveItem()method 
protected function onRemoveItem(event:Event):void

Parameters

event:Event

onRendererChange()method 
protected function onRendererChange(event:RendererExistenceEvent):void

Parameters

event:RendererExistenceEvent

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Called when a skin has added a skin part for this instance.

Parameters

partName:String
 
instance:Object

partRemoved()method 
override protected function partRemoved(partName:String, instance:Object):void

Called when a skin has removed a skin part for this instance.

Parameters

partName:String
 
instance:Object

removeListenAndWatch()method 
public function removeListenAndWatch():void

removePropertyBindings()method 
protected function removePropertyBindings():void

setAuthoringMode()method 
protected function setAuthoringMode(value:Boolean):void

Parameters

value:Boolean

setBackgroundColor()method 
protected function setBackgroundColor(value:Number):void

Parameters

value:Number

setBackgroundGradientIntensity()method 
protected function setBackgroundGradientIntensity(value:Number):void

Parameters

value:Number

setBackgroundGradientType()method 
protected function setBackgroundGradientType(value:PropertyValue):void

Parameters

value:PropertyValue

setBackgroundOpacity()method 
protected function setBackgroundOpacity(value:Number):void

Parameters

value:Number

setBlankTemplate()method 
public function setBlankTemplate():Boolean

Returns
Boolean
setCanvasTemplate()method 
protected function setCanvasTemplate(value:PropertyValue):void

Parameters

value:PropertyValue

setCanvasXML()method 
protected function setCanvasXML(value:String):void

Parameters

value:String

setCustomTemplate()method 
public function setCustomTemplate():Boolean

Returns
Boolean
setupContext()method 
protected function setupContext():PropertyContext

Returns
PropertyContext
shouldDisplayCanvas()method 
protected function shouldDisplayCanvas():Boolean

Returns
Boolean
takeContext()method 
public function takeContext():Boolean

Returns
Boolean
updateActualHeight()method 
protected function updateActualHeight():void

updateActualWidth()method 
protected function updateActualWidth():void

updateGradientColor()method 
protected function updateGradientColor():void

Constant Detail
BLANK_PRESET_NAMEConstant
public static const BLANK_PRESET_NAME:String = blank

collectionManagerConstant 
protected const collectionManager:CollectionManager

The navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.

CUSTOM_PRESET_NAMEConstant 
public static const CUSTOM_PRESET_NAME:String = custom

SKIN_PART_ADD_IMAGE_BUTTONConstant 
public static const SKIN_PART_ADD_IMAGE_BUTTON:String = addImageButton

SKIN_PART_ADD_TEXT_BUTTONConstant 
public static const SKIN_PART_ADD_TEXT_BUTTON:String = addTextButton

SKIN_PART_REMOVE_BUTTONConstant 
public static const SKIN_PART_REMOVE_BUTTON:String = removeButton

SKIN_STATE_AUTHORING_NORMALConstant 
public static const SKIN_STATE_AUTHORING_NORMAL:String = authoringNormal

SKIN_STATE_AUTHORING_OVERConstant 
public static const SKIN_STATE_AUTHORING_OVER:String = authoringOver

SKIN_STATE_AUTHORING_OVER_AND_SELECTEDConstant 
public static const SKIN_STATE_AUTHORING_OVER_AND_SELECTED:String = authoringOverAndSelected

SKIN_STATE_AUTHORING_SELECTEDConstant 
public static const SKIN_STATE_AUTHORING_SELECTED:String = authoringSelected

SKIN_STATE_NORMALConstant 
public static const SKIN_STATE_NORMAL:String = normal

XML_ELEMENT_NAMEConstant 
public static const XML_ELEMENT_NAME:String = CanvasItems