Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / formattedtext / StringFormatter.html
blob: 67fd9a402ceb39cad57b87b4d27dcae8bcbfd0ef [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:41 CEST 2020 -->
<title>StringFormatter</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="StringFormatter";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/StringFormatter.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/formattedtext/ShortFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/TimeFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/formattedtext/StringFormatter.html" target="_top">Frames</a></li>
<li><a href="StringFormatter.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="#fields.inherited.from.class.org.eclipse.nebula.widgets.formattedtext.AbstractFormatter">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>Field&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.formattedtext</div>
<h2 title="Class StringFormatter" class="title">Class StringFormatter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">org.eclipse.nebula.widgets.formattedtext.AbstractFormatter</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.formattedtext.StringFormatter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.EventListener, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html" title="interface in org.eclipse.nebula.widgets.formattedtext">ITextFormatter</a>, org.eclipse.swt.events.VerifyListener, org.eclipse.swt.internal.SWTEventListener</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">StringFormatter</span>
extends <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">AbstractFormatter</a></pre>
<div class="block">Default formatter for the String class.<br>
This formatter is a kind of NullFormatter and do no formatting, allowing
the edit of simple String values, without constraints.<br>
It is registered in the DefaultFormatterFactory as the default formatter
for String values.</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.nebula.widgets.formattedtext.AbstractFormatter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.nebula.widgets.formattedtext.<a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">AbstractFormatter</a></h3>
<code><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#EMPTY">EMPTY</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#ignore">ignore</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#SPACE">SPACE</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#text">text</a></code></li>
</ul>
</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/formattedtext/StringFormatter.html#StringFormatter--">StringFormatter</a></span>()</code>&nbsp;</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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html#getDisplayString--">getDisplayString</a></span>()</code>
<div class="block">Returns the current value formatted for display.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html#getEditString--">getEditString</a></span>()</code>
<div class="block">Returns the current value formatted for editing.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns the current value.<br>
This formatter has no formatting features.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html#getValueType--">getValueType</a></span>()</code>
<div class="block">Returns the type of value this <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html" title="interface in org.eclipse.nebula.widgets.formattedtext"><code>ITextFormatter</code></a> handles,
i.e.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Returns <code>true</code> if current edited value is empty, else returns
<code>false</code>.<br>
A string is empty if its length is 0.</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/widgets/formattedtext/StringFormatter.html#isValid--">isValid</a></span>()</code>
<div class="block">Returns <code>true</code> if current edited value is valid, else returns
<code>false</code>.<br>
StringFormatter always return true.</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/formattedtext/StringFormatter.html#setValue-java.lang.Object-">setValue</a></span>(java.lang.Object&nbsp;value)</code>
<div class="block">Sets the value to edit.</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/formattedtext/StringFormatter.html#verifyText-org.eclipse.swt.events.VerifyEvent-">verifyText</a></span>(org.eclipse.swt.events.VerifyEvent&nbsp;e)</code>
<div class="block">Handles a <code>VerifyEvent</code> sent when the text is about to be modified.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.nebula.widgets.formattedtext.AbstractFormatter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.nebula.widgets.formattedtext.<a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">AbstractFormatter</a></h3>
<code><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#beep--">beep</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#detach--">detach</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#setIgnore-boolean-">setIgnore</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#setText-org.eclipse.swt.widgets.Text-">setText</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#updateText-java.lang.String-">updateText</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html#updateText-java.lang.String-int-">updateText</a></code></li>
</ul>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StringFormatter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StringFormatter</h4>
<pre>public&nbsp;StringFormatter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDisplayString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDisplayString()</pre>
<div class="block">Returns the current value formatted for display.<p>
There is no difference in this formatter between edit and display values.
So this method returns the edit string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>display string</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#getDisplayString--"><code>ITextFormatter.getDisplayString()</code></a></dd>
</dl>
</li>
</ul>
<a name="getEditString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEditString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getEditString()</pre>
<div class="block">Returns the current value formatted for editing.
This method is called by <code>FormattedText</code> when the <code>Text</code>
widget gains focus.<br>
This formatter has no formatting features. So it simply return the Text
widget content.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>edit string</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#getEditString--"><code>ITextFormatter.getEditString()</code></a></dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getValue()</pre>
<div class="block">Returns the current value.<br>
This formatter has no formatting features. So it simply return the Text
widget content.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current string value</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#getValue--"><code>ITextFormatter.getValue()</code></a></dd>
</dl>
</li>
</ul>
<a name="getValueType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre>public&nbsp;java.lang.Class&lt;java.lang.String&gt;&nbsp;getValueType()</pre>
<div class="block">Returns the type of value this <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html" title="interface in org.eclipse.nebula.widgets.formattedtext"><code>ITextFormatter</code></a> handles,
i.e. returns in <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html#getValue--"><code>getValue()</code></a>.<br>
A StringFormatter always returns a String value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value type.</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block">Returns <code>true</code> if current edited value is empty, else returns
<code>false</code>.<br>
A string is empty if its length is 0.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if empty, else false</dd>
</dl>
</li>
</ul>
<a name="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;isValid()</pre>
<div class="block">Returns <code>true</code> if current edited value is valid, else returns
<code>false</code>.<br>
StringFormatter always return true.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#isValid--"><code>ITextFormatter.isValid()</code></a></dd>
</dl>
</li>
</ul>
<a name="setValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>public&nbsp;void&nbsp;setValue(java.lang.Object&nbsp;value)</pre>
<div class="block">Sets the value to edit. The value provided must be a <code>String</code>.
The Text widget is simply updated with the value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - string value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if not a string</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#setValue-java.lang.Object-"><code>ITextFormatter.setValue(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="verifyText-org.eclipse.swt.events.VerifyEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>verifyText</h4>
<pre>public&nbsp;void&nbsp;verifyText(org.eclipse.swt.events.VerifyEvent&nbsp;e)</pre>
<div class="block">Handles a <code>VerifyEvent</code> sent when the text is about to be modified.
This method is the entry point of all operations of formatting.<br>
This formatter has no formatting features. So this method do nothing.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>VerifyListener.verifyText(org.eclipse.swt.events.VerifyEvent)</code></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/StringFormatter.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/formattedtext/ShortFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/TimeFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/formattedtext/StringFormatter.html" target="_top">Frames</a></li>
<li><a href="StringFormatter.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="#fields.inherited.from.class.org.eclipse.nebula.widgets.formattedtext.AbstractFormatter">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>Field&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>