Packagecom.adobe.portfolio.properties
Classpublic class CanvasTemplate
InheritanceCanvasTemplate Inheritance PropertyValue Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This class implements the properties for a preset layout to be used by CanvasList.

See also

CanvasList


Public Properties
 PropertyDefined By
  canvasItems : Vector.<CanvasItemData>
A vector of canvas items to be included by this preset
CanvasTemplate
 Inheriteddescription : String
A localized description string suitable for display in the user interface.
PropertyValue
 Inheriteddirty : Boolean
Returns true if the property has been modified and needs to be saved, false otherwise.
PropertyValue
 Inheritedenabled : Boolean
Returns a value of true if the control(s) representing this property should be enabled in the user interface.
PropertyValue
 InheritedhasMinMax : Boolean
[read-only] Returns a value of true if this property has relevant minimum or maximum values.
PropertyValue
 Inheritedlabel : String
A localized label string suitable for display in the user interface.
PropertyValue
 InheritedmaxValue : Number
[read-only] The maximum value of this numeric property.
PropertyValue
 InheritedminValue : Number
[read-only] The minimum value of this numeric property.
PropertyValue
 Inheritedname : String
The name for this IProperty.
PropertyValue
 Inheritedsubvalues : Array
[read-only] The array of possible values for a list property.
PropertyValue
 InheritedsubvaluesLocked : Boolean
[read-only] Returns a value of true if elements of subvalues for this property cannot be added or removed.
PropertyValue
 InheritedsubvaluesType : String
[read-only] Identifies the data type of the IProperty elements found in the subvalues array.
PropertyValue
 Inheritedtype : String
[read-only] Identifies the data type of this IProperty.
PropertyValue
 Inheritedvalue : Object
The value for this IProperty.
PropertyValue
 Inheritedvisible : Boolean
Returns a value of true if the control(s) representing this property should be displayed in the user interface.
PropertyValue
Protected Properties
 PropertyDefined By
 InheriteddescriptionDefault : String
The default description string to be used when the localized description is unavailable.
PropertyValue
 InheriteddescriptionKey : String
The string used as a key to request a localized description string.
PropertyValue
 InheriteddontPlayEffectsCounter : uint = 0
A counter used to keep track of when to run the side effects.
PropertyValue
 Inheritedinitializing : Boolean
Returns true if the property is in an initializing state, false otherwise.
PropertyValue
 InheritedlabelDefault : String
The default label string to be used when the localized label is unavailable.
PropertyValue
 InheritedlabelKey : String
The string used as a key to request a localized label string.
PropertyValue
 Inheritedparent : Object
The parent object of this property.
PropertyValue
Public Methods
 MethodDefined By
  
CanvasTemplate(target:IEventDispatcher = null)
Constructor
CanvasTemplate
 Inherited
createPropertyValue(valueXML:XML, parent:Object):PropertyValue
[static] Create a new PropertyValue instance of the correct type and assign parent as its parent value.
PropertyValue
 Inherited
Create an XML object with all its XML elements for this property.
PropertyValue
  
loadFromXML(valueXML:XML):Boolean
[override] Loads the specified values from XML and creates canvasItems for the elements in the XML value.
CanvasTemplate
 Inherited
Run all the effects in the selectEffectArray If dontPlayEffectsCounter is false (not 0) playSelectEffects() will not run the effects.
PropertyValue
 Inherited
setValueFromString(valueString:String):Boolean
Sets the value of this property to a string-based representation of the desired property value.
PropertyValue
Protected Methods
 MethodDefined By
  
[override] Returns the XML element name for the canvas template.
CanvasTemplate
  
setXMLElements(propertyXML:XML):void
[override] Creates XML items for each canvas item in canvasItems and appends these to the specified propertyXML
CanvasTemplate
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = CanvasTemplate
[static] The XML name used for the canvas template element
CanvasTemplate
Property Detail
canvasItemsproperty
public var canvasItems:Vector.<CanvasItemData>

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A vector of canvas items to be included by this preset

Constructor Detail
CanvasTemplate()Constructor
public function CanvasTemplate(target:IEventDispatcher = null)

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor

Parameters
target:IEventDispatcher (default = null) — The Navigator's event dispatcher
Method Detail
getXMLElementName()method
override protected function getXMLElementName():String

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns the XML element name for the canvas template.

Returns
String
loadFromXML()method 
override public function loadFromXML(valueXML:XML):Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Loads the specified values from XML and creates canvasItems for the elements in the XML value. Load the specified value from an XML object. If possible, the localized label and description will be used.

Parameters

valueXML:XML

Returns
Booleantrue if the property was successfully loaded, false otherwise.
setXMLElements()method 
override protected function setXMLElements(propertyXML:XML):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Creates XML items for each canvas item in canvasItems and appends these to the specified propertyXML

Parameters

propertyXML:XML — the XML property that is to contain the list of canvas items.

Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = CanvasTemplate

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The XML name used for the canvas template element