Package | com.adobe.portfolio.properties |
Class | public class CanvasTemplate |
Inheritance | CanvasTemplate ![]() ![]() |
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
See also
Property | Defined By | ||
---|---|---|---|
canvasItems : Vector.<CanvasItemData>
A vector of canvas items to be included by this preset
| CanvasTemplate | ||
![]() | description : String
A localized description string suitable for display in the user interface. | PropertyValue | |
![]() | dirty : Boolean
Returns true if the property has been modified and needs to be saved,
false otherwise. | PropertyValue | |
![]() | enabled : Boolean
Returns a value of true if the control(s) representing this property
should be enabled in the user interface. | PropertyValue | |
![]() | hasMinMax : Boolean [read-only]
Returns a value of true if this property has relevant minimum or maximum values. | PropertyValue | |
![]() | label : String
A localized label string suitable for display in the user interface. | PropertyValue | |
![]() | maxValue : Number [read-only]
The maximum value of this numeric property. | PropertyValue | |
![]() | minValue : Number [read-only]
The minimum value of this numeric property. | PropertyValue | |
![]() | name : String
The name for this IProperty. | PropertyValue | |
![]() | subvalues : Array [read-only]
The array of possible values for a list property. | PropertyValue | |
![]() | subvaluesLocked : Boolean [read-only]
Returns a value of true if elements of subvalues for this property
cannot be added or removed. | PropertyValue | |
![]() | subvaluesType : String [read-only]
Identifies the data type of the IProperty elements found in the
subvalues array. | PropertyValue | |
![]() | type : String [read-only]
Identifies the data type of this IProperty. | PropertyValue | |
![]() | value : Object
The value for this IProperty. | PropertyValue | |
![]() | visible : Boolean
Returns a value of true if the control(s) representing this property
should be displayed in the user interface. | PropertyValue |
Method | Defined By | ||
---|---|---|---|
CanvasTemplate(target:IEventDispatcher = null)
Constructor
| CanvasTemplate | ||
![]() | createPropertyValue(valueXML:XML, parent:Object):PropertyValue [static]
Create a new PropertyValue instance of the correct type and
assign parent as its parent value. | PropertyValue | |
![]() | generateXML():XML
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 | ||
![]() | playSelectEffects():void
Run all the effects in the selectEffectArray
If dontPlayEffectsCounter is false (not 0)
playSelectEffects() will not run the effects. | PropertyValue | |
![]() | setValueFromString(valueString:String):Boolean
Sets the value of this property to a string-based representation of the
desired property value. | PropertyValue |
Method | Defined By | ||
---|---|---|---|
getXMLElementName():String [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 |
Constant | Defined By | ||
---|---|---|---|
XML_ELEMENT_NAME : String = CanvasTemplate [static]
The XML name used for the canvas template element
| CanvasTemplate |
canvasItems | property |
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
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
Parameterstarget:IEventDispatcher (default = null ) — The Navigator's event dispatcher
|
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.
ReturnsString |
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 |
Boolean — true 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.
|
XML_ELEMENT_NAME | Constant |
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