Packagecom.adobe.portfolio.properties
Classpublic class PropertyNumberValue
InheritancePropertyNumberValue Inheritance PropertyValue Inheritance flash.events.EventDispatcher
Subclasses PropertyColorValue

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 numeric.



Public Properties
 PropertyDefined By
 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
  hasMinMax : Boolean
[override] [read-only] Returns a value of true if this property has relevant minimum or maximum values.
PropertyNumberValue
  isInt : Boolean
[read-only] Returns true if the propertyNumberValue is an int; returns false otherwise.
PropertyNumberValue
  isUint : Boolean
[read-only] Returns true if the propertyNumberValue is an unsigned integer; returns false otherwise.
PropertyNumberValue
 Inheritedlabel : String
A localized label string suitable for display in the user interface.
PropertyValue
  maxValue : Number
[override] The maximum value of this numeric property.
PropertyNumberValue
  minValue : Number
[override] The minimum value of this numeric property.
PropertyNumberValue
 Inheritedname : String
The name for this IProperty.
PropertyValue
  numValue : Number
The value as a number.
PropertyNumberValue
 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
  type : String
[override] [read-only] Identifies the data type of this IProperty.
PropertyNumberValue
 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
  numType : String
The numeric type of this property.
PropertyNumberValue
 Inheritedparent : Object
The parent object of this property.
PropertyValue
Public Methods
 MethodDefined By
  
PropertyNumberValue(target:IEventDispatcher = null)
Constructor
PropertyNumberValue
 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 value from an XML object.
PropertyNumberValue
 Inherited
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 property number value equal to the specified string.
PropertyNumberValue
Protected Methods
 MethodDefined By
  
[override] Returns the XML element name for this property.
PropertyNumberValue
  
setXMLElements(propertyXML:XML):void
[override] Sets all the XML elements for this property, such as enabled, visible, label, and description.
PropertyNumberValue
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = PropertyNumber
[static] The XML element name for numeric property values
PropertyNumberValue
Property Detail
hasMinMaxproperty
hasMinMax:Boolean  [read-only] [override]

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

Returns a value of true if this property has relevant minimum or maximum values. It returns false otherwise.

This applies to numeric properties.


Implementation
    public function get hasMinMax():Boolean
isIntproperty 
isInt:Boolean  [read-only]

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

Returns true if the propertyNumberValue is an int; returns false otherwise.


Implementation
    public function get isInt():Boolean
isUintproperty 
isUint:Boolean  [read-only]

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

Returns true if the propertyNumberValue is an unsigned integer; returns false otherwise.


Implementation
    public function get isUint():Boolean
maxValueproperty 
maxValue:Number[override]

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

The maximum value of this numeric property.

This applies to numeric properties.


Implementation
    public function get maxValue():Number
    public function set maxValue(value:Number):void
minValueproperty 
minValue:Number[override]

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

The minimum value of this numeric property.

This applies to numeric properties.


Implementation
    public function get minValue():Number
    public function set minValue(value:Number):void
numTypeproperty 
protected var numType:String

The numeric type of this property. If "int" then the value is treated as an int; if "uint" then the value is treated as a uint; otherwise the value is treated as a Number.

numValueproperty 
numValue:Number

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

The value as a number. Setting this value will trigger a numValue PropertyChangeEvent as well.

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


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

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

Identifies the data type of this IProperty.

It must be one of the property types defined in PropertyType.


Implementation
    public function get type():String

See also

PropertyType.INTEGER
PropertyType.NUMBER
PropertyType.UNSIGNED_INTEGER
Constructor Detail
PropertyNumberValue()Constructor
public function PropertyNumberValue(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
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 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.
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 property number value equal to the specified string. The value parsed will depend on the numType of the propertyNumberValue. If the type is an integer or unsigned integer, the value will be parsed as an integer, otherwise it will be parse as a floating point number.

Parameters

valueString:String — The numeric value as a string.

Returns
Boolean
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 all the XML elements for this property, such as enabled, visible, label, and description. Also, set any SelectEffect XML objects in the SelectEffectsArray.

Parameters

propertyXML:XML — XML object representing the desired property

Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = PropertyNumber

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

The XML element name for numeric property values