Packagecom.adobe.portfolio.properties
Classpublic class FontList
InheritanceFontList Inheritance PropertyListValue 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

The class of properties for font lists. This is an extension of the PropertyListValue class.



Public Properties
 PropertyDefined By
 InheritedactiveValue : PropertyValue
The currently active value.
PropertyListValue
 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
[override] [read-only] The array of possible values for a PropertyList
PropertyListValue
 InheritedsubvaluesLocked : Boolean
[override] [read-only] Returns true if elements of subvalues for this property cannot be added or removed.
PropertyListValue
 InheritedsubvaluesType : String
[override] [read-only] Identifies the data type of the IProperty elements found in the subvalues array.
PropertyListValue
 Inheritedtype : String
[override] [read-only] Identifies the data type of this IProperty.
PropertyListValue
 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
  loadAndSaveValues : Boolean
[override] [read-only] Since font list items are not stored in the portfolio itself, its subvalues are not loaded or saved to XML.
FontList
 Inheritedparent : Object
The parent object of this property.
PropertyValue
  shouldOutputSubvalues : Boolean
[override] [read-only] Returns false.
FontList
 Inherited_subvalues : Array
The array of possible values for a PropertyList
PropertyListValue
Public Methods
 MethodDefined By
  
FontList(target:IEventDispatcher = null)
Constructor
FontList
 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] Load the specified XML object FontList.
FontList
 Inherited
Run all the effects in the selectEffectArray If dontPlayEffectsCounter is false (not 0) playSelectEffects() will not run the effects.
PropertyValue
 Inherited
referenceSubvalueResources(referenceType:int):void
References, dereferences, or touches all URL subvalues.
PropertyListValue
 Inherited
setValueFromString(valueString:String):Boolean
[override] Sets the value of this property to a string-based representation of the desired property value.
PropertyListValue
 Inherited
updateSubvalues(newSubvalues:Array, newActiveValue:PropertyValue = null):void
Update the subvalues and active value of the property list to the new list and preperty value
PropertyListValue
Protected Methods
 MethodDefined By
  
[override] Returns the XML element name for this property.
FontList
  
loadFonts(activeName:String, loadApplicationFonts:Boolean = true, loadEmbeddedFonts:Boolean = true):void
Loads the list of available fonts as subvalues.
FontList
  
onCollectionPropertyChange(event:PropertyChangeEvent):void
A listener for handling changes to the application or embedded font arrays.
FontList
 Inherited
setXMLElements(propertyXML:XML):void
[override] Sets all the XML elements for this property, such as enabled, visible, label, and description.
PropertyListValue
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = FontList
[static] The XML element name for FontLists.
FontList
Property Detail
loadAndSaveValuesproperty
loadAndSaveValues:Boolean  [read-only] [override]

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

Since font list items are not stored in the portfolio itself, its subvalues are not loaded or saved to XML. Returns false if loading and saving values to and from XML should be skipped. This may be desirable if the list values are based on the runtime state of the system.


Implementation
    protected function get loadAndSaveValues():Boolean
shouldOutputSubvaluesproperty 
shouldOutputSubvalues:Boolean  [read-only] [override]

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

Returns false. The list of fonts is generated programatically, so we don't output them to XML Returns true. The default (unless overridden) is to output subvalues to XML.


Implementation
    protected function get shouldOutputSubvalues():Boolean
Constructor Detail
FontList()Constructor
public function FontList(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)
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 this property.

Returns
String
loadFonts()method 
protected function loadFonts(activeName:String, loadApplicationFonts:Boolean = true, loadEmbeddedFonts:Boolean = true):void

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

Loads the list of available fonts as subvalues.

Parameters

activeName:String — The name of the desired active item once fonts have been loaded
 
loadApplicationFonts:Boolean (default = true) — true if all system fonts exposed by the application should be loaded; false otherwise
 
loadEmbeddedFonts:Boolean (default = true) — true if all embedded fonts in the portfolio should be loaded; false otherwise

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

Load the specified XML object FontList. If in authoring mode, also load all the system fonts. If possible, the localized label and description will be used.

Parameters

valueXML:XML

Returns
Booleantrue if the font list was successfully loaded, false otherwise.
onCollectionPropertyChange()method 
protected function onCollectionPropertyChange(event:PropertyChangeEvent):void

A listener for handling changes to the application or embedded font arrays.

Parameters

event:PropertyChangeEvent

Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = FontList

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

The XML element name for FontLists.