Packagecom.adobe.portfolio.properties
Classpublic class ThemeFilteredList
InheritanceThemeFilteredList 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

This class handles property values that are theme filtered lists. Theme filtered lists are property lists that filter out subvalues whose names match those of themes that are not currently active.


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 true if this property has meaningful minimum or maximum values.
PropertyValue
 Inheritedlabel : String
The localized label string for this IProperty, suitable for display in the user interface.
PropertyValue
 InheritedmaxValue : Number
[read-only] The maximum value of this property, as specified by the navigator.
PropertyValue
 InheritedminValue : Number
[read-only] The minimum value of this property, as specified by the navigator.
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] The type (LIST) of the PropertyListValue
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
  completeSubvalues : Array
The complete (unfiltered) list of themes
ThemeFilteredList
  currentThemeName : String
The name of the current active theme
ThemeFilteredList
  currentThemeWatcher : ChangeWatcher
The current watcher checking for changed theme events
ThemeFilteredList
 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
  filteredSubvalues : Array
The filtered list of themes
ThemeFilteredList
 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
 InheritedloadAndSaveValues : Boolean
[read-only] Returns false if loading and saving values to and from XML should be skipped.
PropertyListValue
 Inheritedparent : Object
The parent object of this property.
PropertyValue
 InheritedshouldOutputSubvalues : Boolean
[read-only] XXXXX
PropertyListValue
 Inherited_subvalues : Array
The array of possible values for a PropertyList
PropertyListValue
  themedSubvalues : ArrayCollection
??? Not sure what this is
ThemeFilteredList
  themeNames : ArrayCollection
An array of all theme names
ThemeFilteredList
Public Methods
 MethodDefined By
  
ThemeFilteredList(target:IEventDispatcher = null)
Constructor
ThemeFilteredList
 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
generateXML():XML
Create an XML object with all its XML elements.
PropertyValue
  
loadFromXML(valueXML:XML):Boolean
[override] Loads the list of theme subvalues to filter out from the specified XML value.
ThemeFilteredList
 Inherited
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
[override] Set the theme filtered list's active subvalue (the value that is being filtered out) equal to the specified string.
ThemeFilteredList
  
updateSubvalues(newSubvalues:Array, newActiveValue:PropertyValue = null):void
[override] Update the subvalues and active value of the theme filtered list to the new filter list and active value
ThemeFilteredList
Protected Methods
 MethodDefined By
  
buildThemedSubvalues(valueArray:Array, forceRebuild:Boolean = false):Boolean
Create the list of themed subvalues from the valueArray passed.
ThemeFilteredList
  
getXMLElementName():String
[override] Returns the XML element name for ThemeFilteredLists.
ThemeFilteredList
  
setActiveTheme(value:PropertyValue):void
Sets the current active theme.
ThemeFilteredList
  
setThemeList(value:PropertyListValue):void
Sets the theme list to use for filtering and updates the current theme watcher.
ThemeFilteredList
  
setXMLElements(propertyXML:XML):void
[override] Sets the XML properties of the propertyXML object passed to it to the complete set of subvalues of the themeFilteredList.
ThemeFilteredList
  
updateFilteredValues(newSubvalues:Array, newActiveValue:PropertyValue):PropertyValue
Update the list of filtered themes based on the new subValues passed
ThemeFilteredList
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = ThemeFilteredList
[static] The XML element name for theme filtered lists
ThemeFilteredList
Property Detail
completeSubvaluesproperty
protected var completeSubvalues:Array

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

The complete (unfiltered) list of themes

currentThemeNameproperty 
protected var currentThemeName:String

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

The name of the current active theme

currentThemeWatcherproperty 
protected var currentThemeWatcher:ChangeWatcher

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

The current watcher checking for changed theme events

filteredSubvaluesproperty 
protected var filteredSubvalues:Array

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

The filtered list of themes

themedSubvaluesproperty 
protected var themedSubvalues:ArrayCollection

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

??? Not sure what this is

themeNamesproperty 
protected var themeNames:ArrayCollection

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

An array of all theme names

Constructor Detail
ThemeFilteredList()Constructor
public function ThemeFilteredList(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
buildThemedSubvalues()method
protected function buildThemedSubvalues(valueArray:Array, forceRebuild:Boolean = false):Boolean

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

Create the list of themed subvalues from the valueArray passed.

Parameters

valueArray:Array — The new list of value to
 
forceRebuild:Boolean (default = false) — If forceRebuild is false (the default), the themedSubvalues array with not be rebuilt if it already exists. If forceRebuild is true the current themedSubvalues array will be replaced with the new list.

Returns
Boolean — true if the list of themed values could be built, otherwise false.
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 ThemeFilteredLists.

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 list of theme subvalues to filter out from the specified XML value.

Parameters

valueXML:XML — The XML object that contains the skinlist of skins to user for filtering.

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

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

Sets the current active theme.

Parameters

value:PropertyValue — The theme to set as the current active theme.

setThemeList()method 
protected function setThemeList(value:PropertyListValue):void

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

Sets the theme list to use for filtering and updates the current theme watcher.

Parameters

value:PropertyListValue — The list of themes on which to filter

setValueFromString()method 
override public function setValueFromString(valueString:String):Boolean

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

Set the theme filtered list's active subvalue (the value that is being filtered out) equal to the specified string.

Parameters

valueString:String — The desired value to filter out, expressed as a string.

Returns
Boolean — Returns true if the specified value is being filterd out, otherwise it returns false
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

Sets the XML properties of the propertyXML object passed to it to the complete set of subvalues of the themeFilteredList.

Parameters

propertyXML:XML — The XML property to which you want to set the binary property value.

updateFilteredValues()method 
protected function updateFilteredValues(newSubvalues:Array, newActiveValue:PropertyValue):PropertyValue

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

Update the list of filtered themes based on the new subValues passed

Parameters

newSubvalues:Array — The new list of theme values to use for filtering
 
newActiveValue:PropertyValue — The value to use as the new active value

Returns
PropertyValue — Returns the currentTheme if that is part of the newSubvalues list. Otherwise it returns the newActiveValue.
updateSubvalues()method 
override public function updateSubvalues(newSubvalues:Array, newActiveValue:PropertyValue = null):void

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

Update the subvalues and active value of the theme filtered list to the new filter list and active value

Parameters

newSubvalues:Array — The new list of theme values to use for filtering
 
newActiveValue:PropertyValue (default = null) — The value to use as the new active value

Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = ThemeFilteredList

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

The XML element name for theme filtered lists




Copyright Adobe Systems Incorporated, all rights reserved, for internal use only

Mon Oct 11 2010, 01:58 PM -07:00