| <!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:40 CEST 2020 --> |
| <title>ITextFormatter</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="ITextFormatter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ITextFormatter.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/IPAddressFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/LongFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html" target="_top">Frames</a></li> |
| <li><a href="ITextFormatter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface ITextFormatter" class="title">Interface ITextFormatter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.util.EventListener, org.eclipse.swt.internal.SWTEventListener, org.eclipse.swt.events.VerifyListener</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/AbstractFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">AbstractFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/BigDecimalFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">BigDecimalFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/BigIntegerFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">BigIntegerFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/DateFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">DateFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/DateTimeFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">DateTimeFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/DoubleFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">DoubleFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/FloatFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">FloatFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/IntegerFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">IntegerFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/IPAddressFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">IPAddressFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/LongFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">LongFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">MaskFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/NumberFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">NumberFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/PercentFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">PercentFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ShortFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">ShortFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/StringFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">StringFormatter</a>, <a href="../../../../../org/eclipse/nebula/widgets/formattedtext/TimeFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext">TimeFormatter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ITextFormatter</span> |
| extends org.eclipse.swt.events.VerifyListener</pre> |
| <div class="block">Interface defining all the text formatters.<p> |
| |
| Each formatter is associated with a <code>Text</code> control and can not be |
| shared. Formatters have and edit mask applied when the associated Text has |
| the focus, and a display mask for when the Text looses the focus. |
| The formatter must control editing keystroke by keystroke. For this is it |
| declared as a VerifyListener of the <code>Text</code> widget.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#detach--">detach</a></span>()</code> |
| <div class="block">Called when the formatter is replaced by an other one in the <code>FormattedText</code> |
| control.</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/ITextFormatter.html#getDisplayString--">getDisplayString</a></span>()</code> |
| <div class="block">Returns the current value formatted for display.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/ITextFormatter.html#getEditString--">getEditString</a></span>()</code> |
| <div class="block">Returns the current value formatted for editing.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#getValue--">getValue</a></span>()</code> |
| <div class="block">Returns the current value of the text control.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.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="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#isEmpty--">isEmpty</a></span>()</code> |
| <div class="block">Returns <code>true</code> if current edited value is empty, else returns |
| <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html#isValid--">isValid</a></span>()</code> |
| <div class="block">Returns <code>true</code> if current edited value is valid, else returns |
| <code>false</code>.</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/ITextFormatter.html#setIgnore-boolean-">setIgnore</a></span>(boolean ignore)</code> |
| <div class="block">Specify whether or not <code>VerifyEvent</code> events must be processed.</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/formattedtext/ITextFormatter.html#setText-org.eclipse.swt.widgets.Text-">setText</a></span>(org.eclipse.swt.widgets.Text text)</code> |
| <div class="block">Sets the <code>Text</code> widget that will be managed by this formatter.</div> |
| </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/formattedtext/ITextFormatter.html#setValue-java.lang.Object-">setValue</a></span>(java.lang.Object value)</code> |
| <div class="block">Sets the value to edit.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.events.VerifyListener"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.swt.events.VerifyListener</h3> |
| <code>verifyText</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="detach--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detach</h4> |
| <pre>void detach()</pre> |
| <div class="block">Called when the formatter is replaced by an other one in the <code>FormattedText</code> |
| control. Allow to release resources like additional listeners.</div> |
| </li> |
| </ul> |
| <a name="getDisplayString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDisplayString</h4> |
| <pre>java.lang.String getDisplayString()</pre> |
| <div class="block">Returns the current value formatted for display. |
| This method is called by <code>FormattedText</code> when the <code>Text</code> |
| widget looses focus.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>display string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEditString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEditString</h4> |
| <pre>java.lang.String 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.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>edit string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>java.lang.Object getValue()</pre> |
| <div class="block">Returns the current value of the text control. If the current value is |
| invalid for its type (ex. Date missing parts), returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre>java.lang.Class<?> 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/ITextFormatter.html#getValue--"><code>getValue()</code></a>.</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>boolean isEmpty()</pre> |
| <div class="block">Returns <code>true</code> if current edited value is empty, else returns |
| <code>false</code>. An empty value depends of the formatter and is not |
| just an empty string in the Text widget.</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>boolean isValid()</pre> |
| <div class="block">Returns <code>true</code> if current edited value is valid, else returns |
| <code>false</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if valid, else false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIgnore-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnore</h4> |
| <pre>void setIgnore(boolean ignore)</pre> |
| <div class="block">Specify whether or not <code>VerifyEvent</code> events must be processed. |
| Those events are the base of all formatters, allowing on-the-fly |
| processing of each text change in the Text widget. |
| In some situations (e.g. when focus change), the <code>FormattedText</code> |
| must change the text in the widget without formatting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ignore</code> - when true, VerifyEvent events are processed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setText-org.eclipse.swt.widgets.Text-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setText</h4> |
| <pre>void setText(org.eclipse.swt.widgets.Text text)</pre> |
| <div class="block">Sets the <code>Text</code> widget that will be managed by this formatter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>text</code> - Text widget</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre>void setValue(java.lang.Object value)</pre> |
| <div class="block">Sets the value to edit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - value</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/ITextFormatter.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/IPAddressFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/LongFormatter.html" title="class in org.eclipse.nebula.widgets.formattedtext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/formattedtext/ITextFormatter.html" target="_top">Frames</a></li> |
| <li><a href="ITextFormatter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
