blob: ae61e75009fc10785655627bc093ea5e01c7fb0a [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:13 CEST 2018 -->
<title>IEEFSectionDescriptor</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="IEEFSectionDescriptor";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/properties/ui/api/IEEFSection.html" title="interface 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/IEEFTabbedPropertySheetPageContributor.html" title="interface 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/IEEFSectionDescriptor.html" target="_top">Frames</a></li>
<li><a href="IEEFSectionDescriptor.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>Constr&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>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.properties.ui.api</div>
<h2 title="Interface IEEFSectionDescriptor" class="title">Interface IEEFSectionDescriptor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFSectionDescriptor.html" title="class in org.eclipse.eef.properties.ui.api">AbstractEEFSectionDescriptor</a>, <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 interface <span class="typeNameLabel">IEEFSectionDescriptor</span></pre>
<div class="block">Represents a section descriptor on the tabbed property sections extensions.
<p>
This interface should not be extended or implemented. New instances should be created using
<code>AbstractEEFSectionDescriptor</code>.
</p></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>
<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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#ENABLES_FOR_ANY">ENABLES_FOR_ANY</a></span></code>
<div class="block">If enabledFor is not specified in the descriptor, enable for any selection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#TOP">TOP</a></span></code>
<div class="block">If afterSection is not specified in the descriptor, we default to be the top section.</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></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/IEEFSectionDescriptor.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/IEEFSectionDescriptor.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/IEEFSectionDescriptor.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/IEEFSectionDescriptor.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.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getId--">getId</a></span>()</code>
<div class="block">Get the unique identifier for the section.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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/IEEFSectionDescriptor.html#getInputTypes--">getInputTypes</a></span>()</code>
<div class="block">Get the valid input types for this section.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSection.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html#getSectionClass--">getSectionClass</a></span>()</code>
<div class="block">Get the class that implements this section.</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/properties/ui/api/IEEFSectionDescriptor.html#getTargetTab--">getTargetTab</a></span>()</code>
<div class="block">Get the target tab where this section will appear.</div>
</td>
</tr>
</table>
</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="ENABLES_FOR_ANY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENABLES_FOR_ANY</h4>
<pre>static final&nbsp;int ENABLES_FOR_ANY</pre>
<div class="block">If enabledFor is not specified in the descriptor, enable for any selection.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.eef.properties.ui.api.IEEFSectionDescriptor.ENABLES_FOR_ANY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TOP">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TOP</h4>
<pre>static final&nbsp;java.lang.String TOP</pre>
<div class="block">If afterSection is not specified in the descriptor, we default to be the top section.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.eef.properties.ui.api.IEEFSectionDescriptor.TOP">Constant Field Values</a></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="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>java.lang.String&nbsp;getId()</pre>
<div class="block">Get the unique identifier for the section.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique identifier for the section.</dd>
</dl>
</li>
</ul>
<a name="getFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre>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="returnLabel">Returns:</span></dt>
<dd>the section filter instance.</dd>
</dl>
</li>
</ul>
<a name="getInputTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTypes</h4>
<pre>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="returnLabel">Returns:</span></dt>
<dd>the valid input types for this section.</dd>
</dl>
</li>
</ul>
<a name="getSectionClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSectionClass</h4>
<pre><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSection.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSection</a>&nbsp;getSectionClass()</pre>
<div class="block">Get the class that implements this section.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the class that implements this section.</dd>
</dl>
</li>
</ul>
<a name="getTargetTab--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetTab</h4>
<pre>java.lang.String&nbsp;getTargetTab()</pre>
<div class="block">Get the target tab where this section will appear.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the target tab where this section will appear.</dd>
</dl>
</li>
</ul>
<a name="getEnablesFor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnablesFor</h4>
<pre>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="returnLabel">Returns:</span></dt>
<dd>the value for section enablement.</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>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="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>
</dl>
</li>
</ul>
<a name="getAfterSection--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAfterSection</h4>
<pre>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="returnLabel">Returns:</span></dt>
<dd>the section identifier.</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/IEEFSection.html" title="interface 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/IEEFTabbedPropertySheetPageContributor.html" title="interface 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/IEEFSectionDescriptor.html" target="_top">Frames</a></li>
<li><a href="IEEFSectionDescriptor.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>Constr&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>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>