blob: c0a13aee844f6e311d2141c9c0f4cf689b606082 [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 (version 1.7.0_75) on Mon Jun 08 05:48:10 EDT 2015 -->
<title>ICompareColor (EMF Compare API Specification)</title>
<meta name="date" content="2015-06-08">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ICompareColor (EMF Compare API Specification)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ICompareColor.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 class="aboutLanguage"><em><span style='font-size:small'><b>EMF Compare</b><br>3.2.0.201506080946</span></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.Provider.html" title="interface in org.eclipse.emf.compare.rcp.ui.mergeviewer"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html" target="_top">Frames</a></li>
<li><a href="ICompareColor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All 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><a href="#nested_class_summary">Nested</a>&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.emf.compare.rcp.ui.mergeviewer</div>
<h2 title="Interface ICompareColor" class="title">Interface ICompareColor</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/emf/compare/rcp/ui/internal/mergeviewer/CompareColorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.mergeviewer">CompareColorImpl</a>, <a href="../../../../../../../org/eclipse/emf/compare/ide/ui/internal/contentmergeviewer/util/EMFCompareColor.html" title="class in org.eclipse.emf.compare.ide.ui.internal.contentmergeviewer.util">EMFCompareColor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ICompareColor</span></pre>
<div class="block">Implementation of this interface will return color of decorator of <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>difference</code></a>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>4.0</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.Provider.html" title="interface in org.eclipse.emf.compare.rcp.ui.mergeviewer">ICompareColor.Provider</a></strong></code>
<div class="block">A provider of ICompareColor.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#dispose()">dispose</a></strong>()</code>
<div class="block">Dispose all <a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics"><code>Color</code></a> resources.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getFillColor(org.eclipse.emf.compare.Diff,%20boolean,%20boolean,%20boolean)">getFillColor</a></strong>(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;diff,
boolean&nbsp;isThreeWay,
boolean&nbsp;isIgnoreAncestor,
boolean&nbsp;selected)</code>
<div class="block">Return the color of the background of the decorator of the given <code>diff</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getRequiredFillColor()">getRequiredFillColor</a></strong>()</code>
<div class="block">Get the color for Required change.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getRequiredStrokeColor()">getRequiredStrokeColor</a></strong>()</code>
<div class="block">Get the color for Required change border items.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getStrokeColor(org.eclipse.emf.compare.Diff,%20boolean,%20boolean,%20boolean)">getStrokeColor</a></strong>(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;diff,
boolean&nbsp;isThreeWay,
boolean&nbsp;isIgnoreAncestor,
boolean&nbsp;selected)</code>
<div class="block">Return the color of the stroke of the decorator of the given <code>diff</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getUnmergeableFillColor()">getUnmergeableFillColor</a></strong>()</code>
<div class="block">Get the color for Unmergeable difference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getUnmergeableStrokeColor()">getUnmergeableStrokeColor</a></strong>()</code>
<div class="block">Get the color for Unmergeable difference border items.</div>
</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="getFillColor(org.eclipse.emf.compare.Diff, boolean, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFillColor</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a>&nbsp;getFillColor(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;diff,
boolean&nbsp;isThreeWay,
boolean&nbsp;isIgnoreAncestor,
boolean&nbsp;selected)</pre>
<div class="block">Return the color of the background of the decorator of the given <code>diff</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>diff</code> - the diff to be decorated.</dd><dd><code>isThreeWay</code> - are we comparing three models.</dd><dd><code>isIgnoreAncestor</code> - if the ancestor has to be ignored (i.e. ignore the isThreeWay parameter).</dd><dd><code>selected</code> - if the given <code>diff</code> is selected in the viewer.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the background color.</dd></dl>
</li>
</ul>
<a name="getStrokeColor(org.eclipse.emf.compare.Diff, boolean, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStrokeColor</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a>&nbsp;getStrokeColor(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;diff,
boolean&nbsp;isThreeWay,
boolean&nbsp;isIgnoreAncestor,
boolean&nbsp;selected)</pre>
<div class="block">Return the color of the stroke of the decorator of the given <code>diff</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>diff</code> - the diff to be decorated.</dd><dd><code>isThreeWay</code> - are we comparing three models.</dd><dd><code>isIgnoreAncestor</code> - if the ancestor has to be ignored (i.e. ignore the isThreeWay parameter).</dd><dd><code>selected</code> - if the given <code>diff</code> is selected in the viewer.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the background color.</dd></dl>
</li>
</ul>
<a name="getRequiredFillColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequiredFillColor</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a>&nbsp;getRequiredFillColor()</pre>
<div class="block">Get the color for Required change.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getRequiredStrokeColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequiredStrokeColor</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a>&nbsp;getRequiredStrokeColor()</pre>
<div class="block">Get the color for Required change border items. This color is computed from
<a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getRequiredFillColor()"><code>getRequiredFillColor()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getUnmergeableFillColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnmergeableFillColor</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a>&nbsp;getUnmergeableFillColor()</pre>
<div class="block">Get the color for Unmergeable difference.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getUnmergeableStrokeColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnmergeableStrokeColor</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Color</a>&nbsp;getUnmergeableStrokeColor()</pre>
<div class="block">Get the color for Unmergeable difference border items. This color is computed from
<a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html#getUnmergeableFillColor()"><code>getUnmergeableFillColor()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="dispose()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dispose</h4>
<pre>void&nbsp;dispose()</pre>
<div class="block">Dispose all <a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Color.html?is-external=true" title="class or interface in org.eclipse.swt.graphics"><code>Color</code></a> resources.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ICompareColor.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 class="aboutLanguage"><em><span style='font-size:small'><b>EMF Compare</b><br>3.2.0.201506080946</span></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.Provider.html" title="interface in org.eclipse.emf.compare.rcp.ui.mergeviewer"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/mergeviewer/ICompareColor.html" target="_top">Frames</a></li>
<li><a href="ICompareColor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All 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><a href="#nested_class_summary">Nested</a>&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 ======= -->
<p class="legalCopy"><small><br><span style='font-size:small;float:right'>Copyright (c) 2006, 2014 Obeo and others. All rights reserved.</span></small></p>
</body>
</html>