Packagecom.adobe.xmp.components
Classpublic class XMPTextInputMRU
InheritanceXMPTextInputMRU Inheritance XMPTextInput Inheritance mx.controls.TextInput

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

True to track and collect 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]

Name of the field in the items in the dataProvider Array to display 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 function to run on each item to determine its label. By default the control uses a property named label on each dataProvider item to determine its label. However, some data sets do not have a label property, or do not have another property that can be used for displaying as a label.

An example is a data set that has lastName and firstName fields but you want to display full names. You use labelFunction to specify a callback function that uses the appropriate fields and return a displayable String.

The labelFunction takes a single argument which is the item in the dataProvider 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
XMPTextInputMRU()constructor
public function XMPTextInputMRU()

Creates a text-input component with a drop-down list of auto-completion 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