Package | com.adobe.xmp.components |
Class | public class XMPDateField |
Inheritance | XMPDateField ![]() |
Implements | IXMPComponent |
Default MXML PropertyselectedDate
Property | Defined by | ||
---|---|---|---|
dateFormatString : String The date-time value string in the required format
| XMPDateField | ||
dateTimeSeparator : String = " " When
includeTime == true , the separator character
to be used between date and time portions of the field value. | XMPDateField | ||
includeTime : Boolean = true
When true, a time value (as well as a date) can be entered in the
TextInput field of this component.
| XMPDateField | ||
modified : Boolean
True if the user has modified the XMP value.
| XMPDateField | ||
timeFormatString : String The time value string in the required format
| XMPDateField | ||
writeEmptyValues : Boolean = false When true, empty XMP property values are included when the XMP is
written out, when false, they are deleted.
| XMPDateField | ||
xmpPath : String The XMP path for the field associated with this component.
| XMPDateField |
Method | Defined by | ||
---|---|---|---|
multivalueHandler(event:XMPEvent):void
A handler for the
xmpMultivalue event. | XMPDateField | ||
A handler for the
xmpRead event. | XMPDateField | ||
A handler for the
xmpWrite event. | XMPDateField |
Event | Summary | Defined by | ||
---|---|---|---|---|
Occurs when the value of this component has been changed. | XMPDateField | |||
Occurs when user opens this panel. | XMPDateField | |||
Occurs when user closes this panel. | XMPDateField |
dateFormatString | property |
dateFormatString:String
[read-write]The date-time value string in the required format
Implementation public function get dateFormatString():String
public function set dateFormatString(value:String):void
dateTimeSeparator | property |
public var dateTimeSeparator:String = " "
When includeTime == true
, the separator character
to be used between date and time portions of the field value.
The default value is " "
.
includeTime | property |
public var includeTime:Boolean = true
When true, a time value (as well as a date) can be entered in the TextInput field of this component. The time is removed if the user selects a date in the calendar popup.
The default value is true
.
modified | property |
modified:Boolean
[read-write]True if the user has modified the XMP value. False if the value is reset to its original value, which happens ony in the multiple file mode, when the Modification checkbox is deselected.
Implementation public function get modified():Boolean
public function set modified(value:Boolean):void
timeFormatString | property |
timeFormatString:String
[read-write]The time value string in the required format
Implementation public function get timeFormatString():String
public function set timeFormatString(value:String):void
writeEmptyValues | property |
public var writeEmptyValues:Boolean = false
When true, empty XMP property values are included when the XMP is written out, when false, they are deleted.
The default value is false
.
xmpPath | property |
xmpPath:String
[read-write]The XMP path for the field associated with this component. The path can be nested, or direct to an array, struct or qualifier. Path expressions make use of XML namespaces; all prefixes must be registered.
Implementation public function get xmpPath():String
public function set xmpPath(value:String):void
multivalueHandler | () | method |
public function multivalueHandler(event:XMPEvent):void
A handler for the xmpMultivalue
event.
Called if the File Info dialog is started in multiple-file mode.
event:XMPEvent — The event object for a user-interaction event.
|
readXMP | () | method |
public function readXMP(event:XMPEvent):void
A handler for the xmpRead
event.
The default handler updates the component in response to a user-interaction event,
using information retrieved from the associated XMP property.
event:XMPEvent — The event object for a user-interaction event.
|
writeXMP | () | method |
public function writeXMP(event:XMPEvent):void
A handler for the xmpWrite
event.
The default handler updates the associated XMP property value
with the current value of this component, in response to a user-interaction event.
It writes the property back to the packet only if the modified
flag is true.
It writes empty values only if the writeEmptyValues
flag is true.
event:XMPEvent — The event object for a user-interaction event.
|
xmpModification | event |
com.adobe.xmp.events.XMPEvent
Occurs when the value of this component has been changed. Default handler sets the "modified" flag.
xmpRead | event |
com.adobe.xmp.events.XMPEvent
Occurs when user opens this panel. Default handler reads the associated XMP value and updates the display value.
xmpWrite | event |
com.adobe.xmp.events.XMPEvent
Occurs when user closes this panel. Default handler writes the associated XMP value from the current component value.