Packagecom.adobe.xmp.components
Classpublic class XMPTextAreaMRU
InheritanceXMPTextAreaMRU Inheritance XMPTextArea Inheritance mx.controls.TextArea

A text-area component with MRU capability. The component can have a drop-down list of auto-completion values, provided programmatically.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined by
 InheritedallowCommas : Boolean
When true, commas can be accepted as part of the value in arrays (xmpArray != null).
XMPTextArea
  dataProvider : Object
[write-only] The list of autocompletion items with which to populate the drop-down menu of the component.
XMPTextAreaMRU
  enableMRU : Boolean
Whether to track entries that are typed into the control and save the history into the MRU manager.
XMPTextAreaMRU
 InheritedformatFunction : Function
A custom formatting function for single values.
XMPTextArea
 InheritedformatString : String
The format to use to evaluate and render date-time values when XMP type is "Date".
XMPTextArea
  labelField : String
The display label for an item in the completions list, to be shown as the autocomplete entry in the drop-down list.
XMPTextAreaMRU
  labelFunction : Function
User-supplied label-generation function to run on each item in the completions list to determine its label.
XMPTextAreaMRU
 Inheritedmodified : Boolean
True if the user has modified the XMP value.
XMPTextArea
  mruKey : String
A key that the MRU manager can use to store or retrieve the MRU list for this component.
XMPTextAreaMRU
 InheritedparseValue : Function = null
A custom parsing function for single values.
XMPTextArea
  rowCount : int
Maximum number of rows visible in the autocompletion list.
XMPTextAreaMRU
 InheriteduseThousandsSeparator : Boolean
When true, a separator character is used after the thousands place to evaluate and render XMP types "Integer" and "Real".
XMPTextArea
 InheritedwriteEmptyValues : Boolean
When true, empty XMP property values are included when the XMP is written out, when false, they are deleted.
XMPTextArea
  xmpArray : String
The XMP multi-value data type of the field associated with component, one of:
  • none
  • bag
  • seq
  • alt
XMPTextAreaMRU
 InheritedxmpFormat : String
A format string used to add prefixes or postfixes to single XMP values, after they have been returned from the formatting function.
XMPTextArea
 InheritedxmpPath : String
The XMP path for the field associated with this component.
XMPTextArea
 InheritedxmpSeparator : String
XMPTextArea
 InheritedxmpType : String
The XMP data type of the field associated with this component, one of:
  • Text
  • Integer
  • Real
  • Boolean
  • Date
  • Localized
XMPTextArea
Public Methods
 MethodDefined by
  
Creates a text-area component with a drop-down list of autocompletion values, suitable for displaying the list of most-recently-used (MRU) values.
XMPTextAreaMRU
 Inherited
A handler for the xmpMultivalue event.
XMPTextArea
 Inherited
readXMP(event:XMPEvent):void
A handler for the xmpRead event.
XMPTextArea
 Inherited
writeXMP(event:XMPEvent):void
A handler for the xmpRead event.
XMPTextArea
Events
 EventSummaryDefined by
   Fired when MRU dropdown closes XMPTextAreaMRU
   Fired when MRU dropdown opens XMPTextAreaMRU
 Inherited Occurs when the value of this component has been changed.XMPTextArea
 Inherited Occurs when user opens this panel.XMPTextArea
 Inherited Occurs when user closes this panel.XMPTextArea
Property detail
dataProviderproperty
dataProvider:Object  [write-only]

The list of autocompletion items with which to populate the drop-down menu of the component.

Implementation
    public function set dataProvider(value:Object):void
enableMRUproperty 
enableMRU:Boolean  [read-write]

Whether to track entries that are typed into the control and save the history into the MRU manager. The global setting of the MRU Manager has preference

Implementation
    public function get enableMRU():Boolean
    public function set enableMRU(value:Boolean):void
labelFieldproperty 
labelField:String  [read-write]

The display label for an item in the completions list, to be shown as the autocomplete entry in the drop-down list.

Implementation
    public function get labelField():String
    public function set labelField(value:String):void
labelFunctionproperty 
labelFunction:Function  [read-write]

User-supplied label-generation function to run on each item in the completions list to determine its label. By default, the control uses a property named label on each item to determine its label. However, some data sets do not have a label property, or similar property that can be used for displaying as a label.

An example is a data set that has lastName and firstName fields, for which you want to display full names. You can use this callback function to access the appropriate fields and return a displayable String.

This function takes a single argument, the item in the autocompletion list, and returns a String:

      myLabelFunction(item:Object):String
      
Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
mruKeyproperty 
mruKey:String  [read-write]

A key that the MRU manager can use to store or retrieve the MRU list for this component. If the key value is null, the component's xmpPath value is used as the key. If the key value and xmpPath value are both null, the component ID is used.

Implementation
    public function get mruKey():String
    public function set mruKey(value:String):void
rowCountproperty 
rowCount:int  [read-write]

Maximum number of rows visible in the autocompletion list. If there are fewer items in the collection, the list shows only as many rows as there are items.

Implementation
    public function get rowCount():int
    public function set rowCount(value:int):void
xmpArrayproperty 
xmpArray:String  [read-write]

The XMP multi-value data type of the field associated with component, one of:

The default value is none.

Implementation
    public function get xmpArray():String
    public function set xmpArray(value:String):void
Constructor detail
XMPTextAreaMRU()constructor
public function XMPTextAreaMRU()

Creates a text-area component with a drop-down list of autocompletion values, suitable for displaying the list of most-recently-used (MRU) values.

Event detail
mruCloseevent 
Event object type: com.adobe.xmp.events.MRUEvent

Fired when MRU dropdown closes

mruOpenevent  
Event object type: com.adobe.xmp.events.MRUEvent

Fired when MRU dropdown opens