blob: 1af3baf00edc74684eca0247c7ecccdd1b0ab901 [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 Thu Jan 12 09:59:58 CET 2017 -->
<title>EEFViewDescription</title>
<meta name="date" content="2017-01-12">
<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="EEFViewDescription";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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><a href="../../../org/eclipse/eef/EEFValidationRuleDescription.html" title="interface in org.eclipse.eef"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/eclipse/eef/EEFWidgetAction.html" title="interface in org.eclipse.eef"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eclipse/eef/EEFViewDescription.html" target="_top">Frames</a></li>
<li><a href="EEFViewDescription.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</div>
<h2 title="Interface EEFViewDescription" class="title">Interface EEFViewDescription</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/eclipse/eef/impl/EEFViewDescriptionImpl.html" title="class in org.eclipse.eef.impl">EEFViewDescriptionImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EEFViewDescription</span>
extends org.eclipse.emf.ecore.EObject</pre>
<div class="block"><!-- begin-user-doc --> A representation of the model object '<em><b>EEF View Description</b></em>'. <!--
end-user-doc -->
<p>
The following features are supported:
<ul>
<li><a href="../../../org/eclipse/eef/EEFViewDescription.html#getIdentifier--"><code><em>Identifier</em></code></a></li>
<li><a href="../../../org/eclipse/eef/EEFViewDescription.html#getLabelExpression--"><code><em>Label Expression</em></code></a></li>
<li><a href="../../../org/eclipse/eef/EEFViewDescription.html#getImageExpression--"><code><em>Image Expression</em></code></a></li>
<li><a href="../../../org/eclipse/eef/EEFViewDescription.html#getGroups--"><code><em>Groups</em></code></a></li>
<li><a href="../../../org/eclipse/eef/EEFViewDescription.html#getPages--"><code><em>Pages</em></code></a></li>
<li><a href="../../../org/eclipse/eef/EEFViewDescription.html#getEPackages--"><code><em>EPackages</em></code></a></li>
</ul>
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription--"><code>EefPackage.getEEFViewDescription()</code></a></dd>
</dl>
</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>org.eclipse.emf.common.util.EList&lt;org.eclipse.emf.ecore.EPackage&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eclipse/eef/EEFViewDescription.html#getEPackages--">getEPackages</a></span>()</code>
<div class="block">Returns the value of the '<em><b>EPackages</b></em>' reference list.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.eclipse.emf.common.util.EList&lt;<a href="../../../org/eclipse/eef/EEFGroupDescription.html" title="interface in org.eclipse.eef">EEFGroupDescription</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eclipse/eef/EEFViewDescription.html#getGroups--">getGroups</a></span>()</code>
<div class="block">Returns the value of the '<em><b>Groups</b></em>' containment reference list.</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/EEFViewDescription.html#getIdentifier--">getIdentifier</a></span>()</code>
<div class="block">Returns the value of the '<em><b>Identifier</b></em>' attribute. <!</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/EEFViewDescription.html#getImageExpression--">getImageExpression</a></span>()</code>
<div class="block">Returns the value of the '<em><b>Image Expression</b></em>' attribute. <!</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eclipse/eef/EEFViewDescription.html#getLabelExpression--">getLabelExpression</a></span>()</code>
<div class="block">Returns the value of the '<em><b>Label Expression</b></em>' attribute. <!</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.eclipse.emf.common.util.EList&lt;<a href="../../../org/eclipse/eef/EEFPageDescription.html" title="interface in org.eclipse.eef">EEFPageDescription</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eclipse/eef/EEFViewDescription.html#getPages--">getPages</a></span>()</code>
<div class="block">Returns the value of the '<em><b>Pages</b></em>' containment reference list.</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/EEFViewDescription.html#setIdentifier-java.lang.String-">setIdentifier</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Sets the value of the '<a href="../../../org/eclipse/eef/EEFViewDescription.html#getIdentifier--"><code><em>Identifier</em></code></a>' attribute</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/eef/EEFViewDescription.html#setImageExpression-java.lang.String-">setImageExpression</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Sets the value of the '<a href="../../../org/eclipse/eef/EEFViewDescription.html#getImageExpression--"><code><em>Image Expression</em></code></a>'
attribute. <!</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/eef/EEFViewDescription.html#setLabelExpression-java.lang.String-">setLabelExpression</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Sets the value of the '<a href="../../../org/eclipse/eef/EEFViewDescription.html#getLabelExpression--"><code><em>Label Expression</em></code></a>'
attribute. <!</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.emf.ecore.EObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.ecore.EObject</h3>
<code>eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.emf.common.notify.Notifier">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.common.notify.Notifier</h3>
<code>eAdapters, eDeliver, eNotify, eSetDeliver</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="getIdentifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentifier</h4>
<pre>java.lang.String&nbsp;getIdentifier()</pre>
<div class="block">Returns the value of the '<em><b>Identifier</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
<!-- begin-model-doc --> Used to identify a specific View instance. <!-- end-model-doc --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the '<em>Identifier</em>' attribute.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EEFViewDescription.html#setIdentifier-java.lang.String-"><code>setIdentifier(String)</code></a>,
<a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription_Identifier--"><code>EefPackage.getEEFViewDescription_Identifier()</code></a></dd>
</dl>
</li>
</ul>
<a name="setIdentifier-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdentifier</h4>
<pre>void&nbsp;setIdentifier(java.lang.String&nbsp;value)</pre>
<div class="block">Sets the value of the '<a href="../../../org/eclipse/eef/EEFViewDescription.html#getIdentifier--"><code><em>Identifier</em></code></a>' attribute.
<!-- begin-user-doc --> <!-- end-user-doc --></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the new value of the '<em>Identifier</em>' attribute.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EEFViewDescription.html#getIdentifier--"><code>getIdentifier()</code></a></dd>
</dl>
</li>
</ul>
<a name="getLabelExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelExpression</h4>
<pre>java.lang.String&nbsp;getLabelExpression()</pre>
<div class="block">Returns the value of the '<em><b>Label Expression</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc
--> <!-- begin-model-doc --> The label of the View visible by the end-users. <!-- end-model-doc --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the '<em>Label Expression</em>' attribute.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EEFViewDescription.html#setLabelExpression-java.lang.String-"><code>setLabelExpression(String)</code></a>,
<a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription_LabelExpression--"><code>EefPackage.getEEFViewDescription_LabelExpression()</code></a></dd>
</dl>
</li>
</ul>
<a name="setLabelExpression-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLabelExpression</h4>
<pre>void&nbsp;setLabelExpression(java.lang.String&nbsp;value)</pre>
<div class="block">Sets the value of the '<a href="../../../org/eclipse/eef/EEFViewDescription.html#getLabelExpression--"><code><em>Label Expression</em></code></a>'
attribute. <!-- begin-user-doc --> <!-- end-user-doc --></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the new value of the '<em>Label Expression</em>' attribute.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EEFViewDescription.html#getLabelExpression--"><code>getLabelExpression()</code></a></dd>
</dl>
</li>
</ul>
<a name="getImageExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImageExpression</h4>
<pre>java.lang.String&nbsp;getImageExpression()</pre>
<div class="block">Returns the value of the '<em><b>Image Expression</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc
--> <!-- begin-model-doc --> The expression used to compute the image of the View visible by the end-users. <!--
end-model-doc --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the '<em>Image Expression</em>' attribute.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EEFViewDescription.html#setImageExpression-java.lang.String-"><code>setImageExpression(String)</code></a>,
<a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription_ImageExpression--"><code>EefPackage.getEEFViewDescription_ImageExpression()</code></a></dd>
</dl>
</li>
</ul>
<a name="setImageExpression-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImageExpression</h4>
<pre>void&nbsp;setImageExpression(java.lang.String&nbsp;value)</pre>
<div class="block">Sets the value of the '<a href="../../../org/eclipse/eef/EEFViewDescription.html#getImageExpression--"><code><em>Image Expression</em></code></a>'
attribute. <!-- begin-user-doc --> <!-- end-user-doc --></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the new value of the '<em>Image Expression</em>' attribute.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EEFViewDescription.html#getImageExpression--"><code>getImageExpression()</code></a></dd>
</dl>
</li>
</ul>
<a name="getGroups--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</h4>
<pre>org.eclipse.emf.common.util.EList&lt;<a href="../../../org/eclipse/eef/EEFGroupDescription.html" title="interface in org.eclipse.eef">EEFGroupDescription</a>&gt;&nbsp;getGroups()</pre>
<div class="block">Returns the value of the '<em><b>Groups</b></em>' containment reference list. The list contents are of type
<a href="../../../org/eclipse/eef/EEFGroupDescription.html" title="interface in org.eclipse.eef"><code>EEFGroupDescription</code></a>. <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc
--> Contains all the defined Groups. It is defined under the View for reuasability reason and to be referenced
easily from any Page. <!-- end-model-doc --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the '<em>Groups</em>' containment reference list.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription_Groups--"><code>EefPackage.getEEFViewDescription_Groups()</code></a></dd>
</dl>
</li>
</ul>
<a name="getPages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPages</h4>
<pre>org.eclipse.emf.common.util.EList&lt;<a href="../../../org/eclipse/eef/EEFPageDescription.html" title="interface in org.eclipse.eef">EEFPageDescription</a>&gt;&nbsp;getPages()</pre>
<div class="block">Returns the value of the '<em><b>Pages</b></em>' containment reference list. The list contents are of type
<a href="../../../org/eclipse/eef/EEFPageDescription.html" title="interface in org.eclipse.eef"><code>EEFPageDescription</code></a>. <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc
--> Defines the tabs that are represented in the View. <!-- end-model-doc --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the '<em>Pages</em>' containment reference list.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription_Pages--"><code>EefPackage.getEEFViewDescription_Pages()</code></a></dd>
</dl>
</li>
</ul>
<a name="getEPackages--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEPackages</h4>
<pre>org.eclipse.emf.common.util.EList&lt;org.eclipse.emf.ecore.EPackage&gt;&nbsp;getEPackages()</pre>
<div class="block">Returns the value of the '<em><b>EPackages</b></em>' reference list. The list contents are of type
<code>EPackage</code>. <!-- begin-user-doc -->
<p>
If the meaning of the '<em>EPackages</em>' reference list isn't clear, there really should be more of a
description here...
</p>
<!-- end-user-doc --></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the '<em>EPackages</em>' reference list.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/eclipse/eef/EefPackage.html#getEEFViewDescription_EPackages--"><code>EefPackage.getEEFViewDescription_EPackages()</code></a></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/EEFValidationRuleDescription.html" title="interface in org.eclipse.eef"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/eclipse/eef/EEFWidgetAction.html" title="interface in org.eclipse.eef"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eclipse/eef/EEFViewDescription.html" target="_top">Frames</a></li>
<li><a href="EEFViewDescription.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>