blob: 0c68dc7261d2b4b5affdacb3468cd5ce72fc3062 [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 Sep 26 09:08:10 CEST 2018 -->
<title>EditingContextAdapter</title>
<meta name="date" content="2018-09-26">
<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="EditingContextAdapter";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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="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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/eef/core/api/EEFExpressionUtils.html" title="class in org.eclipse.eef.core.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/eef/core/api/EditingContextAdapter.html" target="_top">Frames</a></li>
<li><a href="EditingContextAdapter.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.core.api</div>
<h2 title="Interface EditingContextAdapter" class="title">Interface EditingContextAdapter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EditingContextAdapter</span></pre>
<div class="block">Connects EEF views with the external context (e.g. an editor) on behalf of which the views display and edit model
elements. Clients which use the EEF runtime must supply an implementation of this interface so that the EEF views can
be correctly integrated into the source context.</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html#addLockStatusChangedListener-java.util.function.Consumer-">addLockStatusChangedListener</a></span>(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../../../org/eclipse/eef/core/api/LockStatusChangeEvent.html" title="class in org.eclipse.eef.core.api">LockStatusChangeEvent</a>&gt;&gt;&nbsp;listener)</code>
<div class="block">Adds a new lock status changed listener to the collection of lock status changed listeners to be notified when
model elements are locked or unlocked.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.eclipse.emf.edit.domain.EditingDomain</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html#getEditingDomain--">getEditingDomain</a></span>()</code>
<div class="block">Returns the editing domain.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/eef/core/api/LockStatusChangeEvent.LockStatus.html" title="enum in org.eclipse.eef.core.api">LockStatusChangeEvent.LockStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html#getLockStatus-org.eclipse.emf.ecore.EObject-">getLockStatus</a></span>(org.eclipse.emf.ecore.EObject&nbsp;obj)</code>
<div class="block">Returns the current locking status of an element.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.eclipse.core.runtime.IStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html#performModelChange-java.lang.Runnable-">performModelChange</a></span>(java.lang.Runnable&nbsp;operation)</code>
<div class="block">Executes an operation which which potentially makes changes to the model.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html#registerModelChangeListener-java.util.function.Consumer-">registerModelChangeListener</a></span>(java.util.function.Consumer&lt;java.util.List&lt;org.eclipse.emf.common.notify.Notification&gt;&gt;&nbsp;listener)</code>
<div class="block">Registers the sole unique model change listener listener to be notified when the model is modified.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html#removeLockStatusChangedListener-java.util.function.Consumer-">removeLockStatusChangedListener</a></span>(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../../../org/eclipse/eef/core/api/LockStatusChangeEvent.html" title="class in org.eclipse.eef.core.api">LockStatusChangeEvent</a>&gt;&gt;&nbsp;listener)</code>
<div class="block">Removes the given lock status changed listener from the list of all lock status changed listeners..</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/core/api/EditingContextAdapter.html#unregisterModelChangeListener--">unregisterModelChangeListener</a></span>()</code>
<div class="block">Unregisters the currently set model change listener.</div>
</td>
</tr>
</table>
</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="performModelChange-java.lang.Runnable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>performModelChange</h4>
<pre>org.eclipse.core.runtime.IStatus&nbsp;performModelChange(java.lang.Runnable&nbsp;operation)</pre>
<div class="block">Executes an operation which which potentially makes changes to the model.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operation</code> - the operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the status of the operation execution.</dd>
</dl>
</li>
</ul>
<a name="registerModelChangeListener-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerModelChangeListener</h4>
<pre>void&nbsp;registerModelChangeListener(java.util.function.Consumer&lt;java.util.List&lt;org.eclipse.emf.common.notify.Notification&gt;&gt;&nbsp;listener)</pre>
<div class="block">Registers the sole unique model change listener listener to be notified when the model is modified. The listener
will be called in a context in which it may not be possible to perform additional changes to the model itself.
The list of changes supplied to the listener should be considered only as a hint and may be <code>null</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener to invoke when the model is modified.</dd>
</dl>
</li>
</ul>
<a name="unregisterModelChangeListener--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregisterModelChangeListener</h4>
<pre>void&nbsp;unregisterModelChangeListener()</pre>
<div class="block">Unregisters the currently set model change listener. Does nothing if none is currently registered.</div>
</li>
</ul>
<a name="getEditingDomain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEditingDomain</h4>
<pre>org.eclipse.emf.edit.domain.EditingDomain&nbsp;getEditingDomain()</pre>
<div class="block">Returns the editing domain.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The editing domain</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.0</dd>
</dl>
</li>
</ul>
<a name="addLockStatusChangedListener-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLockStatusChangedListener</h4>
<pre>void&nbsp;addLockStatusChangedListener(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../../../org/eclipse/eef/core/api/LockStatusChangeEvent.html" title="class in org.eclipse.eef.core.api">LockStatusChangeEvent</a>&gt;&gt;&nbsp;listener)</pre>
<div class="block">Adds a new lock status changed listener to the collection of lock status changed listeners to be notified when
model elements are locked or unlocked.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener to invoke when elements are locked or unlocked.</dd>
</dl>
</li>
</ul>
<a name="removeLockStatusChangedListener-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLockStatusChangedListener</h4>
<pre>void&nbsp;removeLockStatusChangedListener(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../../../org/eclipse/eef/core/api/LockStatusChangeEvent.html" title="class in org.eclipse.eef.core.api">LockStatusChangeEvent</a>&gt;&gt;&nbsp;listener)</pre>
<div class="block">Removes the given lock status changed listener from the list of all lock status changed listeners..</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The listener to unregister</dd>
</dl>
</li>
</ul>
<a name="getLockStatus-org.eclipse.emf.ecore.EObject-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLockStatus</h4>
<pre><a href="../../../../../org/eclipse/eef/core/api/LockStatusChangeEvent.LockStatus.html" title="enum in org.eclipse.eef.core.api">LockStatusChangeEvent.LockStatus</a>&nbsp;getLockStatus(org.eclipse.emf.ecore.EObject&nbsp;obj)</pre>
<div class="block">Returns the current locking status of an element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current lock status of the element.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/eef/core/api/EEFExpressionUtils.html" title="class in org.eclipse.eef.core.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/eef/core/api/EditingContextAdapter.html" target="_top">Frames</a></li>
<li><a href="EditingContextAdapter.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>