|
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.SourceReferenceSegment tv.amwa.maj.entity.TextClip tv.amwa.maj.entity.HTMLClip
@AAFClass(uuid1=218169601, uuid2=257, uuid3=4864, uuid4={6,14,43,52,2,6,1,1}, definedName="HTMLClip", description="Reference to HTML text essence.") public class HTMLClip
Implements a reference to HTML text essence.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
HTMLClip.XMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.SourceReferenceSegment |
---|
SourceReferenceSegment.ChannelIDsXMLHandler, SourceReferenceSegment.MonoSourceSlotIDsXMLHandler, SourceReferenceSegment.SourceReferenceXMLHandler |
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 |
---|
Fields inherited from class tv.amwa.maj.entity.SourceReferenceSegment |
---|
SOURCEREFERENCE_ITEM |
Fields inherited from class tv.amwa.maj.entity.Component |
---|
COMPONENT_ITEM |
Constructor Summary | |
---|---|
HTMLClip(MobID sourceID,
int sourceMobSlotID)
Creates and initializes a new HTML clip, which represents an HTML document and identifies the source of the document. |
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. |
HTMLClip |
clone()
Creates a cloned copy of this entity. |
boolean |
equals(Object o)
Tests to see if the given object is equal to this interchange object. |
String |
getBeginAnchor()
Returns the begin anchor property of this HTML clip, which delineates the anchor that is the start of the reference's text. |
String |
getEndAnchor()
Returns the end anchor property of this HTML clip, which delineates the anchor that is the end of the reference's text. |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setBeginAnchor(String beginAnchor)
Sets the begin anchor property of this HTML clip, which delineates the anchor that is the start of the reference's text. |
void |
setEndAnchor(String endAnchor)
Sets the end anchor property of this HTML clip, which delineates the anchor that is the end of the reference's text. |
void |
setPropertiesFromInterface(HTMLClip castFrom)
|
Methods inherited from class tv.amwa.maj.entity.SourceReferenceSegment |
---|
getChannelIDs, getChannelIDsSize, getMonoSourceSlotIDs, getMonoSourceSlotIDsSize, getSourceID, getSourceMobSlotID, setChannelIDs, setMonoSourceSlotIDs, setPropertiesFromInterface, setSourceID, setSourceMobSlotID |
Methods inherited from class tv.amwa.maj.entity.Segment |
---|
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, toString, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.SourceReferenceSegment |
---|
getChannelIDs, getChannelIDsSize, getMonoSourceSlotIDs, getMonoSourceSlotIDsSize, getSourceID, getSourceMobSlotID, setChannelIDs, setMonoSourceSlotIDs, setSourceID, setSourceMobSlotID |
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 |
Constructor Detail |
---|
public HTMLClip(MobID sourceID, @UInt32 int sourceMobSlotID) throws NullPointerException, IllegalArgumentException
Creates and initializes a new HTML clip, which represents an HTML document
and identifies the source of the document. An HTML clip must have a data definition of
DataDefinitionConstant.Auxiliary
and is static and so has no length.
sourceID
- Reference to the mob containing the HTML essence.sourceMobSlotID
- Reference to the slot in the mob containing the HTML clip.
NullPointerException
- The source ID argument is null
.
IllegalArgumentException
- The slot ID value must be non-negative.Method Detail |
---|
public final void setPropertiesFromInterface(HTMLClip castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=87033345, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="BeginAnchor", typeName="String", optional=true, uniqueIdentifier=false, pid=5121) public String getBeginAnchor() throws PropertyNotPresentException
HTMLClip
Returns the begin anchor property of this HTML clip, which delineates the anchor that is the start of the reference's text. This is an optional property.
getBeginAnchor
in interface HTMLClip
PropertyNotPresentException
- The optional begin anchor property is not
present in this HTML clip.public void setBeginAnchor(String beginAnchor)
HTMLClip
Sets the begin anchor property of this HTML clip, which delineates the anchor that is the start of
the reference's text. Set this optional property to null
to omit it.
setBeginAnchor
in interface HTMLClip
beginAnchor
- Begin anchor property of this HTML clip.@AAFProperty(uuid1=87033346, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="EndAnchor", typeName="String", optional=true, uniqueIdentifier=false, pid=5122) public String getEndAnchor() throws PropertyNotPresentException
HTMLClip
Returns the end anchor property of this HTML clip, which delineates the anchor that is the end of the reference's text. This is an optional property.
getEndAnchor
in interface HTMLClip
PropertyNotPresentException
- The optional end anchor property is not
present in this HTML clip.public void setEndAnchor(String endAnchor)
HTMLClip
Sets the end anchor property of this HTML clip, which delineates the anchor that is the end of the
reference's text. Set this optional property to null
to omit it.
setEndAnchor
in interface HTMLClip
endAnchor
- End anchor property of this HTML clip.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 SourceReferenceSegment
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 SourceReferenceSegment
Object.hashCode()
public HTMLClip clone()
MAJCommon
Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.
This method does not throw a CloneNotSupportedException
as all
entity values must implement the Cloneable
interface. If a cloning
error does occur, a null
value will be returned but this is very unlikely
to happen.
clone
in interface MAJCommon
clone
in class Segment
Object.clone()
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 SourceReferenceSegment
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 |