com.github.jferard.fastods

Class Link

java.lang.Object

com.github.jferard.fastods.Link

All Implemented Interfaces:

ParagraphElement, Tag, XMLConvertible

public final class Link
extends Object
implements ParagraphElement

6.1.8 text:a 19.910 xlink:href

See: https://www.w3.org/TR/2004/REC-xmlschema-2-20041028/#anyURI and https://www.ietf .org/rfc/rfc2396.txt

Represents a link to a table, an URI, an URL or a custom ref.

Author:

Julien Férard

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedStylesFromCell(StylesContainer stylesContainer) Add the styles contained in this paragraph element to the styles container.
void	addEmbeddedStylesFromFooterHeader(StylesContainer stylesContainer) Add the styles contained in this paragraph element to the styles container.
void	appendXMLContent(XMLUtil util, Appendable appendable) Write the XML format for this object.
static LinkBuilder	builder(String text)
static Link	create(String text, File file) Deprecated.
static Link	create(String text, String relativeRef) Deprecated.
static Link	create(String text, Table table) Deprecated.
static Link	create(String text, TableRef tableRef) Deprecated.
static Link	create(String text, TextStyle ts, File file) Deprecated.
static Link	create(String text, TextStyle ts, String relativeRef) Deprecated.
static Link	create(String text, TextStyle ts, Table table) Deprecated.
static Link	create(String text, TextStyle ts, TableRef tableRef) Deprecated.
static Link	create(String text, TextStyle ts, URI uri) Deprecated.
static Link	create(String text, TextStyle ts, URL url) Deprecated.
static Link	create(String text, URI uri) Deprecated.
static Link	create(String text, URL url) Deprecated.
boolean	equals(Object o)
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static LinkBuilder builder(String text)

Parameters:

text - the text content

Returns:

the link builder

create

@Deprecated
public static Link create(String text,
                                      TextStyle ts,
                                      Table table)

Deprecated.

Create a new styled Link to a table

Parameters:

text - the text content

ts - the style

table - the destination

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      Table table)

Deprecated.

Create a new Link to a table

Parameters:

text - the text content

table - the destination

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      TextStyle ts,
                                      String relativeRef)

Deprecated.

Create a new styled link to a given ref

Parameters:

text - the text content

ts - the style

relativeRef - the ref

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      String relativeRef)

Deprecated.

Create a new link to a given ref

Parameters:

text - the text content

relativeRef - the ref

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      TextStyle ts,
                                      File file)

Deprecated.

Create a new styled link to a given file

Parameters:

text - the text content

ts - the style

file - the file

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      File file)

Deprecated.

Create a new link to a given file

Parameters:

text - the text content

file - the file

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      TextStyle ts,
                                      URL url)

Deprecated.

Create a new styled link to a given url

Parameters:

text - the text content

ts - the style

url - the url

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      URL url)

Deprecated.

Create a new link to a given url

Parameters:

text - the text content

url - the url

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      TextStyle ts,
                                      URI uri)

Deprecated.

Create a new styled link to a given uri

Parameters:

text - the text content

ts - the style

uri - the uri

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      URI uri)

Deprecated.

Create a new link to a given url

Parameters:

text - the text content

uri - the file

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      TableRef tableRef)

Deprecated.

Create a new link to a given table ref

Parameters:

text - the text content

tableRef - the table ref

Returns:

the link

create

@Deprecated
public static Link create(String text,
                                      TextStyle ts,
                                      TableRef tableRef)

Deprecated.

Create a new styled link to a given uri

Parameters:

text - the text content

ts - the style

tableRef - the table ref

Returns:

the link

appendXMLContent

public void appendXMLContent(XMLUtil util,
                             Appendable appendable)
                      throws IOException

Description copied from interface: XMLConvertible

Write the XML format for this object. This is used while writing the ODS file.

Specified by:

appendXMLContent in interface XMLConvertible

Parameters:

util - a helper object

appendable - the appendable to append data to

Throws:

IOException - if the style can't be added

addEmbeddedStylesFromFooterHeader

public void addEmbeddedStylesFromFooterHeader(StylesContainer stylesContainer)

Description copied from interface: ParagraphElement

Add the styles contained in this paragraph element to the styles container. Use if this paragraph elements is inside the page layout. TODO: store font faces

Specified by:

addEmbeddedStylesFromFooterHeader in interface ParagraphElement

Parameters:

stylesContainer - the styles container

addEmbeddedStylesFromCell

public void addEmbeddedStylesFromCell(StylesContainer stylesContainer)

Description copied from interface: ParagraphElement

Add the styles contained in this paragraph element to the styles container. Use if this paragraph elements is inside a cell. TODO: store font faces

Specified by:

addEmbeddedStylesFromCell in interface ParagraphElement

Parameters:

stylesContainer - the styles container

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object