| Package | com.adobe.portfolio.properties |
| Class | public class PropertyNumberValue |
| Inheritance | PropertyNumberValue  PropertyValue flash.events.EventDispatcher |
| Subclasses | PropertyColorValue |
| Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
| Property | Defined By | ||
|---|---|---|---|
 | 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 [override] [read-only]
Returns true if the propertyNumberValue has either a minimum value
or a maximum value or both set; returns false otherwise. | 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 | ||
| label : String
The localized label string for this IProperty, suitable for display in the user interface. | PropertyValue | |
| maxValue : Number [override] [read-only]
Returns the maximum value set for the propertyNumberValue. | PropertyNumberValue | ||
| minValue : Number [override] [read-only]
Returns the minimum value set for the propertyNumberValue. | PropertyNumberValue | ||
| name : String
The name for this IProperty. | PropertyValue | |
| numValue : Number
The value as a number. | PropertyNumberValue | ||
| subvalues : Array [read-only]
An array of all properties (of type IPropertyValue) within this list. | 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]
Returns the type of the properties within this list;
one of the string constants defined by PropertyType
| PropertyValue | |
| type : String [override] [read-only]
Returns the type of the number value property, which may be
INTEGER, UNSIGNED_INTEGER, or NUMBER. | PropertyNumberValue | ||
| 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 | |
| Property | Defined By | ||
|---|---|---|---|
| descriptionDefault : String
The default description string to be used when the localized description is unavailable. | PropertyValue | |
| descriptionKey : String
The string used as a key to request a localized description string. | PropertyValue | |
| dontPlayEffectsCounter : uint = 0
A counter used to keep track of when to run the side effects. | PropertyValue | |
| initializing : Boolean
Returns true if the property is in an initializing state,
false otherwise. | PropertyValue | |
| labelDefault : String
The default label string to be used when the localized label is unavailable. | PropertyValue | |
| labelKey : String
The string used as a key to request a localized label string. | PropertyValue | |
| _maxValue : Number = Infinity | PropertyNumberValue | ||
| _minValue : Number = -Infinity | PropertyNumberValue | ||
| numType : String | PropertyNumberValue | ||
| parent : Object
The parent object of this property. | PropertyValue | |
| Method | Defined By | ||
|---|---|---|---|
PropertyNumberValue(target:IEventDispatcher = null)
Constructor
| PropertyNumberValue | ||
| 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. | PropertyValue | |
loadFromXML(valueXML:XML):Boolean [override]
Loads the property value from the specified XML value. | PropertyNumberValue | ||
| 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 property number value equal to the specified string. | PropertyNumberValue | ||
| Method | Defined By | ||
|---|---|---|---|
getXMLElementName():String [override]
Returns the XML element name for numeric property values
| PropertyNumberValue | ||
setXMLElements(propertyXML:XML):void [override]
Sets the XML properties of the propertyXML object passed to it
to the value of the current propertyNumberValue. | PropertyNumberValue | ||
| Constant | Defined By | ||
|---|---|---|---|
| XML_ELEMENT_NAME : String = PropertyNumber [static]
The XML element name for numeric property values
| PropertyNumberValue | ||
| _maxValue | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _maxValue:Number = Infinity| _minValue | property |
protected var _minValue:Number = -Infinity| hasMinMax | property |
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 true if the propertyNumberValue has either a minimum value
or a maximum value or both set; returns false otherwise.
public function get hasMinMax():Boolean| isInt | property |
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.
public function get isInt():Boolean| isUint | property |
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.
public function get isUint():Boolean| maxValue | property |
maxValue:Number [read-only] [override] | Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Returns the maximum value set for the propertyNumberValue.
public function get maxValue():Number| minValue | property |
minValue:Number [read-only] [override] | Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Returns the minimum value set for the propertyNumberValue.
public function get minValue():Number| numType | property |
protected var numType:String| numValue | property |
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.
public function get numValue():Number public function set numValue(value:Number):void| type | property |
type:String [read-only] [override] | Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Returns the type of the number value property, which may be
INTEGER, UNSIGNED_INTEGER, or NUMBER.
public function get type():String| 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
Parameterstarget:IEventDispatcher (default = null) |
| 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 numeric property values
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 property value from the specified XML value.
Parameters
valueXML:XML — The XML object that contains the numeric value to load.
|
Boolean |
| 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.
|
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 the XML properties of the propertyXML object passed to it to the value of the current propertyNumberValue.
Parameters
propertyXML:XML — The XML property to which you want to set the
numeric property value.
|
| XML_ELEMENT_NAME | Constant |
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