blob: 69e6df44aea95ab4083f1dd82b471b8f6553d847 [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>IEEFTabDescriptor</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="IEEFTabDescriptor";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/IEEFTabbedPropertySheetPageContributor.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/IEEFTabDescriptorFilter.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/IEEFTabDescriptor.html" target="_top">Frames</a></li>
<li><a href="IEEFTabDescriptor.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 IEEFTabDescriptor" class="title">Interface IEEFTabDescriptor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFTabItem</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/eclipse/eef/properties/ui/api/AbstractEEFTabDescriptor.html" title="class in org.eclipse.eef.properties.ui.api">AbstractEEFTabDescriptor</a>, <a href="../../../../../../org/eclipse/eef/ide/ui/properties/api/EEFTabDescriptor.html" title="class in org.eclipse.eef.ide.ui.properties.api">EEFTabDescriptor</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/legacy/internal/extension/impl/LegacyPropertyTabItemDescriptor.html" title="class in org.eclipse.eef.properties.ui.legacy.internal.extension.impl">LegacyPropertyTabItemDescriptor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IEEFTabDescriptor</span>
extends <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFTabItem</a></pre>
<div class="block">Represents a tab descriptor for the tabbed property view.
<p>
This interface should not be extended or implemented. New instances should be created using
<code>AbstractEEFTabDescriptor</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 java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabDescriptor.html#TOP">TOP</a></span></code>
<div class="block">If afterTab is not specified in the descriptor, we default to be the top tab.</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><a href="../../../../../../org/eclipse/eef/properties/ui/api/EEFTabContents.html" title="class in org.eclipse.eef.properties.ui.api">EEFTabContents</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabDescriptor.html#createTab--">createTab</a></span>()</code>
<div class="block">Instantiate this tab's sections.</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/IEEFTabDescriptor.html#getAfterTab--">getAfterTab</a></span>()</code>
<div class="block">Get the identifier of the tab after which this tab should be displayed.</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/properties/ui/api/IEEFTabDescriptor.html#getCategory--">getCategory</a></span>()</code>
<div class="block">Get the category this tab belongs to.</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/properties/ui/api/IEEFTabDescriptor.html#getId--">getId</a></span>()</code>
<div class="block">Get the unique identifier for the tab.</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/IEEFTabDescriptor.html#getLabel--">getLabel</a></span>()</code>
<div class="block">Get the text label for the tab.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabDescriptor.html#getSectionDescriptors--">getSectionDescriptors</a></span>()</code>
<div class="block">Get the list of section descriptors for the tab.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.eef.properties.ui.api.IEEFTabItem">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.eef.properties.ui.api.<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFTabItem</a></h3>
<code><a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html#getImage--">getImage</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html#getText--">getText</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html#isIndented--">isIndented</a>, <a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFTabItem.html#isSelected--">isSelected</a></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="TOP">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TOP</h4>
<pre>static final&nbsp;java.lang.String TOP</pre>
<div class="block">If afterTab is not specified in the descriptor, we default to be the top tab.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.eclipse.eef.properties.ui.api.IEEFTabDescriptor.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="createTab--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTab</h4>
<pre><a href="../../../../../../org/eclipse/eef/properties/ui/api/EEFTabContents.html" title="class in org.eclipse.eef.properties.ui.api">EEFTabContents</a>&nbsp;createTab()</pre>
<div class="block">Instantiate this tab's sections.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The tab contents for this section.</dd>
</dl>
</li>
</ul>
<a name="getAfterTab--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAfterTab</h4>
<pre>java.lang.String&nbsp;getAfterTab()</pre>
<div class="block">Get the identifier of the tab after which this tab should be displayed. When two or more tabs belong to the same
category, they are sorted by the after tab values.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the identifier of the tab.</dd>
</dl>
</li>
</ul>
<a name="getCategory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCategory</h4>
<pre>java.lang.String&nbsp;getCategory()</pre>
<div class="block">Get the category this tab belongs to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Get the category this tab belongs to.</dd>
</dl>
</li>
</ul>
<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 tab.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique identifier for the tab.</dd>
</dl>
</li>
</ul>
<a name="getLabel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabel</h4>
<pre>java.lang.String&nbsp;getLabel()</pre>
<div class="block">Get the text label for the tab.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the text label for the tab.</dd>
</dl>
</li>
</ul>
<a name="getSectionDescriptors--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSectionDescriptors</h4>
<pre>java.util.List&lt;<a href="../../../../../../org/eclipse/eef/properties/ui/api/IEEFSectionDescriptor.html" title="interface in org.eclipse.eef.properties.ui.api">IEEFSectionDescriptor</a>&gt;&nbsp;getSectionDescriptors()</pre>
<div class="block">Get the list of section descriptors for the tab.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of section descriptors for the tab.</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/IEEFTabbedPropertySheetPageContributor.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/IEEFTabDescriptorFilter.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/IEEFTabDescriptor.html" target="_top">Frames</a></li>
<li><a href="IEEFTabDescriptor.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>