tv.amwa.maj.iface
Interface HTMLClip

All Superinterfaces:

Component, InterchangeObject, Segment, SourceReferenceSegment, TextClip

All Known Implementing Classes:

HTMLClip

public interface HTMLClip
extends TextClip

Specifies a reference to HTML text essence.

Typically, an HTML clip is in a static slot and defines a section of HTML text that is associated with the essence data in a parallel timeline slot. The length of the HTML clip defines the extent of the association with the parallel slot in the same mob.

The begin anchor and end anchor properties specify the HTML tags that delineate the start and end of the referenced text. The begin anchor tag shall precede the end anchor tag. If the begin anchor and end anchor properties are omitted, the HTML clip references all the HTML text in the essence data object.

Author:

Richard Cartwright

See Also:

makeHTMLClip(), HTMLDescriptor

Method Summary

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.
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.

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

Method Detail

setBeginAnchor

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. Set this optional property to null to omit it.

Parameters:

beginAnchor - Begin anchor property of this HTML clip.

getBeginAnchor

String getBeginAnchor()
                      throws PropertyNotPresentException

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.

Returns:

Begin anchor property of this HTML clip.

Throws:

PropertyNotPresentException - The optional begin anchor property is not present in this HTML clip.

setEndAnchor

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. Set this optional property to null to omit it.

Parameters:

endAnchor - End anchor property of this HTML clip.

getEndAnchor

String getEndAnchor()
                    throws PropertyNotPresentException

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.

Returns:

End anchor property of this HTML clip.

Throws:

PropertyNotPresentException - The optional end anchor property is not present in this HTML clip.