Packagecom.adobe.portfolio.components.supportClasses
Classpublic class CanvasItemData
InheritanceCanvasItemData Inheritance flash.events.EventDispatcher

A class representing text or image data to be rendered by a CanvasItem in a CanvasList.

See also

CanvasItem
CanvasList


Public Properties
 PropertyDefined By
  bottom : Number
CanvasItemData
  height : Number
The desired heigth of the item rendering this data.
CanvasItemData
  horizontalCenter : Number
CanvasItemData
  imageOpacity : Number
The opacity of the image to be used by the item rendering this data.
CanvasItemData
  imageURL : String
The url of the image to be used by the item rendering this data.
CanvasItemData
  left : Number
CanvasItemData
  parent : CanvasList
[read-only] This CanvasList containing the CanvasItem rendering this data.
CanvasItemData
  right : Number
CanvasItemData
  styledText : XML
The styled text to be used by the item rendering this data.
CanvasItemData
  swfOpacity : Number
The opacity of the swf to be used by the item rendering this data.
CanvasItemData
  swfURL : String
The url of the swf to be used by the item rendering this data.
CanvasItemData
  top : Number
CanvasItemData
  type : String
[read-only] The type of this canvas item data.
CanvasItemData
  verticalCenter : Number
CanvasItemData
  visible : Boolean
[read-only] True if the item rendering this data should be visible.
CanvasItemData
  width : Number
The desired width of the item rendering this data.
CanvasItemData
  x : Number
CanvasItemData
  y : Number
CanvasItemData
Public Methods
 MethodDefined By
  
CanvasItemData(parent:CanvasList = null)
Default constructor
CanvasItemData
  
applyPositionAndSize(visual:IVisualElement):void
A function to copy the layout information this object into a visual element.
CanvasItemData
  
Creates an XML representation of this data.
CanvasItemData
  
loadFromXML(valueXML:XML):Boolean
A function to populate this data based on an XML representation.
CanvasItemData
  
A function to copy the layout information from another CanvasItemData into this object.
CanvasItemData
Public Constants
 ConstantDefined By
  IMAGE_TYPE : String = image
[static] A string literal representing an image data type.
CanvasItemData
  SWF_TYPE : String = swf
[static] A string literal representing an swf data type.
CanvasItemData
  TEXT_TYPE : String = text
[static] A string literal representing a text data type.
CanvasItemData
  XML_ELEMENT_NAME : String = CanvasItem
[static] A string literal representing the element name used in the XML representation of a CanvasList.
CanvasItemData
Property Detail
bottomproperty
bottom:Number

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


Implementation
    public function get bottom():Number
    public function set bottom(value:Number):void
heightproperty 
height:Number

The desired heigth of the item rendering this data.

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


Implementation
    public function get height():Number
    public function set height(value:Number):void
horizontalCenterproperty 
horizontalCenter:Number

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


Implementation
    public function get horizontalCenter():Number
    public function set horizontalCenter(value:Number):void
imageOpacityproperty 
imageOpacity:Number

The opacity of the image to be used by the item rendering this data.

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


Implementation
    public function get imageOpacity():Number
    public function set imageOpacity(value:Number):void
imageURLproperty 
imageURL:String

The url of the image to be used by the item rendering this data.

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


Implementation
    public function get imageURL():String
    public function set imageURL(value:String):void
leftproperty 
left:Number

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


Implementation
    public function get left():Number
    public function set left(value:Number):void
parentproperty 
parent:CanvasList  [read-only]

This CanvasList containing the CanvasItem rendering this data.


Implementation
    public function get parent():CanvasList
rightproperty 
right:Number

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


Implementation
    public function get right():Number
    public function set right(value:Number):void
styledTextproperty 
styledText:XML

The styled text to be used by the item rendering this data.

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


Implementation
    public function get styledText():XML
    public function set styledText(value:XML):void
swfOpacityproperty 
swfOpacity:Number

The opacity of the swf to be used by the item rendering this data.

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


Implementation
    public function get swfOpacity():Number
    public function set swfOpacity(value:Number):void
swfURLproperty 
swfURL:String

The url of the swf to be used by the item rendering this data.

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


Implementation
    public function get swfURL():String
    public function set swfURL(value:String):void
topproperty 
top:Number

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


Implementation
    public function get top():Number
    public function set top(value:Number):void
typeproperty 
type:String  [read-only]

The type of this canvas item data.

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


Implementation
    public function get type():String

See also

verticalCenterproperty 
verticalCenter:Number

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


Implementation
    public function get verticalCenter():Number
    public function set verticalCenter(value:Number):void
visibleproperty 
visible:Boolean  [read-only]

True if the item rendering this data should be visible.

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


Implementation
    public function get visible():Boolean
widthproperty 
width:Number

The desired width of the item rendering this data.

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


Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number

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


Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number

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


Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor Detail
CanvasItemData()Constructor
public function CanvasItemData(parent:CanvasList = null)

Default constructor

Parameters
parent:CanvasList (default = null)
Method Detail
applyPositionAndSize()method
public function applyPositionAndSize(visual:IVisualElement):void

A function to copy the layout information this object into a visual element.

Parameters

visual:IVisualElement

generateXML()method 
public function generateXML():XML

Creates an XML representation of this data.

Returns
XML

See also

loadFromXML()method 
public function loadFromXML(valueXML:XML):Boolean

A function to populate this data based on an XML representation.

Parameters

valueXML:XML

Returns
Boolean

See also

setValuesFromData()method 
public function setValuesFromData(itemData:CanvasItemData):Boolean

A function to copy the layout information from another CanvasItemData into this object.

Parameters

itemData:CanvasItemData

Returns
Boolean
Constant Detail
IMAGE_TYPEConstant
public static const IMAGE_TYPE:String = image

A string literal representing an image data type.

SWF_TYPEConstant 
public static const SWF_TYPE:String = swf

A string literal representing an swf data type.

TEXT_TYPEConstant 
public static const TEXT_TYPE:String = text

A string literal representing a text data type.

XML_ELEMENT_NAMEConstant 
public static const XML_ELEMENT_NAME:String = CanvasItem

A string literal representing the element name used in the XML representation of a CanvasList.