com.adobe.portfolio.properties.PropertyBooleanValue

Public Properties

	Property		Defined By
		booleanValue : Boolean The Boolean property value	PropertyBooleanValue
		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 true if this property has meaningful minimum or maximum values.	PropertyValue
		label : String The localized label string for this IProperty, suitable for display in the user interface.	PropertyValue
		maxValue : Number [read-only] The maximum value of this property, as specified by the navigator.	PropertyValue
		minValue : Number [read-only] The minimum value of this property, as specified by the navigator.	PropertyValue
		name : String The name for this IProperty.	PropertyValue
		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, which is BOOLEAN, of the property.	PropertyBooleanValue
		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
		parent : Object The parent object of this property.	PropertyValue

	Method	Defined By
		PropertyBooleanValue(target:IEventDispatcher = null) Constructor	PropertyBooleanValue
		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 Boolean value from the specified XML value object.	PropertyBooleanValue
		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] Sets the propertyBooleanValue to the value represented by the specified string.	PropertyBooleanValue

	Method	Defined By
		getXMLElementName():String [override] Returns the XML element name for Boolean property values	PropertyBooleanValue
		setXMLElements(propertyXML:XML):void [override] Sets the XML property value to the propertyBooleanValue which contains the property value.	PropertyBooleanValue

	Constant	Defined By
		XML_ELEMENT_NAME : String = PropertyBoolean [static] The XML element name for Boolean property values	PropertyBooleanValue

Property Detail

booleanValue

property

booleanValue:Boolean

Language Version :

ActionScript 3.0

Product Version :

Portfolio 10.0

Runtime Versions :

Flash Player 10.1, AIR 2.0

The Boolean property value

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

Implementation
public function get booleanValue():Boolean
public function set booleanValue(value:Boolean):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, which is BOOLEAN, of the property.

Implementation
public function get type():String

Constructor Detail

PropertyBooleanValue

()

Constructor

public function PropertyBooleanValue(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 Boolean property values

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 Boolean value from the specified XML value object.

Parameters

valueXML:XML — The XML object that contains the Boolean value to load.

Returns

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

Sets the propertyBooleanValue to the value represented by the specified string.

Parameters

valueString:String — This string should be either "true" or "false" (case insensitive)

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 the XML property value to the propertyBooleanValue which contains the property value.

Parameters

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

Constant Detail

XML_ELEMENT_NAME

Constant

public static const XML_ELEMENT_NAME:String = PropertyBoolean

Language Version :

ActionScript 3.0

Product Version :

Portfolio 10.0

Runtime Versions :

Flash Player 10.1, AIR 2.0

The XML element name for Boolean property values

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

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PropertyBooleanValue	Properties \| Methods \| Constants

Package	com.adobe.portfolio.properties
Class	public class PropertyBooleanValue
Inheritance	PropertyBooleanValue PropertyValue flash.events.EventDispatcher