ro.sync.ecss.extensions.api.webapp

Interface AuthorHTMLRenderer

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorHTMLRenderer

A class that renders the author document or parts of it in an HTML format. Each XML node is rendered as an HTML 'div' that contains: - the start sentiel (and possibly the setinels of the parents in compact view mode) - the static content of the ':before' child specified in CSS - the static content of the node specified in CSS. - The 'div's that correspond to the children of the node. - Spans of text between every two consecutive children (possibly empty). - the static content of the ':after' child specified in CSS - the end sentinel(s)

Since:

15.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME_DELIMITER Delimiter char between the tag name and namespace used to encode both of them in a single attribute.

Method Summary

Methods

Modifier and Type	Method and Description
void	render() Renders the entire document in HTML format.
void	renderContentAndSentinels() Renders only the content and sentinels of the document (without the 'div' HTML tag).
void	renderNode(AuthorNode node) Renders the content of the node including the 'div' HTML tag.
void	renderNodeContentAndSentinels(AuthorNode node) Renders the content and sentinels of a specific node from the document (without the 'div' HTML tag).

Field Detail

TAG_NAME_DELIMITER

static final java.lang.String TAG_NAME_DELIMITER

Delimiter char between the tag name and namespace used to encode both of them in a single attribute.

See Also:

Constant Field Values

Method Detail

render

void render()
            throws javax.swing.text.BadLocationException,
                   java.io.IOException

Renders the entire document in HTML format.

Throws:

javax.swing.text.BadLocationException

java.io.IOException

renderContentAndSentinels

void renderContentAndSentinels()
                               throws javax.swing.text.BadLocationException,
                                      java.io.IOException

Renders only the content and sentinels of the document (without the 'div' HTML tag).

Throws:

javax.swing.text.BadLocationException

java.io.IOException

renderNodeContentAndSentinels

void renderNodeContentAndSentinels(AuthorNode node)
                                   throws javax.swing.text.BadLocationException,
                                          java.io.IOException

Renders the content and sentinels of a specific node from the document (without the 'div' HTML tag).

Parameters:

node - The node to be rendered.

Throws:

javax.swing.text.BadLocationException

java.io.IOException

renderNode

void renderNode(AuthorNode node)
                throws javax.swing.text.BadLocationException,
                       java.io.IOException

Renders the content of the node including the 'div' HTML tag.

Parameters:

node - The author node to render.

Throws:

javax.swing.text.BadLocationException

java.io.IOException