org.docx4j.convert.out

Interface ConversionHyperlinkHandler.Model

All Known Implementing Classes:

AbstractHyperlinkWriterModel

Enclosing interface:

ConversionHyperlinkHandler

public static interface ConversionHyperlinkHandler.Model

Method Summary

Modifier and Type	Method and Description
String	getAnchor() Specifies the name of a bookmark in the current document which shall be the target of this hyperlink. If this attribute is omitted, then the default behavior shall be to navigate to the start of the document.
Node	getContent()
String	getDocLocation() Specifies a location in the target of the hyperlink that has no bookmarks.
String	getRId() Specifies the ID of the relationship whose target shall be used as the target for this hyperlink.
String	getTarget() field-argument of the Hyperlink field or the targetUri of the relationship.
String	getTgtFrame() Specifies a frame within the parent HTML frameset for the target of the parent hyperlink when one exists.
String	getTooltip() Specifies a string which can be surfaced in a user interface as associated with the parent hyperlink.
boolean	isExternal() Only avaiable if the information is read from a relationship.
void	setAnchor(String anchor)
void	setDocLocation(String docLocation)
void	setExternal(boolean external)
void	setRId(String rId)
void	setTarget(String target)
void	setTgtFrame(String tgtFrame)
void	setTooltip(String tooltip)

Method Detail

getTarget

String getTarget()

field-argument of the Hyperlink field or the targetUri of the relationship. corresponds to switch \l field-argument, the \l switch might be omitted.

setTarget

void setTarget(String target)

isExternal

boolean isExternal()

Only avaiable if the information is read from a relationship. Otherwise always false.

setExternal

void setExternal(boolean external)

getAnchor

String getAnchor()

Specifies the name of a bookmark in the current document which shall be the target of this hyperlink.
If this attribute is omitted, then the default behavior shall be to navigate to the start of the document. If a hyperlink target is also specified using the r:id attribute, then this attribute shall be ignored.

setAnchor

void setAnchor(String anchor)

getDocLocation

String getDocLocation()

Specifies a location in the target of the hyperlink that has no bookmarks. The method by which the contents of this attribute are linked to document text is outside the scope of ECMA-376.

setDocLocation

void setDocLocation(String docLocation)

getRId

String getRId()

Specifies the ID of the relationship whose target shall be used as the target for this hyperlink.

setRId

void setRId(String rId)

getTgtFrame

String getTgtFrame()

Specifies a frame within the parent HTML frameset for the target of the parent hyperlink when one exists. corresponds to switch \t field-argument corresponds to switch \n with tgtFrame = "_blank"

setTgtFrame

void setTgtFrame(String tgtFrame)

getTooltip

String getTooltip()

Specifies a string which can be surfaced in a user interface as associated with the parent hyperlink. corresponds to switch \o field-argument

setTooltip

void setTooltip(String tooltip)

getContent

Node getContent()