Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / formattedtext / MaskFormatter.html
blob: afb5df640884a51637d153b3914ee47994927c64 [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:40 CEST 2020 -->
<title>MaskFormatter</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="MaskFormatter";
}
}
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};
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/MaskFormatter.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/LongFormatter.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/NumberFormatter.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/MaskFormatter.html" target="_top">Frames</a></li>
<li><a href="MaskFormatter.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.formattedtext</div>
<h2 title="Class MaskFormatter" class="title">Class MaskFormatter</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.MaskFormatter</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">MaskFormatter</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">This class provides formatting of <code>String</code> values in a
<code>FormattedText</code>.<p>
<h4>Pattern Characters</h4>
<table border=0 cellspacing=3 cellpadding=0 summary="Chart shows pattern letters, date/time component, presentation, and examples.">
<tr bgcolor="#ccccff">
<th align=left>Symbol</th>
<th align=left>Meaning</th>
</tr>
<tr>
<td><code>#</code></td>
<td>Digit</td>
</tr>
<tr bgcolor="#eeeeff">
<td><code>A</code></td>
<td>Alphanumeric</td>
</tr>
<tr>
<td><code>U</code></td>
<td>Alphanumeric converted in uppercase</td>
</tr>
<tr bgcolor="#eeeeff">
<td><code>L</code></td>
<td>Alphanumeric converted in lowercase</td>
</tr>
</table>
All other characters are considered as separators.
<h4>Examples</h4>
<code>newFormatter("(###) UUU-AAAA");</code><br>
<code>setValue("123aBcDeF");</code> -> will display as "(123) ABC-DeF".</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>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html#count">count</a></span></code>
<div class="block">Current number of characters in the buffer (except mask characters)</div>
</td>
</tr>
<tr 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/formattedtext/MaskFormatter.html#editPattern">editPattern</a></span></code>
<div class="block">Edit mask</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.StringBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html#editValue">editValue</a></span></code>
<div class="block">Buffer for the edit value</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html#positions">positions</a></span></code>
<div class="block">Number of editable positions in the mask</div>
</td>
</tr>
</table>
<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/MaskFormatter.html#MaskFormatter-java.lang.String-">MaskFormatter</a></span>(java.lang.String&nbsp;editPattern)</code>
<div class="block">Constructs a new instance with the given edit mask.</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 void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html#clearText-int-int-">clearText</a></span>(int&nbsp;start,
int&nbsp;len)</code>
<div class="block">Clear a part of the edition cache.</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/MaskFormatter.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/MaskFormatter.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/MaskFormatter.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns the current value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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/MaskFormatter.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>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html#insertText-java.lang.String-int-">insertText</a></span>(java.lang.String&nbsp;txt,
int&nbsp;start)</code>
<div class="block">Inserts a sequence of characters in the edit buffer.</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/MaskFormatter.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 value is considered as empty in a MaskFormatter if the edit buffer
contains no characters except the mask characters.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.html#isHexDigit-char-">isHexDigit</a></span>(char&nbsp;ch)</code>&nbsp;</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/widgets/formattedtext/MaskFormatter.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="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.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="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/formattedtext/MaskFormatter.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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="editPattern">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>editPattern</h4>
<pre>protected&nbsp;java.lang.String editPattern</pre>
<div class="block">Edit mask</div>
</li>
</ul>
<a name="editValue">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>editValue</h4>
<pre>protected&nbsp;java.lang.StringBuffer editValue</pre>
<div class="block">Buffer for the edit value</div>
</li>
</ul>
<a name="positions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>positions</h4>
<pre>protected&nbsp;int positions</pre>
<div class="block">Number of editable positions in the mask</div>
</li>
</ul>
<a name="count">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>count</h4>
<pre>protected&nbsp;int count</pre>
<div class="block">Current number of characters in the buffer (except mask characters)</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MaskFormatter-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MaskFormatter</h4>
<pre>public&nbsp;MaskFormatter(java.lang.String&nbsp;editPattern)</pre>
<div class="block">Constructs a new instance with the given edit mask.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>editPattern</code> - edit mask</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="clearText-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearText</h4>
<pre>protected&nbsp;void&nbsp;clearText(int&nbsp;start,
int&nbsp;len)</pre>
<div class="block">Clear a part of the edition cache. Mask characters are preserved in their
positions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - beginning index</dd>
<dd><code>len</code> - length of portion to clear</dd>
</dl>
</li>
</ul>
<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.
The value returned is the content of the StringBuilder
<code>editValue</code> used as cache.</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. The value returned is the content of the edit
cache without any mask characters.</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/MaskFormatter.html#getValue--"><code>getValue()</code></a>.<br>
A MaskFormatter always returns a String value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value type.</dd>
</dl>
</li>
</ul>
<a name="insertText-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertText</h4>
<pre>protected&nbsp;int&nbsp;insertText(java.lang.String&nbsp;txt,
int&nbsp;start)</pre>
<div class="block">Inserts a sequence of characters in the edit buffer. The current content
of the buffer is override. The new position of the cursor is computed and
returned. Mask characters are preserved in their positions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txt</code> - String of characters to insert</dd>
<dd><code>start</code> - Starting position of insertion</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New position of the cursor</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 value is considered as empty in a MaskFormatter if the edit buffer
contains no characters except the mask characters.</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>. An empty value is considered as valid.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if valid, else false</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>.</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="blockList">
<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.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>VerifyListener.verifyText(org.eclipse.swt.events.VerifyEvent)</code></dd>
</dl>
</li>
</ul>
<a name="isHexDigit-char-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isHexDigit</h4>
<pre>protected&nbsp;boolean&nbsp;isHexDigit(char&nbsp;ch)</pre>
</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/MaskFormatter.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/LongFormatter.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/NumberFormatter.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/MaskFormatter.html" target="_top">Frames</a></li>
<li><a href="MaskFormatter.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>