org.docgene.model

Class XMLExternalLink

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.XMLExternalLink

All Implemented Interfaces:

org.docgene.model.ElementReference, org.docgene.model.ExternalLink, ParagraphElement, StyledElement, org.docgene.model.URLLinkElement

Direct Known Subclasses:

XMLArchiveURL

public class XMLExternalLink
extends org.docgene.model.AbstractLink
implements org.docgene.model.URLLinkElement

Represent an external link (to a web page or a local file).

Field Summary

Fields inherited from class org.docgene.model.AbstractLink

isAbsolute, isValid

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLExternalLink()

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.String urlS, java.net.URL url) Bind an URL for the link.
void	bind(java.lang.String urlS, java.net.URL url, boolean isAbsolute) Bind an URL for the link.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getPath() Return the link path.
java.lang.String	getText() Return the link description text.
java.net.URL	getURL() Return the link URL.
java.lang.String	getURLAsString() Return the complete link URL as a String.
void	setText(java.lang.String text) Set the link description text.
void	setURL(java.net.URL url) Set the link URL.

Methods inherited from class org.docgene.model.AbstractLink

getCustomStyles, getLineNumber, isAbsolute, isValid, setCustomStyles, setLineNumber, setValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.ExternalLink

getNotNullURL, getURLAsString, getURLAsString

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

XMLExternalLink

public XMLExternalLink()

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

setText

public void setText(java.lang.String text)

Set the link description text.

Parameters:

text - the link description text

getURL

public java.net.URL getURL()

Return the link URL.

Specified by:

getURL in interface org.docgene.model.ExternalLink

Specified by:

getURL in interface org.docgene.model.URLLinkElement

Returns:

the link URL

getText

public java.lang.String getText()

Return the link description text.

Specified by:

getText in interface org.docgene.model.ExternalLink

Returns:

the link description text

setURL

public void setURL(java.net.URL url)

Set the link URL.

Parameters:

url - the URL

getPath

public java.lang.String getPath()

Return the link path.

Specified by:

getPath in interface org.docgene.model.ExternalLink

Returns:

the path

getURLAsString

public java.lang.String getURLAsString()

Return the complete link URL as a String. Defer by default to getURL() and return the String value of the URL.

Specified by:

getURLAsString in interface org.docgene.model.ExternalLink

Returns:

the complete link URL as a String

bind

public void bind(java.lang.String urlS,
                 java.net.URL url,
                 boolean isAbsolute)

Bind an URL for the link.

Parameters:

urlS - the URL as String

url - the URL

isAbsolute - true for an absolute URL

bind

public void bind(java.lang.String urlS,
                 java.net.URL url)

Bind an URL for the link.

Specified by:

bind in interface org.docgene.model.URLLinkElement

Parameters:

urlS - the URL as String

url - the URL