Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / f998bb2b16354fd59b8a5b5c8f47d9f4a3020c64 / . / releases / latest / javadoc / org / eclipse / nebula / paperclips / core / text / TextPrint.html
blob: 112dca306a1a1c5b377ab4f4754c4c103aaa99fe [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 Thu Jul 23 15:58:53 CEST 2020 -->
<title>TextPrint</title>
<meta name="date" content="2020-07-23">
<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="TextPrint";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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/TextPrint.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/paperclips/core/text/TextIterator.html" title="class in org.eclipse.nebula.paperclips.core.text"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/paperclips/core/text/TextPrint.html" target="_top">Frames</a></li>
<li><a href="TextPrint.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.paperclips.core.text</div>
<h2 title="Class TextPrint" class="title">Class TextPrint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.paperclips.core.text.TextPrint</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/eclipse/nebula/paperclips/core/Print.html" title="interface in org.eclipse.nebula.paperclips.core">Print</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TextPrint</span>
extends java.lang.Object
implements <a href="../../../../../../org/eclipse/nebula/paperclips/core/Print.html" title="interface in org.eclipse.nebula.paperclips.core">Print</a></pre>
<div class="block">A Print for displaying text.
<p>
TextPrints are never greedy with layout space, even with center- or
right-alignment. (Greedy prints take up all the available space on the page.)
Therefore, when center- or right-alignment is required, it is necessary to
wrap the text in a Print which will enforce the same alignment. Usually this
is a center:default:grow or right:default:grow column in a GridPrint.</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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#DEFAULT_ALIGN">DEFAULT_ALIGN</a></span></code>
<div class="block">The default alignment for TextPrint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static org.eclipse.swt.graphics.FontData</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#DEFAULT_FONT_DATA">DEFAULT_FONT_DATA</a></span></code>
<div class="block">The default font data for a TextPrint.</div>
</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/paperclips/core/text/TextPrint.html#DEFAULT_TEXT">DEFAULT_TEXT</a></span></code>
<div class="block">The default text for a TextPrint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) <a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#style">style</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#text">text</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#wordSplitting">wordSplitting</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/paperclips/core/text/TextPrint.html#TextPrint--">TextPrint</a></span>()</code>
<div class="block">Constructs a TextPrint with the default properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#TextPrint-java.lang.String-">TextPrint</a></span>(java.lang.String&nbsp;text)</code>
<div class="block">Constructs a TextPrint with the given text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#TextPrint-java.lang.String-org.eclipse.swt.graphics.FontData-">TextPrint</a></span>(java.lang.String&nbsp;text,
org.eclipse.swt.graphics.FontData&nbsp;fontData)</code>
<div class="block">Constructs a TextPrint with the given text and font data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#TextPrint-java.lang.String-org.eclipse.swt.graphics.FontData-int-">TextPrint</a></span>(java.lang.String&nbsp;text,
org.eclipse.swt.graphics.FontData&nbsp;fontData,
int&nbsp;align)</code>
<div class="block">Constructs a TextPrint with the given text, font data, and alignment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#TextPrint-java.lang.String-int-">TextPrint</a></span>(java.lang.String&nbsp;text,
int&nbsp;align)</code>
<div class="block">Constructs a TextPrint with the give text and alignment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#TextPrint-java.lang.String-org.eclipse.nebula.paperclips.core.text.TextStyle-">TextPrint</a></span>(java.lang.String&nbsp;text,
<a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a>&nbsp;style)</code>
<div class="block">Constructs a TextPrint with the given text and style.</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getAlignment--">getAlignment</a></span>()</code>
<div class="block">Returns the horizontal text alignment.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.RGB</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getBackground--">getBackground</a></span>()</code>
<div class="block">Returns the background color.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.FontData</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getFontData--">getFontData</a></span>()</code>
<div class="block">Returns the font that will be used to print the text.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.RGB</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getForeground--">getForeground</a></span>()</code>
<div class="block">Returns the foreground color.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getStrikeout--">getStrikeout</a></span>()</code>
<div class="block">Returns the strikout flag.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getStyle--">getStyle</a></span>()</code>
<div class="block">Returns the text style.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getText--">getText</a></span>()</code>
<div class="block">Returns the text that will be printed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getUnderline--">getUnderline</a></span>()</code>
<div class="block">Returns the underline flag.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#getWordSplitting--">getWordSplitting</a></span>()</code>
<div class="block">Returns whether word splitting is enabled.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/nebula/paperclips/core/PrintIterator.html" title="interface in org.eclipse.nebula.paperclips.core">PrintIterator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#iterator-org.eclipse.swt.graphics.Device-org.eclipse.swt.graphics.GC-">iterator</a></span>(org.eclipse.swt.graphics.Device&nbsp;device,
org.eclipse.swt.graphics.GC&nbsp;gc)</code>
<div class="block">Returns a PrintIterator for laying out the contents of this Print.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setAlignment-int-">setAlignment</a></span>(int&nbsp;alignment)</code>
<div class="block">Sets the horizontal text alignment.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setBackground-org.eclipse.swt.graphics.RGB-">setBackground</a></span>(org.eclipse.swt.graphics.RGB&nbsp;background)</code>
<div class="block">Sets the background color to the argument.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setFontData-org.eclipse.swt.graphics.FontData-">setFontData</a></span>(org.eclipse.swt.graphics.FontData&nbsp;fontData)</code>
<div class="block">Sets the font that will be used to print the text.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setForeground-org.eclipse.swt.graphics.RGB-">setForeground</a></span>(org.eclipse.swt.graphics.RGB&nbsp;foreground)</code>
<div class="block">Sets the foreground color to the argument.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setStrikeout-boolean-">setStrikeout</a></span>(boolean&nbsp;strikeout)</code>
<div class="block">Sets the strikeout flag to the argument.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setStyle-org.eclipse.nebula.paperclips.core.text.TextStyle-">setStyle</a></span>(<a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a>&nbsp;style)</code>
<div class="block">Sets the text style to the argument.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setText-java.lang.String-">setText</a></span>(java.lang.String&nbsp;text)</code>
<div class="block">Sets the text that will be printed.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setUnderline-boolean-">setUnderline</a></span>(boolean&nbsp;underline)</code>
<div class="block">Sets the underline flag to the argument.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextPrint.html#setWordSplitting-boolean-">setWordSplitting</a></span>(boolean&nbsp;wordBreaking)</code>
<div class="block">Sets whether word splitting is enabled.</div>
</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, finalize, getClass, 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="DEFAULT_TEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TEXT</h4>
<pre>public static final&nbsp;java.lang.String DEFAULT_TEXT</pre>
<div class="block">The default text for a TextPrint. Value is "".</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.paperclips.core.text.TextPrint.DEFAULT_TEXT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_FONT_DATA">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_FONT_DATA</h4>
<pre>public static final&nbsp;org.eclipse.swt.graphics.FontData DEFAULT_FONT_DATA</pre>
<div class="block">The default font data for a TextPrint. Value is device-dependent.</div>
</li>
</ul>
<a name="DEFAULT_ALIGN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_ALIGN</h4>
<pre>public static final&nbsp;int DEFAULT_ALIGN</pre>
<div class="block">The default alignment for TextPrint. Value is SWT.LEFT.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.nebula.paperclips.core.text.TextPrint.DEFAULT_ALIGN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="text">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>text</h4>
<pre>java.lang.String text</pre>
</li>
</ul>
<a name="style">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>style</h4>
<pre><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a> style</pre>
</li>
</ul>
<a name="wordSplitting">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>wordSplitting</h4>
<pre>boolean wordSplitting</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TextPrint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextPrint</h4>
<pre>public&nbsp;TextPrint()</pre>
<div class="block">Constructs a TextPrint with the default properties.</div>
</li>
</ul>
<a name="TextPrint-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextPrint</h4>
<pre>public&nbsp;TextPrint(java.lang.String&nbsp;text)</pre>
<div class="block">Constructs a TextPrint with the given text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to print.</dd>
</dl>
</li>
</ul>
<a name="TextPrint-java.lang.String-org.eclipse.swt.graphics.FontData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextPrint</h4>
<pre>public&nbsp;TextPrint(java.lang.String&nbsp;text,
org.eclipse.swt.graphics.FontData&nbsp;fontData)</pre>
<div class="block">Constructs a TextPrint with the given text and font data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to print.</dd>
<dd><code>fontData</code> - the font that will be used to print the text.</dd>
</dl>
</li>
</ul>
<a name="TextPrint-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextPrint</h4>
<pre>public&nbsp;TextPrint(java.lang.String&nbsp;text,
int&nbsp;align)</pre>
<div class="block">Constructs a TextPrint with the give text and alignment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to print.</dd>
<dd><code>align</code> - the horizontal text alignment. Must be one of <code>SWT.LEFT</code>
, <code>SWT.CENTER</code> or <code>SWT.RIGHT</code>.</dd>
</dl>
</li>
</ul>
<a name="TextPrint-java.lang.String-org.eclipse.swt.graphics.FontData-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextPrint</h4>
<pre>public&nbsp;TextPrint(java.lang.String&nbsp;text,
org.eclipse.swt.graphics.FontData&nbsp;fontData,
int&nbsp;align)</pre>
<div class="block">Constructs a TextPrint with the given text, font data, and alignment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to print.</dd>
<dd><code>fontData</code> - the font that will be used to print the text.</dd>
<dd><code>align</code> - the horizontal text alignment. Must be one of <code>SWT.LEFT</code>
, <code>SWT.CENTER</code> or <code>SWT.RIGHT</code>.</dd>
</dl>
</li>
</ul>
<a name="TextPrint-java.lang.String-org.eclipse.nebula.paperclips.core.text.TextStyle-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TextPrint</h4>
<pre>public&nbsp;TextPrint(java.lang.String&nbsp;text,
<a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a>&nbsp;style)</pre>
<div class="block">Constructs a TextPrint with the given text and style.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to print.</dd>
<dd><code>style</code> - the style to apply to the text.</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="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>public&nbsp;java.lang.String&nbsp;getText()</pre>
<div class="block">Returns the text that will be printed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the text that will be printed.</dd>
</dl>
</li>
</ul>
<a name="setText-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setText</h4>
<pre>public&nbsp;void&nbsp;setText(java.lang.String&nbsp;text)</pre>
<div class="block">Sets the text that will be printed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to print.</dd>
</dl>
</li>
</ul>
<a name="getStyle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyle</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a>&nbsp;getStyle()</pre>
<div class="block">Returns the text style.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the text style.</dd>
</dl>
</li>
</ul>
<a name="setStyle-org.eclipse.nebula.paperclips.core.text.TextStyle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStyle</h4>
<pre>public&nbsp;void&nbsp;setStyle(<a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text">TextStyle</a>&nbsp;style)</pre>
<div class="block">Sets the text style to the argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>style</code> - the new text style.</dd>
</dl>
</li>
</ul>
<a name="getFontData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFontData</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.FontData&nbsp;getFontData()</pre>
<div class="block">Returns the font that will be used to print the text.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the font that will be used to print the text.</dd>
</dl>
</li>
</ul>
<a name="setFontData-org.eclipse.swt.graphics.FontData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFontData</h4>
<pre>public&nbsp;void&nbsp;setFontData(org.eclipse.swt.graphics.FontData&nbsp;fontData)</pre>
<div class="block">Sets the font that will be used to print the text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fontData</code> - the font that will be used to print the text.</dd>
</dl>
</li>
</ul>
<a name="getAlignment--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlignment</h4>
<pre>public&nbsp;int&nbsp;getAlignment()</pre>
<div class="block">Returns the horizontal text alignment. Possible values include
<code>SWT.LEFT</code>, <code>SWT.CENTER</code> or <code>SWT.RIGHT</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the horizontal text alignment.</dd>
</dl>
</li>
</ul>
<a name="setAlignment-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAlignment</h4>
<pre>public&nbsp;void&nbsp;setAlignment(int&nbsp;alignment)</pre>
<div class="block">Sets the horizontal text alignment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>alignment</code> - the horizontal text alignment. Must be one of <code>SWT.LEFT</code>
, <code>SWT.CENTER</code> or <code>SWT.RIGHT</code>.</dd>
</dl>
</li>
</ul>
<a name="getForeground--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeground</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.RGB&nbsp;getForeground()</pre>
<div class="block">Returns the foreground color. A null value indicates that the foreground
color is inherited.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the foreground color.</dd>
</dl>
</li>
</ul>
<a name="setForeground-org.eclipse.swt.graphics.RGB-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeground</h4>
<pre>public&nbsp;void&nbsp;setForeground(org.eclipse.swt.graphics.RGB&nbsp;foreground)</pre>
<div class="block">Sets the foreground color to the argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>foreground</code> - the new foreground color. A null value causes the foreground
color to be inherited.</dd>
</dl>
</li>
</ul>
<a name="getBackground--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBackground</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.RGB&nbsp;getBackground()</pre>
<div class="block">Returns the background color. A null value indicates that the background
is transparent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the background color.</dd>
</dl>
</li>
</ul>
<a name="setBackground-org.eclipse.swt.graphics.RGB-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBackground</h4>
<pre>public&nbsp;void&nbsp;setBackground(org.eclipse.swt.graphics.RGB&nbsp;background)</pre>
<div class="block">Sets the background color to the argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>background</code> - the new background color. A null value causes the background
to be transparent.</dd>
</dl>
</li>
</ul>
<a name="getUnderline--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnderline</h4>
<pre>public&nbsp;boolean&nbsp;getUnderline()</pre>
<div class="block">Returns the underline flag.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the underline flag.</dd>
</dl>
</li>
</ul>
<a name="setUnderline-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnderline</h4>
<pre>public&nbsp;void&nbsp;setUnderline(boolean&nbsp;underline)</pre>
<div class="block">Sets the underline flag to the argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>underline</code> - the underline flag.</dd>
</dl>
</li>
</ul>
<a name="getStrikeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStrikeout</h4>
<pre>public&nbsp;boolean&nbsp;getStrikeout()</pre>
<div class="block">Returns the strikout flag.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the strikout flag.</dd>
</dl>
</li>
</ul>
<a name="setStrikeout-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStrikeout</h4>
<pre>public&nbsp;void&nbsp;setStrikeout(boolean&nbsp;strikeout)</pre>
<div class="block">Sets the strikeout flag to the argument.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>strikeout</code> - the strikeout flag.</dd>
</dl>
</li>
</ul>
<a name="getWordSplitting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWordSplitting</h4>
<pre>public&nbsp;boolean&nbsp;getWordSplitting()</pre>
<div class="block">Returns whether word splitting is enabled. Default is true.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether word splitting is enabled.</dd>
</dl>
</li>
</ul>
<a name="setWordSplitting-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWordSplitting</h4>
<pre>public&nbsp;void&nbsp;setWordSplitting(boolean&nbsp;wordBreaking)</pre>
<div class="block">Sets whether word splitting is enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wordBreaking</code> - whether to allow word splitting.</dd>
</dl>
</li>
</ul>
<a name="iterator-org.eclipse.swt.graphics.Device-org.eclipse.swt.graphics.GC-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/nebula/paperclips/core/PrintIterator.html" title="interface in org.eclipse.nebula.paperclips.core">PrintIterator</a>&nbsp;iterator(org.eclipse.swt.graphics.Device&nbsp;device,
org.eclipse.swt.graphics.GC&nbsp;gc)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/nebula/paperclips/core/Print.html#iterator-org.eclipse.swt.graphics.Device-org.eclipse.swt.graphics.GC-">Print</a></code></span></div>
<div class="block">Returns a PrintIterator for laying out the contents of this Print. The
iterator uses a snapshot of the print at the time this method is invoked,
so subsequent changes to the Print will not affect the output of the
iterator.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/nebula/paperclips/core/Print.html#iterator-org.eclipse.swt.graphics.Device-org.eclipse.swt.graphics.GC-">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/nebula/paperclips/core/Print.html" title="interface in org.eclipse.nebula.paperclips.core">Print</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>device</code> - the graphics device this Print will be drawn onto.</dd>
<dd><code>gc</code> - the graphics context to be used for calculating layout and
drawing the Print's contents.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a PrintIterator for laying out the contents of this Print.</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/TextPrint.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/paperclips/core/text/TextIterator.html" title="class in org.eclipse.nebula.paperclips.core.text"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/paperclips/core/text/TextStyle.html" title="class in org.eclipse.nebula.paperclips.core.text"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/paperclips/core/text/TextPrint.html" target="_top">Frames</a></li>
<li><a href="TextPrint.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>