com.github.jferard.fastods

Class Text

java.lang.Object

com.github.jferard.fastods.Text

All Implemented Interfaces:

ParagraphElement, Tag, XMLConvertible

public class Text
extends Object
implements ParagraphElement

The Text class represents a text in a footer/header region or the text in a cell. A text is a set of paragraphs (5.1.3 text:p).

The destination of embedded styles depends on the location of the text: * if the text is in a cell, the embedded styles will belong to content.xml/automatic-styles * if the text is in a footer/header, this footer/header style will belong to styles .xml/master-styles, and the embedded styles will go to styles.xml/automatic-styles.

Author:

Julien Férard

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEXT_DATE 7.3.2 text:date "The text:date element displays a date, by default this is the current date."
static String	TEXT_FILE_NAME 7.3.9 text:file-name "The text:file-name element represents a field that displays the name of a file that is being edited."
static String	TEXT_PAGE_COUNT 7.5.18.2 text:page-count
static String	TEXT_PAGE_NUMBER 7.3.4 text:page-number "The text:page-number element displays the current page number."
static String	TEXT_SHEET_NAME 7.3.11 text:sheet-name "The text:sheet-name element displays represents the name of a sheet that is currently being edited in a Spreadsheet document."
static String	TEXT_TIME 7.3.3 text:time "The text:time element displays a time, by default this is the current time."

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedStylesFromCell(StylesContainer stylesContainer) Add the styles to a container, in content.xml/automatic-styles Use if the text is in a cell
void	addEmbeddedStylesFromFooterHeader(StylesContainer stylesContainer) Add the styles to a container, in styles.xml/automatic-styles Use if the text is in a footer/header
void	appendXMLContent(XMLUtil util, Appendable appendable) Write the XML format for this object.
static TextBuilder	builder()
static Text	content(String text) Create a simple Text object
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty()
static Text	styledContent(String text, TextStyle ts) Create a simple Text object with a style

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_DATE

public static final String TEXT_DATE

7.3.2 text:date "The text:date element displays a date, by default this is the current date."

See Also:

Constant Field Values

TEXT_FILE_NAME

public static final String TEXT_FILE_NAME

7.3.9 text:file-name "The text:file-name element represents a field that displays the name of a file that is being edited."

See Also:

Constant Field Values

TEXT_PAGE_COUNT

public static final String TEXT_PAGE_COUNT

7.5.18.2 text:page-count

See Also:

Constant Field Values

TEXT_PAGE_NUMBER

public static final String TEXT_PAGE_NUMBER

7.3.4 text:page-number "The text:page-number element displays the current page number."

See Also:

Constant Field Values

TEXT_SHEET_NAME

public static final String TEXT_SHEET_NAME

7.3.11 text:sheet-name "The text:sheet-name element displays represents the name of a sheet that is currently being edited in a Spreadsheet document."

See Also:

Constant Field Values

TEXT_TIME

public static final String TEXT_TIME

7.3.3 text:time "The text:time element displays a time, by default this is the current time."

See Also:

Constant Field Values

Method Detail

builder

public static TextBuilder builder()

Returns:

a new builder

content

public static Text content(String text)

Create a simple Text object

Parameters:

text - the text content

Returns:

the Text

styledContent

public static Text styledContent(String text,
                                 TextStyle ts)

Create a simple Text object with a style

Parameters:

text - the text content

ts - the style

Returns:

the Text

addEmbeddedStylesFromCell

public void addEmbeddedStylesFromCell(StylesContainer stylesContainer)

Add the styles to a container, in content.xml/automatic-styles Use if the text is in a cell

Specified by:

addEmbeddedStylesFromCell in interface ParagraphElement

Parameters:

stylesContainer - the container

addEmbeddedStylesFromFooterHeader

public void addEmbeddedStylesFromFooterHeader(StylesContainer stylesContainer)

Add the styles to a container, in styles.xml/automatic-styles Use if the text is in a footer/header

Specified by:

addEmbeddedStylesFromFooterHeader in interface ParagraphElement

Parameters:

stylesContainer - the container

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

isEmpty

public boolean isEmpty()

Returns:

true if there is no paragraph.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object