blob: dc4c70fbb6dc8ecc1dd789854e53a8122bcd75a7 [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 Aug 03 10:33:49 CEST 2016 -->
<title>AbstractEEFSectionDescriptor</title>
<meta name="date" content="2016-08-03">
<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="AbstractEEFSectionDescriptor";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="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/properties/ui/api/AbstractEEFSection.html" title="class in org.eclipse.eef.properties.ui.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFTabDescriptor.html" title="class in org.eclipse.eef.properties.ui.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/eef/properties/ui/api/AbstractEEFSectionDescriptor.html" target="_top">Frames</a></li>
<li><a href="AbstractEEFSectionDescriptor.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><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>Field&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.properties.ui.api</div>
<h2 title="Class AbstractEEFSectionDescriptor" class="title">Class AbstractEEFSectionDescriptor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.eef.properties.ui.api.AbstractEEFSectionDescriptor</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/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/eclipse/eef/ide/ui/properties/api/EEFSectionDescriptor.html" title="class in org.eclipse.eef.ide.ui.properties.api">EEFSectionDescriptor</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/legacy/internal/extension/impl/LegacyPropertySectionItemDescriptor.html" title="class in org.eclipse.eef.properties.ui.legacy.internal.extension.impl">LegacyPropertySectionItemDescriptor</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractEEFSectionDescriptor</span>
extends java.lang.Object
implements <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></pre>
<div class="block">An abstract implementation of a section descriptor for the tabbed property view.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.eef.properties.ui.api.IEEFSectionDescriptor">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.eef.properties.ui.api.<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></h3>
<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#ENABLES_FOR_ANY">ENABLES_FOR_ANY</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#TOP">TOP</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/eef/properties/ui/api/AbstractEEFSectionDescriptor.html#AbstractEEFSectionDescriptor-org.eclipse.eef.properties.ui.api.IEEFTypeMapper-">AbstractEEFSectionDescriptor</a></span>(<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTypeMapper.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFTypeMapper</a>&nbsp;typeMapper)</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="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/properties/ui/api/AbstractEEFSectionDescriptor.html#appliesTo-org.eclipse.ui.IWorkbenchPart-org.eclipse.jface.viewers.ISelection-">appliesTo</a></span>(org.eclipse.ui.IWorkbenchPart&nbsp;part,
org.eclipse.jface.viewers.ISelection&nbsp;selection)</code>
<div class="block">Determines if this section applies to the selection.</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/eef/properties/ui/api/AbstractEEFSectionDescriptor.html#getAfterSection--">getAfterSection</a></span>()</code>
<div class="block">Get the section identifier below which this section is displayed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFSectionDescriptor.html#getEnablesFor--">getEnablesFor</a></span>()</code>
<div class="block">Get the value for section enablement which is a precise number of items selected.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.eclipse.jface.viewers.IFilter</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFSectionDescriptor.html#getFilter--">getFilter</a></span>()</code>
<div class="block">Get the section filter instance for this section.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFSectionDescriptor.html#getInputTypes--">getInputTypes</a></span>()</code>
<div class="block">Get the valid input types for this section.</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.eef.properties.ui.api.IEEFSectionDescriptor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.eef.properties.ui.api.<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></h3>
<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getId--">getId</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getSectionClass--">getSectionClass</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getTargetTab--">getTargetTab</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractEEFSectionDescriptor-org.eclipse.eef.properties.ui.api.IEEFTypeMapper-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractEEFSectionDescriptor</h4>
<pre>public&nbsp;AbstractEEFSectionDescriptor(<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTypeMapper.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFTypeMapper</a>&nbsp;typeMapper)</pre>
<div class="block">The constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeMapper</code> - The type mapper for the section</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="getFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre>public&nbsp;org.eclipse.jface.viewers.IFilter&nbsp;getFilter()</pre>
<div class="block">Get the section filter instance for this section. Return null if no filter for this section.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getFilter--">getFilter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the section filter instance.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getFilter--"><code>IEEFSectionDescriptor.getFilter()</code></a></dd>
</dl>
</li>
</ul>
<a name="getInputTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTypes</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getInputTypes()</pre>
<div class="block">Get the valid input types for this section.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getInputTypes--">getInputTypes</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the valid input types for this section.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getInputTypes--"><code>IEEFSectionDescriptor.getInputTypes()</code></a></dd>
</dl>
</li>
</ul>
<a name="getEnablesFor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnablesFor</h4>
<pre>public&nbsp;int&nbsp;getEnablesFor()</pre>
<div class="block">Get the value for section enablement which is a precise number of items selected. For example: enablesFor="1"
enables the section only when one item is selected. If not specified, enable for any selection and return
ENABLES_FOR_ANY.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getEnablesFor--">getEnablesFor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value for section enablement.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getEnablesFor--"><code>IEEFSectionDescriptor.getEnablesFor()</code></a></dd>
</dl>
</li>
</ul>
<a name="appliesTo-org.eclipse.ui.IWorkbenchPart-org.eclipse.jface.viewers.ISelection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appliesTo</h4>
<pre>public&nbsp;boolean&nbsp;appliesTo(org.eclipse.ui.IWorkbenchPart&nbsp;part,
org.eclipse.jface.viewers.ISelection&nbsp;selection)</pre>
<div class="block">Determines if this section applies to the selection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#appliesTo-org.eclipse.ui.IWorkbenchPart-org.eclipse.jface.viewers.ISelection-">appliesTo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>part</code> - the current workbench part.</dd>
<dd><code>selection</code> - the selection.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this section applies to the current selection.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#appliesTo-org.eclipse.ui.IWorkbenchPart-org.eclipse.jface.viewers.ISelection-"><code>IEEFSectionDescriptor.appliesTo(org.eclipse.ui.IWorkbenchPart,
org.eclipse.jface.viewers.ISelection)</code></a></dd>
</dl>
</li>
</ul>
<a name="getAfterSection--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAfterSection</h4>
<pre>public&nbsp;java.lang.String&nbsp;getAfterSection()</pre>
<div class="block">Get the section identifier below which this section is displayed. <code>"top"</code> is returned if this section
is the top most section or if there is one section in the tab.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getAfterSection--">getAfterSection</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the section identifier.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getAfterSection--"><code>IEEFSectionDescriptor.getAfterSection()</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/properties/ui/api/AbstractEEFSection.html" title="class in org.eclipse.eef.properties.ui.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFTabDescriptor.html" title="class in org.eclipse.eef.properties.ui.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/eef/properties/ui/api/AbstractEEFSectionDescriptor.html" target="_top">Frames</a></li>
<li><a href="AbstractEEFSectionDescriptor.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><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>Field&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>