Package | com.adobe.portfolio.components.supportClasses |
Class | public class FieldTextArea |
Inheritance | FieldTextArea ![]() ![]() |
Subclasses | FieldTextInput |
Default MXML Propertycontent
Property | Defined By | ||
---|---|---|---|
![]() | allowStyling : 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 | ||
![]() | forceMeasuredWidth : Number
The number to be used as the measuredWidth when measure() is called
for this component. | CustomizableTextArea | |
![]() | multiline : 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 |
Method | Defined By | ||
---|---|---|---|
Default constructor
| FieldTextArea | ||
![]() | addListenAndWatch():void
A function to add event listeners and change watchers required by this canvas list. | CustomizableTextArea | |
![]() | loseContext():void
Clears the property context for this text component as the current property context. | CustomizableTextArea | |
removeListenAndWatch():void [override]
A function to clean up event listeners and change watchers required by this canvas list. | FieldTextArea | ||
![]() | takeContext():void
Sets the property context for this text component as the current property context. | CustomizableTextArea | |
![]() | textAreaHasFocus(focusManager:IFocusManager):Boolean [static]
Return true if a TextArea component currently has focus. | CustomizableTextArea |
Method | Defined By | ||
---|---|---|---|
commitProperties():void [override]
| FieldTextArea | ||
![]() | getCurrentSkinState():String [override]
| CustomizableTextArea | |
![]() | measure():void [override]
| CustomizableTextArea | |
![]() | onCreationComplete(event:FlexEvent):void
Event listener invoked when this component is created.. | CustomizableTextArea | |
![]() | onNavHostEvent(event:CollectionManagerEvent):void
Event listener invoked on CollectionManagerEvents. | CustomizableTextArea | |
onTextChanged(event:TextOperationEvent):void [override]
Event listener invoked when this components text is changed by the user. | FieldTextArea | ||
![]() | partAdded(partName:String, instance:Object):void [override]
| CustomizableTextArea | |
setDataFromText():void [override]
Updates the field value based on the current text. | FieldTextArea | ||
![]() | setTextDirection(textStr:String):void
A function that is invoked when the text direction is changed. | CustomizableTextArea | |
setTextFromData():void [override]
Updates the displayed text based on the current field value. | FieldTextArea | ||
shouldBeEditable():Boolean [override]
Returns true if this component should be editable by the user. | FieldTextArea | ||
![]() | updateEditable():void
Updates the editable state of this component based on current state. | CustomizableTextArea |
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 | ||
---|---|---|---|---|
![]() | 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 CustomizableTextArea IField | FieldTextArea | ||
![]() | The editable state for multiline text. | CustomizableTextArea | ||
![]() | The normal state for multiline text. | CustomizableTextArea |
data | property |
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.
public function get data():Object
public function set data(value:Object):void
dateStyle | property |
dateStyle:String
The style to use for the date when displaying date fields.
public function get dateStyle():String
public function set dateStyle(value:String):void
See also
editFieldDisplayName | property |
editFieldDisplayName:Boolean
True if the display name of the field should be displayed, rather than the field value.
public function get editFieldDisplayName():Boolean
public function set editFieldDisplayName(value:Boolean):void
field | property |
field:IField
The field whose value is to be displayed.
public function get field():IField
public function set field(value:IField):void
fieldName | property |
fieldName:String
The name of the field whose value is to be displayed.
This property can be used as the source for data binding.
public function get fieldName():String
public function set fieldName(value:String):void
timeStyle | property |
timeStyle:String
The style to use for the time when displaying date fields.
public function get timeStyle():String
public function set timeStyle(value:String):void
See also
FieldTextArea | () | Constructor |
public function FieldTextArea()
Default constructor
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.
ReturnsBoolean |