Package | com.adobe.xmp.components |
Class | public class XMPTextAreaMRU |
Inheritance | XMPTextAreaMRU ![]() ![]() |
Default MXML PropertydataProvider
Property | Defined by | ||
---|---|---|---|
![]() | allowCommas : 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 | ||
![]() | formatFunction : Function
A custom formatting function for single values.
| XMPTextArea | |
![]() | formatString : 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 | ||
![]() | modified : 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 | ||
![]() | parseValue : Function = null
A custom parsing function for single values.
| XMPTextArea | |
rowCount : int
Maximum number of rows visible in the autocompletion list.
| XMPTextAreaMRU | ||
![]() | useThousandsSeparator : Boolean When true, a separator character is used after the thousands place to
evaluate and render XMP types "Integer" and "Real".
| XMPTextArea | |
![]() | writeEmptyValues : 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:
| XMPTextAreaMRU | ||
![]() | xmpFormat : String
A format string used to add prefixes or postfixes to single XMP values,
after they have been returned from the formatting function.
| XMPTextArea | |
![]() | xmpPath : String The XMP path for the field associated with this component.
| XMPTextArea | |
![]() | xmpSeparator : String | XMPTextArea | |
![]() | xmpType : String The XMP data type of the field associated with this component, one of:
| XMPTextArea |
Method | Defined 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 | ||
![]() |
multivalueHandler(event:XMPEvent):void
A handler for the
xmpMultivalue event. | XMPTextArea | |
![]() |
A handler for the
xmpRead event. | XMPTextArea | |
![]() |
A handler for the
xmpRead event. | XMPTextArea |
Event | Summary | Defined by | ||
---|---|---|---|---|
Fired when MRU dropdown closes | XMPTextAreaMRU | |||
Fired when MRU dropdown opens | XMPTextAreaMRU | |||
![]() | Occurs when the value of this component has been changed. | XMPTextArea | ||
![]() | Occurs when user opens this panel. | XMPTextArea | ||
![]() | Occurs when user closes this panel. | XMPTextArea |
dataProvider | property |
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
enableMRU | property |
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
labelField | property |
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
labelFunction | property |
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):StringImplementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
mruKey | property |
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.
public function get mruKey():String
public function set mruKey(value:String):void
rowCount | property |
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
xmpArray | property |
xmpArray:String
[read-write]The XMP multi-value data type of the field associated with component, one of:
The default value is none
.
public function get xmpArray():String
public function set xmpArray(value:String):void
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.
mruClose | event |
mruOpen | event |