Package | com.adobe.portfolio.properties |
Class | public class PropertyStringValue |
Inheritance | PropertyStringValue ![]() ![]() |
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 [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 | |
stringValue : String
The value of the property as a string. | PropertyStringValue | ||
![]() | 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 [override] [read-only]
Identifies the data type of this IProperty. | PropertyStringValue | ||
![]() | 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 | ||
---|---|---|---|
PropertyStringValue(target:IEventDispatcher = null)
Constructor
| PropertyStringValue | ||
![]() | 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]
Load the specified value from an XML object. | PropertyStringValue | ||
![]() | 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 string value equal to the specified string. | PropertyStringValue |
Method | Defined By | ||
---|---|---|---|
getXMLElementName():String [override]
Returns the XML element name for this property. | PropertyStringValue | ||
setXMLElements(propertyXML:XML):void [override]
Sets all the XML elements for this property, such as
enabled, visible, label, and description. | PropertyStringValue |
Constant | Defined By | ||
---|---|---|---|
XML_ELEMENT_NAME : String = PropertyString [static]
The XML element name for string property values
| PropertyStringValue |
stringValue | property |
stringValue:String
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The value of the property as a string.
This property can be used as the source for data binding.
public function get stringValue():String
public function set stringValue(value:String):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 |
Identifies the data type of this IProperty
.
It must be one of the property types defined in PropertyType
.
public function get type():String
See also
PropertyStringValue | () | Constructor |
public function PropertyStringValue(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 this property.
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 |
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.
|
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 string value equal to the specified string.
Parameters
valueString:String — The string you want to use as the value.
|
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
|
XML_ELEMENT_NAME | Constant |
public static const XML_ELEMENT_NAME:String = PropertyString
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The XML element name for string property values