blob: 62f827ce36f75d4efc6b505c383aeac4c64769f8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Jul 23 15:58:31 CEST 2020 -->
<title>ISemanticTreeMapperSupport</title>
<meta name="date" content="2020-07-23">
<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="ISemanticTreeMapperSupport";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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="class-use/ISemanticTreeMapperSupport.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.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/nebula/widgets/treemapper/INewMappingListener.html" title="interface in org.eclipse.nebula.widgets.treemapper"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/treemapper/TreeMapper.html" title="class in org.eclipse.nebula.widgets.treemapper"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" target="_top">Frames</a></li>
<li><a href="ISemanticTreeMapperSupport.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.nebula.widgets.treemapper</div>
<h2 title="Interface ISemanticTreeMapperSupport" class="title">Interface ISemanticTreeMapperSupport&lt;M,L,R&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>M</code> - The type of the mapping object</dd>
<dd><code>L</code> - The type of the left bound of the mapping, as available in the left <code>TreeViewer</code>'s <code>ITreeContentProvider</code></dd>
<dd><code>R</code> - The type of the right bound of the mapping, as available in the right <code>TreeViewer</code>'s <code>ITreeContentProvider</code></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ISemanticTreeMapperSupport&lt;M,L,R&gt;</span></pre>
<div class="block">This interface is the binding between the business object that holds the mapping,
and the targeted bounds of the mapping.
It is used to resolve bounds of the mapping as they can be found in the trees, and also
to generate the business object that represents the mapping when user creates a new
one in the <a href="../../../../../org/eclipse/nebula/widgets/treemapper/TreeMapper.html" title="class in org.eclipse.nebula.widgets.treemapper"><code>TreeMapper</code></a> widget</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</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><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">M</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html#createSemanticMappingObject-L-R-">createSemanticMappingObject</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">L</a>&nbsp;leftItem,
<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">R</a>&nbsp;rightItem)</code>
<div class="block">Creates the business object that represents the newly created mapping.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">L</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html#resolveLeftItem-M-">resolveLeftItem</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">M</a>&nbsp;semanticMappingObject)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html#resolveRightItem-M-">resolveRightItem</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">M</a>&nbsp;semanticMappingObject)</code>&nbsp;</td>
</tr>
</table>
</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="createSemanticMappingObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="createSemanticMappingObject-L-R-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSemanticMappingObject</h4>
<pre><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">M</a>&nbsp;createSemanticMappingObject(<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">L</a>&nbsp;leftItem,
<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">R</a>&nbsp;rightItem)</pre>
<div class="block">Creates the business object that represents the newly created mapping.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>leftItem</code> - the left bound of the mapping, as available in the left <code>TreeViewer</code> and provided by the <code>ITreeContentProvider</code></dd>
<dd><code>rightItem</code> - the right bound of the mapping, as available in the left <code>TreeViewer</code> and provided by the <code>ITreeContentProvider</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new object that represents your mapping, or null if this mapping is illegal (nothing happens then)</dd>
</dl>
</li>
</ul>
<a name="resolveLeftItem-java.lang.Object-">
<!-- -->
</a><a name="resolveLeftItem-M-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveLeftItem</h4>
<pre><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">L</a>&nbsp;resolveLeftItem(<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">M</a>&nbsp;semanticMappingObject)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>semanticMappingObject</code> - The mapping item</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>its left bound</dd>
</dl>
</li>
</ul>
<a name="resolveRightItem-java.lang.Object-">
<!-- -->
</a><a name="resolveRightItem-M-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resolveRightItem</h4>
<pre><a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">R</a>&nbsp;resolveRightItem(<a href="../../../../../org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" title="type parameter in ISemanticTreeMapperSupport">M</a>&nbsp;semanticMappingObject)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>semanticMappingObject</code> - The maping item</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>its left bound</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="class-use/ISemanticTreeMapperSupport.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.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/nebula/widgets/treemapper/INewMappingListener.html" title="interface in org.eclipse.nebula.widgets.treemapper"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/treemapper/TreeMapper.html" title="class in org.eclipse.nebula.widgets.treemapper"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/treemapper/ISemanticTreeMapperSupport.html" target="_top">Frames</a></li>
<li><a href="ISemanticTreeMapperSupport.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>