|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object tv.amwa.maj.entity.InterchangeObject tv.amwa.maj.entity.Component tv.amwa.maj.entity.Segment tv.amwa.maj.entity.Event
@AAFClass(uuid1=218169601, uuid2=257, uuid3=1536, uuid4={6,14,43,52,2,6,1,1}, definedName="Event", description="The Event class defines a text comment, a trigger, or an area in the image that has an associated interactive action.") public abstract class Event
Implements a text comment, a trigger, or an area in the image that has an associated interactive action.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
Event.EventXMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Segment |
---|
Segment.SegmentXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Component |
---|
Component.ComponentAttributesXMLHandler, Component.ComponentUserCommentsXMLHandler, Component.ComponentXMLHandler, Component.KLVDataXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Field Summary | |
---|---|
static String |
EVENT_ITEM
|
Fields inherited from class tv.amwa.maj.entity.Component |
---|
COMPONENT_ITEM |
Constructor Summary | |
---|---|
Event()
|
Method Summary | |
---|---|
void |
appendXMLChildren(Node parent)
Append child elements to the given parent node to serialize the value of an object to an XML fragment. |
boolean |
equals(Object o)
Tests to see if the given object is equal to this interchange object. |
String |
getComment()
Returns the comment that specifies the purpose of this event. |
long |
getPosition()
Returns the position of this event, which specifies the starting time of the event in an event mob slot. |
boolean |
getPositionPresent()
Determine whether this event is in a context where the position property is present or not. |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setComment(String comment)
Set a comment that specifies the purpose of the event. |
void |
setPosition(long position)
Sets the position of this event, which specifies the starting time of the event in an event mob slot. |
void |
setPositionPresent(boolean positionPresent)
Sets whether this event is in a context where the position property is present or not. |
void |
setPropertiesFromInterface(Event castFrom)
|
Methods inherited from class tv.amwa.maj.entity.Segment |
---|
clone, segmentOffsetToTC, segmentTCToOffset, setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.Component |
---|
appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, getLengthPresent, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength, setLengthPresent, setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.Segment |
---|
segmentOffsetToTC, segmentTCToOffset |
Methods inherited from interface tv.amwa.maj.iface.Component |
---|
appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength |
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject |
---|
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue |
Methods inherited from interface tv.amwa.maj.entity.MAJCommon |
---|
toString |
Field Detail |
---|
public static final String EVENT_ITEM
Constructor Detail |
---|
public Event()
Method Detail |
---|
public final void setPropertiesFromInterface(Event castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=87032836, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Comment", typeName="String", optional=true, uniqueIdentifier=false, pid=1538) public String getComment() throws PropertyNotPresentException
Event
Returns the comment that specifies the purpose of this event. This is an optional property.
getComment
in interface Event
PropertyNotPresentException
- The optional comment property is not present in this event.public void setComment(String comment)
Event
Set a comment that specifies the purpose of the event. Set this optional property
to null
to omit it.
setComment
in interface Event
comment
- Comment to set for this event.@AAFProperty(uuid1=117571843, uuid2=771, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Position", typeName="PositionType", optional=false, uniqueIdentifier=false, pid=1537) public long getPosition() throws BadPropertyException
Event
Returns the position of this event, which specifies the starting time of the event in an event mob slot.
getPosition
in interface Event
BadPropertyException
- The position property is not present in the context of this event.public void setPosition(long position) throws BadPropertyException
Event
Sets the position of this event, which specifies the starting time of the event in an event mob slot.
setPosition
in interface Event
position
- The position for this event in an event mob slot.
BadPropertyException
- The position property is not present in the context of this event.public boolean getPositionPresent()
Determine whether this event is in a context where the position property is present or not.
If an Event is in a timeline mob slot
or a static mob slot
,
it shall not have a position property. If an event is in an event mob slot
, it
shall have a position property.
public void setPositionPresent(boolean positionPresent)
Sets whether this event is in a context where the position property is present or not.
If an Event is in a timeline mob slot
or a static mob slot
,
it shall not have a position property. If an event is in an event mob slot
, it
shall have a position property.
positionPresent
- Is this event in a context where the position property is present?public boolean equals(Object o)
MAJCommon
Tests to see if the given object is equal to this interchange object. To be equal, the given value must be not null, share the same interface to its value and each of the properties of the value must each be equal.
equals
in interface MAJCommon
equals
in class Component
o
- Object to test for equality with.
Object.equals(Object)
public int hashCode()
MAJCommon
Returns a hash code value for this interchange object.
hashCode
in interface MAJCommon
hashCode
in class Component
Object.hashCode()
public void appendXMLChildren(Node parent)
XMLSerializable
Append child elements to the given parent node to serialize the value of an object
to an XML fragment. Methods of the XMLBuilder
class are provided to help with this
process.
appendXMLChildren
in interface XMLSerializable
appendXMLChildren
in class Component
parent
- XML parent element to append child nodes to.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |