Packagecom.adobe.portfolio.api
Interfacepublic interface IProperty

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

This interface provides support for properties displayed in the user interface.

See also

PropertyType
IPropertyContext.properties
INavigatorHost.updateProperty

Public Properties
 PropertyDefined By
  description : String
[read-only] A localized description string suitable for display in the user interface.
IProperty
  enabled : Boolean
[read-only] Returns a value of true if the control(s) representing this property should be enabled in the user interface.
IProperty
  hasMinMax : Boolean
[read-only] Returns a value of true if this property has relevant minimum or maximum values.
IProperty
  label : String
[read-only] A localized label string suitable for display in the user interface.
IProperty
  maxValue : Number
[read-only] The maximum value of this numeric property.
IProperty
  minValue : Number
[read-only] The minimum value of this numeric property.
IProperty
  name : String
[read-only] The name for this IProperty.
IProperty
  subvalues : Array
[read-only] The array of possible values for a list property.
IProperty
  subvaluesLocked : Boolean
[read-only] Returns a value of true if elements of subvalues for this property cannot be added or removed.
IProperty
  subvaluesType : String
[read-only] Identifies the data type of the IProperty elements found in the subvalues array.
IProperty
  type : String
[read-only] Identifies the data type of this IProperty.
IProperty
  value : Object
[read-only] The value for this IProperty.
IProperty
  visible : Boolean
[read-only] Returns a value of true if the control(s) representing this property should be displayed in the user interface.
IProperty
Property Detail
descriptionproperty
description:String  [read-only]

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

A localized description string suitable for display in the user interface.


Implementation
    public function get description():String
enabledproperty 
enabled:Boolean  [read-only]

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 the control(s) representing this property should be enabled in the user interface. It returns false otherwise.


Implementation
    public function get enabled():Boolean
hasMinMaxproperty 
hasMinMax:Boolean  [read-only]

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

See also

PropertyType.NUMBER
labelproperty 
label:String  [read-only]

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

A localized label string suitable for display in the user interface.


Implementation
    public function get label():String
maxValueproperty 
maxValue:Number  [read-only]

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

See also

PropertyType.NUMBER
minValueproperty 
minValue:Number  [read-only]

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

See also

PropertyType.NUMBER
nameproperty 
name:String  [read-only]

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

The name for this IProperty.

This name serves as a unique identifier, and never changes.


Implementation
    public function get name():String
subvaluesproperty 
subvalues:Array  [read-only]

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

The array of possible values for a list property.

This applies to list properties.


Implementation
    public function get subvalues():Array

See also

PropertyType.LIST
subvaluesLockedproperty 
subvaluesLocked:Boolean  [read-only]

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 elements of subvalues for this property cannot be added or removed. It returns false otherwise.

This applies to list properties.


Implementation
    public function get subvaluesLocked():Boolean

See also

PropertyType.LIST
subvaluesTypeproperty 
subvaluesType:String  [read-only]

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

Identifies the data type of the IProperty elements found in the subvalues array.

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


Implementation
    public function get subvaluesType():String

See also

PropertyType
typeproperty 
type:String  [read-only]

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
valueproperty 
value:Object  [read-only]

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

The value for this IProperty.

Its type is determined by type.


Implementation
    public function get value():Object

See also

PropertyType
visibleproperty 
visible:Boolean  [read-only]

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 the control(s) representing this property should be displayed in the user interface. It returns false otherwise.


Implementation
    public function get visible():Boolean



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

Wed Oct 13 2010, 03:44 PM -07:00