blob: 3fd1c4cfa8d7912f75bde2449a5845fd011b9043 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Mon Aug 12 16:33:30 CEST 2019 -->
<title>RichTextPainter</title>
<meta name="date" content="2019-08-12">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RichTextPainter";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RichTextPainter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextEditorConfiguration.html" title="class in org.eclipse.nebula.widgets.richtext"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextViewer.html" title="class in org.eclipse.nebula.widgets.richtext"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/richtext/RichTextPainter.html" target="_top">Frames</a></li>
<li><a href="RichTextPainter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.nebula.widgets.richtext</div>
<h2 title="Class RichTextPainter" class="title">Class RichTextPainter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.richtext.RichTextPainter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">RichTextPainter</span>
extends java.lang.Object</pre>
<div class="block">The <a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html" title="class in org.eclipse.nebula.widgets.richtext"><code>RichTextPainter</code></a> is used to parse and render HTML input to a <code>GC</code>. It works well
with HTML input generated by ckeditor.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_PARAGRAPH_MARGIN_LEFT">ATTRIBUTE_PARAGRAPH_MARGIN_LEFT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_PARAGRAPH_TEXT_ALIGN">ATTRIBUTE_PARAGRAPH_TEXT_ALIGN</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_PARAGRAPH_TEXT_ALIGN_VALUE_RIGHT">ATTRIBUTE_PARAGRAPH_TEXT_ALIGN_VALUE_RIGHT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_STYLE">ATTRIBUTE_STYLE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_STYLE_BACKGROUND_COLOR">ATTRIBUTE_STYLE_BACKGROUND_COLOR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_STYLE_COLOR">ATTRIBUTE_STYLE_COLOR</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_STYLE_FONT_FAMILY">ATTRIBUTE_STYLE_FONT_FAMILY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#ATTRIBUTE_STYLE_FONT_SIZE">ATTRIBUTE_STYLE_FONT_SIZE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#BULLETS">BULLETS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#CONTROL_CHARACTER_REGEX">CONTROL_CHARACTER_REGEX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) javax.xml.stream.XMLInputFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#factory">factory</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#FAKE_ROOT_TAG_END">FAKE_ROOT_TAG_END</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#FAKE_ROOT_TAG_START">FAKE_ROOT_TAG_START</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#SPACE">SPACE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_BR">TAG_BR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_EM">TAG_EM</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_LIST_ITEM">TAG_LIST_ITEM</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_ORDERED_LIST">TAG_ORDERED_LIST</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_PARAGRAPH">TAG_PARAGRAPH</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_SPAN">TAG_SPAN</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_STRIKETHROUGH">TAG_STRIKETHROUGH</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_STRONG">TAG_STRONG</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_UNDERLINE">TAG_UNDERLINE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#TAG_UNORDERED_LIST">TAG_UNORDERED_LIST</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#RichTextPainter--">RichTextPainter</a></span>()</code>
<div class="block">Create a new <a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html" title="class in org.eclipse.nebula.widgets.richtext"><code>RichTextPainter</code></a> with disabled word wrapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#RichTextPainter-boolean-">RichTextPainter</a></span>(boolean&nbsp;wordWrap)</code>
<div class="block">Create a new <a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html" title="class in org.eclipse.nebula.widgets.richtext"><code>RichTextPainter</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#calculateListIndentation-org.eclipse.swt.graphics.GC-">calculateListIndentation</a></span>(org.eclipse.swt.graphics.GC&nbsp;gc)</code>
<div class="block">Calculates the indentation to use for list items.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#getBulletCharacter-int-">getBulletCharacter</a></span>(int&nbsp;listDepth)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#getParagraphSpace--">getParagraphSpace</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.Point</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#getPreferredSize--">getPreferredSize</a></span>()</code>
<div class="block">Returns the preferred size of the content.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#paintHTML-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-">paintHTML</a></span>(java.lang.String&nbsp;html,
org.eclipse.swt.graphics.GC&nbsp;gc,
org.eclipse.swt.graphics.Rectangle&nbsp;bounds)</code>
<div class="block">Processes the HTML input and paints the result to the given <code>GC</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#paintHTML-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-boolean-">paintHTML</a></span>(java.lang.String&nbsp;html,
org.eclipse.swt.graphics.GC&nbsp;gc,
org.eclipse.swt.graphics.Rectangle&nbsp;bounds,
boolean&nbsp;render)</code>
<div class="block">Processes the HTML input.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#preCalculate-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-boolean-">preCalculate</a></span>(java.lang.String&nbsp;html,
org.eclipse.swt.graphics.GC&nbsp;gc,
org.eclipse.swt.graphics.Rectangle&nbsp;bounds,
boolean&nbsp;calculateWithWrapping)</code>
<div class="block">Processes the HTML input to calculate the preferred size.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#setEntityReplacer-org.eclipse.nebula.widgets.richtext.painter.EntityReplacer-">setEntityReplacer</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/richtext/painter/EntityReplacer.html" title="interface in org.eclipse.nebula.widgets.richtext.painter">EntityReplacer</a>&nbsp;entityReplacer)</code>
<div class="block">Set an <a href="../../../../../org/eclipse/nebula/widgets/richtext/painter/EntityReplacer.html" title="interface in org.eclipse.nebula.widgets.richtext.painter"><code>EntityReplacer</code></a> that should be used to replace <code>EntityReference</code>s in the
HTML snippet to parse.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#setParagraphSpace-int-">setParagraphSpace</a></span>(int&nbsp;paragraphSpace)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#setWordSplitRegex-java.lang.String-">setWordSplitRegex</a></span>(java.lang.String&nbsp;wordSplitRegex)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TAG_SPAN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_SPAN</h4>
<pre>public static final&nbsp;java.lang.String TAG_SPAN</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_SPAN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_STRONG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_STRONG</h4>
<pre>public static final&nbsp;java.lang.String TAG_STRONG</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_STRONG">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_EM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_EM</h4>
<pre>public static final&nbsp;java.lang.String TAG_EM</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_EM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_UNDERLINE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_UNDERLINE</h4>
<pre>public static final&nbsp;java.lang.String TAG_UNDERLINE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_UNDERLINE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_STRIKETHROUGH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_STRIKETHROUGH</h4>
<pre>public static final&nbsp;java.lang.String TAG_STRIKETHROUGH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_STRIKETHROUGH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_PARAGRAPH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_PARAGRAPH</h4>
<pre>public static final&nbsp;java.lang.String TAG_PARAGRAPH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_PARAGRAPH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_UNORDERED_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_UNORDERED_LIST</h4>
<pre>public static final&nbsp;java.lang.String TAG_UNORDERED_LIST</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_UNORDERED_LIST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_ORDERED_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_ORDERED_LIST</h4>
<pre>public static final&nbsp;java.lang.String TAG_ORDERED_LIST</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_ORDERED_LIST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_LIST_ITEM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_LIST_ITEM</h4>
<pre>public static final&nbsp;java.lang.String TAG_LIST_ITEM</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_LIST_ITEM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TAG_BR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAG_BR</h4>
<pre>public static final&nbsp;java.lang.String TAG_BR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.TAG_BR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_STYLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_STYLE</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_STYLE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_STYLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_STYLE_COLOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_STYLE_COLOR</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_STYLE_COLOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_STYLE_COLOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_STYLE_BACKGROUND_COLOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_STYLE_BACKGROUND_COLOR</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_STYLE_BACKGROUND_COLOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_STYLE_BACKGROUND_COLOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_STYLE_FONT_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_STYLE_FONT_SIZE</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_STYLE_FONT_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_STYLE_FONT_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_STYLE_FONT_FAMILY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_STYLE_FONT_FAMILY</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_STYLE_FONT_FAMILY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_STYLE_FONT_FAMILY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_PARAGRAPH_MARGIN_LEFT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_PARAGRAPH_MARGIN_LEFT</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_PARAGRAPH_MARGIN_LEFT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_PARAGRAPH_MARGIN_LEFT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_PARAGRAPH_TEXT_ALIGN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_PARAGRAPH_TEXT_ALIGN</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_PARAGRAPH_TEXT_ALIGN</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_PARAGRAPH_TEXT_ALIGN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ATTRIBUTE_PARAGRAPH_TEXT_ALIGN_VALUE_RIGHT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_PARAGRAPH_TEXT_ALIGN_VALUE_RIGHT</h4>
<pre>public static final&nbsp;java.lang.String ATTRIBUTE_PARAGRAPH_TEXT_ALIGN_VALUE_RIGHT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.ATTRIBUTE_PARAGRAPH_TEXT_ALIGN_VALUE_RIGHT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CONTROL_CHARACTER_REGEX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONTROL_CHARACTER_REGEX</h4>
<pre>public static final&nbsp;java.lang.String CONTROL_CHARACTER_REGEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.CONTROL_CHARACTER_REGEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FAKE_ROOT_TAG_START">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAKE_ROOT_TAG_START</h4>
<pre>public static final&nbsp;java.lang.String FAKE_ROOT_TAG_START</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.FAKE_ROOT_TAG_START">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FAKE_ROOT_TAG_END">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAKE_ROOT_TAG_END</h4>
<pre>public static final&nbsp;java.lang.String FAKE_ROOT_TAG_END</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.FAKE_ROOT_TAG_END">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BULLETS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BULLETS</h4>
<pre>public static final&nbsp;java.lang.String[] BULLETS</pre>
</li>
</ul>
<a name="SPACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE</h4>
<pre>public static final&nbsp;java.lang.String SPACE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.richtext.RichTextPainter.SPACE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="factory">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>factory</h4>
<pre>javax.xml.stream.XMLInputFactory factory</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RichTextPainter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RichTextPainter</h4>
<pre>public&nbsp;RichTextPainter()</pre>
<div class="block">Create a new <a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html" title="class in org.eclipse.nebula.widgets.richtext"><code>RichTextPainter</code></a> with disabled word wrapping.</div>
</li>
</ul>
<a name="RichTextPainter-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RichTextPainter</h4>
<pre>public&nbsp;RichTextPainter(boolean&nbsp;wordWrap)</pre>
<div class="block">Create a new <a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html" title="class in org.eclipse.nebula.widgets.richtext"><code>RichTextPainter</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wordWrap</code> - <code>true</code> if automatic word wrapping should be enabled, <code>false</code>
if not.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="preCalculate-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preCalculate</h4>
<pre>public&nbsp;void&nbsp;preCalculate(java.lang.String&nbsp;html,
org.eclipse.swt.graphics.GC&nbsp;gc,
org.eclipse.swt.graphics.Rectangle&nbsp;bounds,
boolean&nbsp;calculateWithWrapping)</pre>
<div class="block">Processes the HTML input to calculate the preferred size. Does not perform rendering.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>html</code> - The HTML string to process.</dd>
<dd><code>gc</code> - The <code>GC</code> to operate on.</dd>
<dd><code>bounds</code> - The available space for painting.</dd>
<dd><code>calculateWithWrapping</code> - <code>true</code> if calculation should be performed with enabled word wrapping,
<code>false</code> if not</dd>
</dl>
</li>
</ul>
<a name="paintHTML-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paintHTML</h4>
<pre>public&nbsp;void&nbsp;paintHTML(java.lang.String&nbsp;html,
org.eclipse.swt.graphics.GC&nbsp;gc,
org.eclipse.swt.graphics.Rectangle&nbsp;bounds)</pre>
<div class="block">Processes the HTML input and paints the result to the given <code>GC</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>html</code> - The HTML string to process.</dd>
<dd><code>gc</code> - The <code>GC</code> to operate on.</dd>
<dd><code>bounds</code> - The available space for painting.</dd>
</dl>
</li>
</ul>
<a name="paintHTML-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paintHTML</h4>
<pre>protected&nbsp;void&nbsp;paintHTML(java.lang.String&nbsp;html,
org.eclipse.swt.graphics.GC&nbsp;gc,
org.eclipse.swt.graphics.Rectangle&nbsp;bounds,
boolean&nbsp;render)</pre>
<div class="block">Processes the HTML input.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>html</code> - The HTML string to process.</dd>
<dd><code>gc</code> - The <code>GC</code> to operate on.</dd>
<dd><code>bounds</code> - The available space for painting.</dd>
<dd><code>render</code> - <code>true</code> if the processing result should be painted to the <code>GC</code>,
<code>false</code> if not (in case of pre calculation).</dd>
</dl>
</li>
</ul>
<a name="calculateListIndentation-org.eclipse.swt.graphics.GC-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateListIndentation</h4>
<pre>protected&nbsp;int&nbsp;calculateListIndentation(org.eclipse.swt.graphics.GC&nbsp;gc)</pre>
<div class="block">Calculates the indentation to use for list items.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gc</code> - The current <code>GC</code> for calculating the text extend.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The indentation to use for list items.</dd>
</dl>
</li>
</ul>
<a name="getBulletCharacter-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBulletCharacter</h4>
<pre>protected&nbsp;java.lang.String&nbsp;getBulletCharacter(int&nbsp;listDepth)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listDepth</code> - The list depth of the current list. Needs to be 1 for the top level list.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bullet character to use for list items of an unordered list.</dd>
</dl>
</li>
</ul>
<a name="setEntityReplacer-org.eclipse.nebula.widgets.richtext.painter.EntityReplacer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEntityReplacer</h4>
<pre>public&nbsp;void&nbsp;setEntityReplacer(<a href="../../../../../org/eclipse/nebula/widgets/richtext/painter/EntityReplacer.html" title="interface in org.eclipse.nebula.widgets.richtext.painter">EntityReplacer</a>&nbsp;entityReplacer)</pre>
<div class="block">Set an <a href="../../../../../org/eclipse/nebula/widgets/richtext/painter/EntityReplacer.html" title="interface in org.eclipse.nebula.widgets.richtext.painter"><code>EntityReplacer</code></a> that should be used to replace <code>EntityReference</code>s in the
HTML snippet to parse.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entityReplacer</code> - The <a href="../../../../../org/eclipse/nebula/widgets/richtext/painter/EntityReplacer.html" title="interface in org.eclipse.nebula.widgets.richtext.painter"><code>EntityReplacer</code></a> to use.</dd>
</dl>
</li>
</ul>
<a name="getPreferredSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreferredSize</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.Point&nbsp;getPreferredSize()</pre>
<div class="block">Returns the preferred size of the content. It is calculated after processing the content.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The preferred size of the content.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextPainter.html#preCalculate-java.lang.String-org.eclipse.swt.graphics.GC-org.eclipse.swt.graphics.Rectangle-boolean-"><code>preCalculate(String, GC, Rectangle, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getParagraphSpace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphSpace</h4>
<pre>public&nbsp;int&nbsp;getParagraphSpace()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The space that should be used before and after a paragraph.<br>
<b>Note:</b> Between two paragraphs the paragraphSpace * 2 is added as space.</dd>
</dl>
</li>
</ul>
<a name="setParagraphSpace-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParagraphSpace</h4>
<pre>public&nbsp;void&nbsp;setParagraphSpace(int&nbsp;paragraphSpace)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paragraphSpace</code> - The space that should be applied before and after a paragraph.<br>
<b>Note:</b> Between two paragraphs the paragraphSpace * 2 is added as space.</dd>
</dl>
</li>
</ul>
<a name="setWordSplitRegex-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setWordSplitRegex</h4>
<pre>public&nbsp;void&nbsp;setWordSplitRegex(java.lang.String&nbsp;wordSplitRegex)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wordSplitRegex</code> - The regular expression that will be used to determine word boundaries. The default
is "\s".</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RichTextPainter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextEditorConfiguration.html" title="class in org.eclipse.nebula.widgets.richtext"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/richtext/RichTextViewer.html" title="class in org.eclipse.nebula.widgets.richtext"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/richtext/RichTextPainter.html" target="_top">Frames</a></li>
<li><a href="RichTextPainter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>