blob: 599fb70c23b2414efce86d7e6f5b59e9fbcd32cc [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>AbstractEEFController</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="AbstractEEFController";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFCustomWidgetController.html" title="class in org.eclipse.eef.core.api.controllers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/eef/core/api/controllers/AbstractEEFController.html" target="_top">Frames</a></li>
<li><a href="AbstractEEFController.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.core.api.controllers</div>
<h2 title="Class AbstractEEFController" class="title">Class AbstractEEFController</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.eef.core.api.controllers.AbstractEEFController</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html" title="interface in org.eclipse.eef.core.api.controllers">IEEFController</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFWidgetController.html" title="class in org.eclipse.eef.core.api.controllers">AbstractEEFWidgetController</a>, <a href="../../../../../../org/eclipse/eef/core/internal/controllers/EEFGroupController.html" title="class in org.eclipse.eef.core.internal.controllers">EEFGroupController</a>, <a href="../../../../../../org/eclipse/eef/core/internal/controllers/EEFSectionController.html" title="class in org.eclipse.eef.core.internal.controllers">EEFSectionController</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractEEFController</span>
extends java.lang.Object
implements <a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html" title="interface in org.eclipse.eef.core.api.controllers">IEEFController</a></pre>
<div class="block">Superclass of all the controllers containing some utility methods.</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 <a href="../../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html" title="interface in org.eclipse.eef.core.api">EditingContextAdapter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#editingContextAdapter">editingContextAdapter</a></span></code>
<div class="block">The editing context adapter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.eclipse.sirius.common.interpreter.api.IInterpreter</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#interpreter">interpreter</a></span></code>
<div class="block">The interpreter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.sirius.common.interpreter.api.IVariableManager</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#variableManager">variableManager</a></span></code>
<div class="block">The variable manager.</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/core/api/controllers/AbstractEEFController.html#AbstractEEFController-org.eclipse.sirius.common.interpreter.api.IVariableManager-org.eclipse.sirius.common.interpreter.api.IInterpreter-org.eclipse.eef.core.api.EditingContextAdapter-">AbstractEEFController</a></span>(org.eclipse.sirius.common.interpreter.api.IVariableManager&nbsp;variableManager,
org.eclipse.sirius.common.interpreter.api.IInterpreter&nbsp;interpreter,
<a href="../../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html" title="interface in org.eclipse.eef.core.api">EditingContextAdapter</a>&nbsp;editingContextAdapter)</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="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><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 abstract org.eclipse.emf.ecore.EObject</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#getValidationRulesContainer--">getValidationRulesContainer</a></span>()</code>
<div class="block">Returns the EObject containing the validation rules.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract org.eclipse.emf.ecore.EReference</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#getValidationRulesReference--">getValidationRulesReference</a></span>()</code>
<div class="block">Returns the EReference containing the validation rules.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/eclipse/eef/core/api/utils/EvalFactory.Eval.html" title="class in org.eclipse.eef.core.api.utils">EvalFactory.Eval</a>&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#newEval--">newEval</a></span>()</code>
<div class="block">Returns a new <a href="../../../../../../org/eclipse/eef/core/api/utils/EvalFactory.Eval.html" title="class in org.eclipse.eef.core.api.utils"><code>EvalFactory.Eval</code></a> instance initialized with the <code>IInterpreter</code> and the <code>IVariableManager</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/core/api/controllers/AbstractEEFController.html#onValidation-java.util.function.Consumer-">onValidation</a></span>(java.util.function.Consumer&lt;java.util.List&lt;<a href="../../../../../../org/eclipse/eef/core/api/controllers/IValidationRuleResult.html" title="interface in org.eclipse.eef.core.api.controllers">IValidationRuleResult</a>&gt;&gt;&nbsp;consumer)</code>
<div class="block">Registers a consumer which will be called with the validation status.</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/controllers/AbstractEEFController.html#refresh--">refresh</a></span>()</code>
<div class="block">Refresh the controller.</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/controllers/AbstractEEFController.html#removeValidationConsumer--">removeValidationConsumer</a></span>()</code>
<div class="block">Removes the consumer of the validation.</div>
</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, 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="interpreter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interpreter</h4>
<pre>protected final&nbsp;org.eclipse.sirius.common.interpreter.api.IInterpreter interpreter</pre>
<div class="block">The interpreter.</div>
</li>
</ul>
<a name="variableManager">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>variableManager</h4>
<pre>protected final&nbsp;org.eclipse.sirius.common.interpreter.api.IVariableManager variableManager</pre>
<div class="block">The variable manager.</div>
</li>
</ul>
<a name="editingContextAdapter">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>editingContextAdapter</h4>
<pre>protected final&nbsp;<a href="../../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html" title="interface in org.eclipse.eef.core.api">EditingContextAdapter</a> editingContextAdapter</pre>
<div class="block">The editing context adapter.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractEEFController-org.eclipse.sirius.common.interpreter.api.IVariableManager-org.eclipse.sirius.common.interpreter.api.IInterpreter-org.eclipse.eef.core.api.EditingContextAdapter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractEEFController</h4>
<pre>public&nbsp;AbstractEEFController(org.eclipse.sirius.common.interpreter.api.IVariableManager&nbsp;variableManager,
org.eclipse.sirius.common.interpreter.api.IInterpreter&nbsp;interpreter,
<a href="../../../../../../org/eclipse/eef/core/api/EditingContextAdapter.html" title="interface in org.eclipse.eef.core.api">EditingContextAdapter</a>&nbsp;editingContextAdapter)</pre>
<div class="block">The constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableManager</code> - The variable manager</dd>
<dd><code>interpreter</code> - The interpreter</dd>
<dd><code>editingContextAdapter</code> - The editing context adapter</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="newEval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newEval</h4>
<pre>protected&nbsp;<a href="../../../../../../org/eclipse/eef/core/api/utils/EvalFactory.Eval.html" title="class in org.eclipse.eef.core.api.utils">EvalFactory.Eval</a>&lt;java.lang.Object&gt;&nbsp;newEval()</pre>
<div class="block">Returns a new <a href="../../../../../../org/eclipse/eef/core/api/utils/EvalFactory.Eval.html" title="class in org.eclipse.eef.core.api.utils"><code>EvalFactory.Eval</code></a> instance initialized with the <code>IInterpreter</code> and the <code>IVariableManager</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new Eval.</dd>
</dl>
</li>
</ul>
<a name="onValidation-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onValidation</h4>
<pre>public&nbsp;void&nbsp;onValidation(java.util.function.Consumer&lt;java.util.List&lt;<a href="../../../../../../org/eclipse/eef/core/api/controllers/IValidationRuleResult.html" title="interface in org.eclipse.eef.core.api.controllers">IValidationRuleResult</a>&gt;&gt;&nbsp;consumer)</pre>
<div class="block">Registers a consumer which will be called with the validation status.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html#onValidation-java.util.function.Consumer-">onValidation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html" title="interface in org.eclipse.eef.core.api.controllers">IEEFController</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The consumer of the validation status</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html#onValidation-java.util.function.Consumer-"><code>IEEFController.onValidation(java.util.function.Consumer)</code></a></dd>
</dl>
</li>
</ul>
<a name="removeValidationConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeValidationConsumer</h4>
<pre>public&nbsp;void&nbsp;removeValidationConsumer()</pre>
<div class="block">Removes the consumer of the validation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html#removeValidationConsumer--">removeValidationConsumer</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html" title="interface in org.eclipse.eef.core.api.controllers">IEEFController</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html#removeValidationConsumer--"><code>IEEFController.removeValidationConsumer()</code></a></dd>
</dl>
</li>
</ul>
<a name="refresh--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refresh</h4>
<pre>public&nbsp;void&nbsp;refresh()</pre>
<div class="block">Refresh the controller.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html#refresh--">refresh</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html" title="interface in org.eclipse.eef.core.api.controllers">IEEFController</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/core/api/controllers/IEEFController.html#refresh--"><code>IEEFController.refresh()</code></a></dd>
</dl>
</li>
</ul>
<a name="getValidationRulesContainer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValidationRulesContainer</h4>
<pre>protected abstract&nbsp;org.eclipse.emf.ecore.EObject&nbsp;getValidationRulesContainer()</pre>
<div class="block">Returns the EObject containing the validation rules.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The EObject containing the validation rules</dd>
</dl>
</li>
</ul>
<a name="getValidationRulesReference--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValidationRulesReference</h4>
<pre>protected abstract&nbsp;org.eclipse.emf.ecore.EReference&nbsp;getValidationRulesReference()</pre>
<div class="block">Returns the EReference containing the validation rules.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The EReference containing the validation rules.</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/controllers/AbstractEEFCustomWidgetController.html" title="class in org.eclipse.eef.core.api.controllers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/eef/core/api/controllers/AbstractEEFController.html" target="_top">Frames</a></li>
<li><a href="AbstractEEFController.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>