Packagecom.adobe.portfolio.utils
Classpublic class FieldUtils
InheritanceFieldUtils Inheritance Object

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

The FieldUtils class is a set of utility functions for setting and getting attachment field values.


Public Methods
 MethodDefined By
  
FieldUtils()
FieldUtils
  
getAttachmentPropertyName(field:IField):String
[static]
FieldUtils
  
getDisplayNameByFieldName(fields:Array, fieldName:String, includeColon:Boolean = false):String
[static]
FieldUtils
  
getFieldByFieldName(fields:Array, fieldName:String, allowFallback:Boolean = true):IField
[static]
FieldUtils
  
getFieldValue(item:IAttachment, field:IField):*
[static]
FieldUtils
  
getFieldValueOrProperty(item:IAttachment, field:IField, prop:String):*
[static]
FieldUtils
  
getStyledTextFromField(attachment:IAttachment, field:IField):XML
[static]
FieldUtils
  
getTextFromField(attachment:IAttachment, field:IField, dateStyle:String, timeStyle:String):String
[static]
FieldUtils
  
isPropertyOfAttachment(field:IField):Boolean
[static]
FieldUtils
  
isUserDefinedField(field:IField):Boolean
[static]
FieldUtils
  
setFieldDisplayNameFromText(collection:ICollection, fieldName:String, displayName:String):Boolean
[static]
FieldUtils
  
setFieldFromText(attachment:IAttachment, field:IField, fieldText:String):Boolean
[static]
FieldUtils
  
setFieldValue(item:IAttachment, field:IField, value:*):void
[static]
FieldUtils
Public Constants
 ConstantDefined By
  DISPLAY_NAME_FIELD_NAME : String = adobe:DisplayName
[static]
FieldUtils
  TAGS_FIELD_NAME : String = adobe:Tags
[static]
FieldUtils
Constructor Detail
FieldUtils()Constructor
public function FieldUtils()



Method Detail
getAttachmentPropertyName()method
public static function getAttachmentPropertyName(field:IField):String

Parameters

field:IField

Returns
String
getDisplayNameByFieldName()method 
public static function getDisplayNameByFieldName(fields:Array, fieldName:String, includeColon:Boolean = false):String

Parameters

fields:Array
 
fieldName:String
 
includeColon:Boolean (default = false)

Returns
String
getFieldByFieldName()method 
public static function getFieldByFieldName(fields:Array, fieldName:String, allowFallback:Boolean = true):IField

Parameters

fields:Array
 
fieldName:String
 
allowFallback:Boolean (default = true)

Returns
IField
getFieldValue()method 
public static function getFieldValue(item:IAttachment, field:IField):*

Parameters

item:IAttachment
 
field:IField

Returns
*
getFieldValueOrProperty()method 
public static function getFieldValueOrProperty(item:IAttachment, field:IField, prop:String):*

Parameters

item:IAttachment
 
field:IField
 
prop:String

Returns
*
getStyledTextFromField()method 
public static function getStyledTextFromField(attachment:IAttachment, field:IField):XML

Parameters

attachment:IAttachment
 
field:IField

Returns
XML
getTextFromField()method 
public static function getTextFromField(attachment:IAttachment, field:IField, dateStyle:String, timeStyle:String):String

Parameters

attachment:IAttachment
 
field:IField
 
dateStyle:String
 
timeStyle:String

Returns
String
isPropertyOfAttachment()method 
public static function isPropertyOfAttachment(field:IField):Boolean

Parameters

field:IField

Returns
Boolean
isUserDefinedField()method 
public static function isUserDefinedField(field:IField):Boolean

Parameters

field:IField

Returns
Boolean
setFieldDisplayNameFromText()method 
public static function setFieldDisplayNameFromText(collection:ICollection, fieldName:String, displayName:String):Boolean

Parameters

collection:ICollection
 
fieldName:String
 
displayName:String

Returns
Boolean
setFieldFromText()method 
public static function setFieldFromText(attachment:IAttachment, field:IField, fieldText:String):Boolean

Parameters

attachment:IAttachment
 
field:IField
 
fieldText:String

Returns
Boolean
setFieldValue()method 
public static function setFieldValue(item:IAttachment, field:IField, value:*):void

Parameters

item:IAttachment
 
field:IField
 
value:*

Constant Detail
DISPLAY_NAME_FIELD_NAMEConstant
public static const DISPLAY_NAME_FIELD_NAME:String = adobe:DisplayName

TAGS_FIELD_NAMEConstant 
public static const TAGS_FIELD_NAME:String = adobe:Tags




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

Thu Oct 14 2010, 03:29 PM -07:00