Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.custom.HTMLWriter

The HTMLWriter class is used to write styled content as HTML. The implementation creates a very-very simple HTML, as compatible as possible: simple styles, no JavaScript.

How the concepts are mapped to HTML:

The global StyledText properties (for example StyledText#getBackground() are written in a wrapping <div> or <span> (for line fragments).
The line specific properties (for example StyledText#getLineBackground(int) are written the <p> elements - if the copied range contains more then a line fragment.
The StyleRange properties inside the line are written the <span> elements.

Field Summary

Modifier and Type	Field and Description
private boolean	multiline
private String	tag

Inherited from org.eclipse.swt.custom.StyledTextWriterBase:: styledText

Constructor Summary

Access	Constructor and Description
public	HTMLWriter(StyledText styledText, int start, int length, StyledTextContent content)

Method Summary

Modifier and Type	Method and Description
private static void	appendAlignAndJustify(StringBuilder buffer, int alignment, boolean justify)
private static String	appendFont(StringBuilder buffer, Font font, int fontStyle)
private static void	appendStyle(StringBuilder buffer, String value)
private static void	appendStyle(StringBuilder buffer, String prefix, String value, String postfix)
private static void	appendStyle(StringBuilder buffer, String prefix, int value, String postfix)
private static void	appendStyle(StringBuilder buffer, String prefix, Color value, String postfix)
public void	close() Overrides org.eclipse.swt.custom.TextWriter.close. Closes the writer.
private static String	colorToHex(Color color)
pack-priv String	escapeText(String the text to escape string) Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.escapeText. Takes plain text and returns the same text escaped using the rules of the output format.
pack-priv void	writeEmptyLine() Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeEmptyLine. Invoked at the end of each line, writeLineEnd, if there was no text output.
pack-priv void	writeHeader() Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeHeader. Writes the part that only shows once, at the beginning of the output data.
public void	writeLineDelimiter(String line delimiter to write lineDelimiter) Overrides org.eclipse.swt.custom.TextWriter.writeLineDelimiter. Appends the specified line delimiter to the data.
pack-priv String	writeLineStart(Color lineBackground, int indent, int verticalIndent, int alignment, boolean justify) Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeLineStart. Invoked at the beginning of each line in the original widget.
pack-priv String	writeSpanStart(StyleRange style) Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeSpanStart. Invoked at the beginning of each styled span fragment in the original widget.

Inherited from org.eclipse.swt.custom.StyledTextWriterBase:: writeEscaped writeLine writeLineEnd writeSpanEnd writeStyledLine

Field Detail

multiline	back to summary
private boolean multiline

tag	back to summary
private String tag

Constructor Detail

HTMLWriter	back to summary
public HTMLWriter(StyledText styledText, int start, int length, StyledTextContent content)

Method Detail

appendAlignAndJustify	back to summary
private static void appendAlignAndJustify(StringBuilder buffer, int alignment, boolean justify)

appendFont	back to summary
private static String appendFont(StringBuilder buffer, Font font, int fontStyle)

appendStyle	back to summary
private static void appendStyle(StringBuilder buffer, String value)

appendStyle	back to summary
private static void appendStyle(StringBuilder buffer, String prefix, String value, String postfix)

appendStyle	back to summary
private static void appendStyle(StringBuilder buffer, String prefix, int value, String postfix)

appendStyle	back to summary
private static void appendStyle(StringBuilder buffer, String prefix, Color value, String postfix)

close back to summary

close	back to summary
public void close() Overrides org.eclipse.swt.custom.TextWriter.close. Doc from org.eclipse.swt.custom.TextWriter.close. Closes the writer. Once closed no more content can be written Note `toString()` is not guaranteed to return a valid string unless the writer is closed. Annotations @Override

public void close()

Overrides org.eclipse.swt.custom.TextWriter.close.

Doc from org.eclipse.swt.custom.TextWriter.close.

Closes the writer. Once closed no more content can be written

Note

toString() is not guaranteed to return a valid string unless the writer is closed.

Annotations

@Override

colorToHex	back to summary
private static String colorToHex(Color color)

escapeText	back to summary
pack-priv String escapeText(String string) Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.escapeText. Doc from org.eclipse.swt.custom.StyledTextWriterBase.escapeText. Takes plain text and returns the same text escaped using the rules of the output format. Parameters string:String the text to escape Returns:String the escaped text Annotations @Override

escapeText

back to summary

pack-priv String escapeText(String string)

Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.escapeText.

Doc from org.eclipse.swt.custom.StyledTextWriterBase.escapeText.

Takes plain text and returns the same text escaped using the rules of the output format.

Parameters

string:String: the text to escape

Returns:String

the escaped text

Annotations

@Override

writeEmptyLine	back to summary
pack-priv void writeEmptyLine() Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeEmptyLine. Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeEmptyLine. Invoked at the end of each line, writeLineEnd, if there was no text output. This is needed for HTML, which does not render empty paragraphs. Annotations @Override

writeEmptyLine

back to summary

pack-priv void writeEmptyLine()

Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeEmptyLine.

Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeEmptyLine.

Invoked at the end of each line, writeLineEnd, if there was no text output.

This is needed for HTML, which does not render empty paragraphs.

Annotations

@Override

writeHeader	back to summary
pack-priv void writeHeader() Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeHeader. Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeHeader. Writes the part that only shows once, at the beginning of the output data. Annotations @Override

writeHeader

back to summary

pack-priv void writeHeader()

Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeHeader.

Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeHeader.

Writes the part that only shows once, at the beginning of the output data.

Annotations

@Override

writeLineDelimiter	back to summary
public void writeLineDelimiter(String lineDelimiter) Overrides org.eclipse.swt.custom.TextWriter.writeLineDelimiter. Doc from org.eclipse.swt.custom.TextWriter.writeLineDelimiter. Appends the specified line delimiter to the data. Parameters lineDelimiter:String line delimiter to write Annotations @Override

writeLineDelimiter

back to summary

public void writeLineDelimiter(String lineDelimiter)

Overrides org.eclipse.swt.custom.TextWriter.writeLineDelimiter.

Doc from org.eclipse.swt.custom.TextWriter.writeLineDelimiter.

Appends the specified line delimiter to the data.

Parameters

lineDelimiter:String: line delimiter to write

Annotations

@Override

writeLineStart	back to summary
pack-priv String writeLineStart(Color lineBackground, int indent, int verticalIndent, int alignment, boolean justify) Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeLineStart. Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeLineStart. Invoked at the beginning of each line in the original widget. It should output whatever tags are appropriate to start a new line in the output format. It will return the text that has to be output at the end of the line. Returns:String the text to append at the end of the line Annotations @Override

writeLineStart

back to summary

pack-priv String writeLineStart(Color lineBackground, int indent, int verticalIndent, int alignment, boolean justify)

Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeLineStart.

Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeLineStart.

Invoked at the beginning of each line in the original widget.

It should output whatever tags are appropriate to start a new line in the output format.
It will return the text that has to be output at the end of the line.

Returns:String

the text to append at the end of the line

Annotations

@Override

writeSpanStart	back to summary
pack-priv String writeSpanStart(StyleRange style) Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeSpanStart. Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeSpanStart. Invoked at the beginning of each styled span fragment in the original widget. It should output whatever tags are appropriate to start a formatted span in the output format. It will return the text that has to be output at the end of the span (to close it). Returns:String the text to append at the end of the styled span Annotations @Override

writeSpanStart

back to summary

pack-priv String writeSpanStart(StyleRange style)

Implements abstract org.eclipse.swt.custom.StyledTextWriterBase.writeSpanStart.

Doc from org.eclipse.swt.custom.StyledTextWriterBase.writeSpanStart.

Invoked at the beginning of each styled span fragment in the original widget.

It should output whatever tags are appropriate to start a formatted span in the output format.
It will return the text that has to be output at the end of the span (to close it).

Returns:String

the text to append at the end of the styled span

Annotations

@Override

pack-priv Class HTMLWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail