Packagecom.adobe.portfolio.components.supportClasses
Classpublic class FieldTextArea
InheritanceFieldTextArea Inheritance CustomizableTextArea Inheritance spark.components.TextArea
Subclasses FieldTextInput

Default MXML Propertycontent



Public Properties
 PropertyDefined By
 InheritedallowStyling : Boolean
A boolean indicating whether or not this component supports styled text.
CustomizableTextArea
  data : Object
The data object whose field should be displayed.
FieldTextArea
  dateStyle : String
The style to use for the date when displaying date fields.
FieldTextArea
  editFieldDisplayName : Boolean
True if the display name of the field should be displayed, rather than the field value.
FieldTextArea
  field : IField
The field whose value is to be displayed.
FieldTextArea
  fieldName : String
The name of the field whose value is to be displayed.
FieldTextArea
 InheritedforceMeasuredWidth : Number
The number to be used as the measuredWidth when measure() is called for this component.
CustomizableTextArea
 Inheritedmultiline : Boolean
A boolean indicating whether or not this component supports multiline text.
CustomizableTextArea
  timeStyle : String
The style to use for the time when displaying date fields.
FieldTextArea
Protected Properties
 PropertyDefined By
 InheritedpendingChanges : Boolean = false
True if changes to the text have been made that have not yet been applied.
CustomizableTextArea
Public Methods
 MethodDefined By
  
Default constructor
FieldTextArea
 Inherited
A function to add event listeners and change watchers required by this canvas list.
CustomizableTextArea
 Inherited
Clears the property context for this text component as the current property context.
CustomizableTextArea
  
[override] A function to clean up event listeners and change watchers required by this canvas list.
FieldTextArea
 Inherited
Sets the property context for this text component as the current property context.
CustomizableTextArea
 Inherited
textAreaHasFocus(focusManager:IFocusManager):Boolean
[static] Return true if a TextArea component currently has focus.
CustomizableTextArea
Protected Methods
 MethodDefined By
  
[override]
FieldTextArea
 Inherited
[override]
CustomizableTextArea
 Inherited
measure():void
[override]
CustomizableTextArea
 Inherited
onCreationComplete(event:FlexEvent):void
Event listener invoked when this component is created..
CustomizableTextArea
 Inherited
Event listener invoked on CollectionManagerEvents.
CustomizableTextArea
  
onTextChanged(event:TextOperationEvent):void
[override] Event listener invoked when this components text is changed by the user.
FieldTextArea
 Inherited
partAdded(partName:String, instance:Object):void
[override]
CustomizableTextArea
  
[override] Updates the field value based on the current text.
FieldTextArea
 Inherited
setTextDirection(textStr:String):void
A function that is invoked when the text direction is changed.
CustomizableTextArea
  
[override] Updates the displayed text based on the current field value.
FieldTextArea
  
[override] Returns true if this component should be editable by the user.
FieldTextArea
 Inherited
Updates the editable state of this component based on current state.
CustomizableTextArea
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
 Inherited The disabled state for multiline text. CustomizableTextArea
  
editable
A subclass of CustomizableTextArea that's specialized for displaying and editing attachment field names and values.

See also

FieldTextArea
 Inherited The editable state for multiline text. CustomizableTextArea
 Inherited The normal state for multiline text. CustomizableTextArea
Public Constants
 ConstantDefined By
 InheritedSTATE_DISABLED : String = disabled
[static] A string literal representing the name of the disabled state.
CustomizableTextArea
 InheritedSTATE_DISABLED_MULTILINE : String = disabledMultiline
[static] A string literal representing the name of the disabled multiline state.
CustomizableTextArea
 InheritedSTATE_EDITABLE : String = editable
[static] A string literal representing the name of the editable state.
CustomizableTextArea
 InheritedSTATE_EDITABLE_MULTILINE : String = editableMultiline
[static] A string literal representing the name of the editable multiline state.
CustomizableTextArea
 InheritedSTATE_NORMAL : String = normal
[static] A string literal representing the name of the normal state.
CustomizableTextArea
 InheritedSTATE_NORMAL_MULTILINE : String = normalMultiline
[static] A string literal representing the name of the normal multiline state.
CustomizableTextArea
Protected Constants
 ConstantDefined By
 InheritedcollectionManager : CollectionManager
[static] The navigator's CollectionManager instance.
CustomizableTextArea
Property Detail
dataproperty
data:Object

The data object whose field should be displayed. Only IAttachment objects are supported.

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


Implementation
    public function get data():Object
    public function set data(value:Object):void
dateStyleproperty 
dateStyle:String

The style to use for the date when displaying date fields.


Implementation
    public function get dateStyle():String
    public function set dateStyle(value:String):void

See also

DateTimeStyle
editFieldDisplayNameproperty 
editFieldDisplayName:Boolean

True if the display name of the field should be displayed, rather than the field value.


Implementation
    public function get editFieldDisplayName():Boolean
    public function set editFieldDisplayName(value:Boolean):void
fieldproperty 
field:IField

The field whose value is to be displayed.


Implementation
    public function get field():IField
    public function set field(value:IField):void
fieldNameproperty 
fieldName:String

The name of the field whose value is to be displayed.

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


Implementation
    public function get fieldName():String
    public function set fieldName(value:String):void
timeStyleproperty 
timeStyle:String

The style to use for the time when displaying date fields.


Implementation
    public function get timeStyle():String
    public function set timeStyle(value:String):void

See also

DateTimeStyle
Constructor Detail
FieldTextArea()Constructor
public function FieldTextArea()

Default constructor

Method Detail
commitProperties()method
override protected function commitProperties():void

onTextChanged()method 
override protected function onTextChanged(event:TextOperationEvent):void

Event listener invoked when this components text is changed by the user.

Parameters

event:TextOperationEvent

removeListenAndWatch()method 
override public function removeListenAndWatch():void

A function to clean up event listeners and change watchers required by this canvas list.

setDataFromText()method 
override protected function setDataFromText():void

Updates the field value based on the current text. Applies pending text changes to the data model. Subclasses should override this function.

setTextFromData()method 
override protected function setTextFromData():void

Updates the displayed text based on the current field value. Updates this component's text based on the data model. Subclasses should override this function.

shouldBeEditable()method 
override protected function shouldBeEditable():Boolean

Returns true if this component should be editable by the user.

Returns
Boolean