Package 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
    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
    Description
    AbstractHyperlinkWriterModel()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    build(AbstractWmlConversionContext conversionContext, Object node, Node content)
    Default build method, get's called with a P.Hyperlink.
    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
    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