blob: 4e919315a22d87a5d9fd9a1aaf1fc2c3bfb2e50e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_51) on Wed Jan 31 09:11:34 CET 2018 -->
<title>EEFTextMemento</title>
<meta name="date" content="2018-01-31">
<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="EEFTextMemento";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.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/eef/ide/ui/internal/widgets/EEFTextLifecycleManager.ConflictResolutionMode.html" title="enum in org.eclipse.eef.ide.ui.internal.widgets"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/IEEFToolbarLifecycleManager.html" title="interface in org.eclipse.eef.ide.ui.internal.widgets"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html" target="_top">Frames</a></li>
<li><a href="EEFTextMemento.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.eef.ide.ui.internal.widgets</div>
<h2 title="Class EEFTextMemento" class="title">Class EEFTextMemento</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.eef.ide.ui.internal.widgets.EEFTextMemento</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">EEFTextMemento</span>
extends java.lang.Object</pre>
<div class="block">A simple data record to remember un-commited user input for recovery in case of concurrent changes that could
override this input.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html#KEY">KEY</a></span></code>
<div class="block">The key used to attach the user input memento to the widget.</div>
</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/eef/ide/ui/internal/widgets/EEFTextMemento.html#EEFTextMemento-org.eclipse.eef.EEFTextDescription-java.lang.Object-java.lang.String-java.lang.String-">EEFTextMemento</a></span>(<a href="../../../../../../../org/eclipse/eef/EEFTextDescription.html" title="interface in org.eclipse.eef">EEFTextDescription</a>&nbsp;description,
java.lang.Object&nbsp;self,
java.lang.String&nbsp;referenceValue,
java.lang.String&nbsp;userInput)</code>
<div class="block">The constructor.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/eef/ide/ui/internal/widgets/EEFTextMemento.html#appliesTo-org.eclipse.eef.EEFTextDescription-java.util.Map-">appliesTo</a></span>(<a href="../../../../../../../org/eclipse/eef/EEFTextDescription.html" title="interface in org.eclipse.eef">EEFTextDescription</a>&nbsp;textDescription,
java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;variables)</code>
<div class="block">Indicates if the memento applies to the given lifecycle manager.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/eef/EEFTextDescription.html" title="interface in org.eclipse.eef">EEFTextDescription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Return the description.</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/eef/ide/ui/internal/widgets/EEFTextMemento.html#getReferenceValue--">getReferenceValue</a></span>()</code>
<div class="block">Return the referenceValue.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html#getUserInput--">getUserInput</a></span>()</code>
<div class="block">Return the userInput.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html" title="class in org.eclipse.eef.ide.ui.internal.widgets">EEFTextMemento</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html#of-org.eclipse.swt.widgets.Widget-">of</a></span>(org.eclipse.swt.widgets.Widget&nbsp;widget)</code>
<div class="block">Returns the memento of the given widget.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html#remove-org.eclipse.swt.widgets.Widget-">remove</a></span>(org.eclipse.swt.widgets.Widget&nbsp;widget)</code>
<div class="block">Removes the memento of the given widget.</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/eef/ide/ui/internal/widgets/EEFTextMemento.html#store-org.eclipse.swt.widgets.Widget-">store</a></span>(org.eclipse.swt.widgets.Widget&nbsp;widget)</code>
<div class="block">Stores the memento in the given widget.</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/eef/ide/ui/internal/widgets/EEFTextMemento.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KEY</h4>
<pre>public static final&nbsp;java.lang.String KEY</pre>
<div class="block">The key used to attach the user input memento to the widget.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.eef.ide.ui.internal.widgets.EEFTextMemento.KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EEFTextMemento-org.eclipse.eef.EEFTextDescription-java.lang.Object-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EEFTextMemento</h4>
<pre>public&nbsp;EEFTextMemento(<a href="../../../../../../../org/eclipse/eef/EEFTextDescription.html" title="interface in org.eclipse.eef">EEFTextDescription</a>&nbsp;description,
java.lang.Object&nbsp;self,
java.lang.String&nbsp;referenceValue,
java.lang.String&nbsp;userInput)</pre>
<div class="block">The constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - The description of the text widget.</dd>
<dd><code>self</code> - The "self" target element</dd>
<dd><code>referenceValue</code> - The reference value corresponding to the pristine text computed from the model</dd>
<dd><code>userInput</code> - The user input</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="appliesTo-org.eclipse.eef.EEFTextDescription-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appliesTo</h4>
<pre>public&nbsp;boolean&nbsp;appliesTo(<a href="../../../../../../../org/eclipse/eef/EEFTextDescription.html" title="interface in org.eclipse.eef">EEFTextDescription</a>&nbsp;textDescription,
java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;variables)</pre>
<div class="block">Indicates if the memento applies to the given lifecycle manager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>textDescription</code> - The description of the text widget of the lifecycle manager</dd>
<dd><code>variables</code> - The variables of the lifecycle manager</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the memento applies to the lifecycle manager, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="store-org.eclipse.swt.widgets.Widget-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;void&nbsp;store(org.eclipse.swt.widgets.Widget&nbsp;widget)</pre>
<div class="block">Stores the memento in the given widget.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>widget</code> - The widget</dd>
</dl>
</li>
</ul>
<a name="of-org.eclipse.swt.widgets.Widget-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html" title="class in org.eclipse.eef.ide.ui.internal.widgets">EEFTextMemento</a>&nbsp;of(org.eclipse.swt.widgets.Widget&nbsp;widget)</pre>
<div class="block">Returns the memento of the given widget.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>widget</code> - The widget</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The memento of the given widget</dd>
</dl>
</li>
</ul>
<a name="remove-org.eclipse.swt.widgets.Widget-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public static&nbsp;void&nbsp;remove(org.eclipse.swt.widgets.Widget&nbsp;widget)</pre>
<div class="block">Removes the memento of the given widget.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>widget</code> - The widget</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/eef/EEFTextDescription.html" title="interface in org.eclipse.eef">EEFTextDescription</a>&nbsp;getDescription()</pre>
<div class="block">Return the description.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the description</dd>
</dl>
</li>
</ul>
<a name="getReferenceValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;getReferenceValue()</pre>
<div class="block">Return the referenceValue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the referenceValue</dd>
</dl>
</li>
</ul>
<a name="getUserInput--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserInput</h4>
<pre>public&nbsp;java.lang.String&nbsp;getUserInput()</pre>
<div class="block">Return the userInput.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the userInput</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.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/eef/ide/ui/internal/widgets/EEFTextLifecycleManager.ConflictResolutionMode.html" title="enum in org.eclipse.eef.ide.ui.internal.widgets"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/eef/ide/ui/internal/widgets/IEEFToolbarLifecycleManager.html" title="interface in org.eclipse.eef.ide.ui.internal.widgets"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/eef/ide/ui/internal/widgets/EEFTextMemento.html" target="_top">Frames</a></li>
<li><a href="EEFTextMemento.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>