org.docx4j.convert.out.common.writer

Class AbstractHyperlinkWriterModel

java.lang.Object

org.docx4j.convert.out.common.writer.AbstractHyperlinkWriterModel

All Implemented Interfaces:

ConversionHyperlinkHandler.Model

public class AbstractHyperlinkWriterModel
extends Object
implements ConversionHyperlinkHandler.Model

Model for the hyperlink tag.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	anchor 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.
protected Node	content
protected String	docLocation Specifies a location in the target of the hyperlink that has no bookmarks.
protected boolean	external Only avaiable if the information is read from a relationship.
protected String	rId Specifies the ID of the relationship whose target shall be used as the target for this hyperlink.
protected String	target field-argument of the Hyperlink field or the targetUri of the relationship.
protected String	tgtFrame Specifies a frame within the parent HTML frameset for the target of the parent hyperlink when one exists.
protected String	tooltip Specifies a string which can be surfaced in a user interface as associated with the parent hyperlink.

Constructor Summary

Constructors

Constructor and Description
AbstractHyperlinkWriterModel()

Method Summary

Modifier and Type	Method and Description
void	build(AbstractWmlConversionContext conversionContext, FldSimpleModel fldSimpleModel, Node content) Custom build method, get's used with a FldSimpleModel in those cases where the hyperlink is defined within a Field
void	build(AbstractWmlConversionContext conversionContext, Object node, Node content) Default build method, get's called with a P.Hyperlink.
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	getExternalTarget()
String	getInternalTarget()
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)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

content

protected Node content

target

protected String target

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

external

protected boolean external

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

anchor

protected String anchor

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.

docLocation

protected String docLocation

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.

rId

protected String rId

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

tgtFrame

protected String tgtFrame

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"

tooltip

protected String tooltip

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

Constructor Detail

AbstractHyperlinkWriterModel

public AbstractHyperlinkWriterModel()

Method Detail

build

public void build(AbstractWmlConversionContext conversionContext,
                  Object node,
                  Node content)
           throws TransformerException

Default build method, get's called with a P.Hyperlink.

Throws:

TransformerException

build

public void build(AbstractWmlConversionContext conversionContext,
                  FldSimpleModel fldSimpleModel,
                  Node content)
           throws TransformerException

Custom build method, get's used with a FldSimpleModel in those cases where the hyperlink is defined within a Field

Throws:

TransformerException

getExternalTarget

public String getExternalTarget()

getInternalTarget

public String getInternalTarget()

getTarget

public String getTarget()

Description copied from interface: ConversionHyperlinkHandler.Model

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

Specified by:

getTarget in interface ConversionHyperlinkHandler.Model

setTarget

public void setTarget(String target)

Specified by:

setTarget in interface ConversionHyperlinkHandler.Model

isExternal

public boolean isExternal()

Description copied from interface: ConversionHyperlinkHandler.Model

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

Specified by:

isExternal in interface ConversionHyperlinkHandler.Model

setExternal

public void setExternal(boolean external)

Specified by:

setExternal in interface ConversionHyperlinkHandler.Model

getAnchor

public String getAnchor()

Description copied from interface: ConversionHyperlinkHandler.Model

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.

Specified by:

getAnchor in interface ConversionHyperlinkHandler.Model

setAnchor

public void setAnchor(String anchor)

Specified by:

setAnchor in interface ConversionHyperlinkHandler.Model

getDocLocation

public String getDocLocation()

Description copied from interface: ConversionHyperlinkHandler.Model

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.

Specified by:

getDocLocation in interface ConversionHyperlinkHandler.Model

setDocLocation

public void setDocLocation(String docLocation)

Specified by:

setDocLocation in interface ConversionHyperlinkHandler.Model

getRId

public String getRId()

Description copied from interface: ConversionHyperlinkHandler.Model

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

Specified by:

getRId in interface ConversionHyperlinkHandler.Model

setRId

public void setRId(String rId)

Specified by:

setRId in interface ConversionHyperlinkHandler.Model

getTgtFrame

public String getTgtFrame()

Description copied from interface: ConversionHyperlinkHandler.Model

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"

Specified by:

getTgtFrame in interface ConversionHyperlinkHandler.Model

setTgtFrame

public void setTgtFrame(String tgtFrame)

Specified by:

setTgtFrame in interface ConversionHyperlinkHandler.Model

getTooltip

public String getTooltip()

Description copied from interface: ConversionHyperlinkHandler.Model

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

Specified by:

getTooltip in interface ConversionHyperlinkHandler.Model

setTooltip

public void setTooltip(String tooltip)

Specified by:

setTooltip in interface ConversionHyperlinkHandler.Model

getContent

public Node getContent()

Specified by:

getContent in interface ConversionHyperlinkHandler.Model

toString

public String toString()

Overrides:

toString in class Object