| <!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>IDifferenceFilter (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="IDifferenceFilter (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/IDifferenceFilter.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><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/AbstractDifferenceFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.Registry.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html" target="_top">Frames</a></li> |
| <li><a href="IDifferenceFilter.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: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.structuremergeviewer.filters</div> |
| <h2 title="Interface IDifferenceFilter" class="title">Interface IDifferenceFilter</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/structuremergeviewer/filters/AbstractDifferenceFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters">AbstractDifferenceFilter</a>, <a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/filters/impl/CascadingDifferencesFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.filters.impl">CascadingDifferencesFilter</a>, <a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/filters/impl/EmptyMatchedResourcesFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.filters.impl">EmptyMatchedResourcesFilter</a>, <a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/filters/impl/FeatureMapDifferencesFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.filters.impl">FeatureMapDifferencesFilter</a>, <a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/filters/impl/IdenticalElementsFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.filters.impl">IdenticalElementsFilter</a>, <a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/filters/impl/PseudoConflictsFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.filters.impl">PseudoConflictsFilter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">IDifferenceFilter</span></pre> |
| <div class="block">Instances of this class will be used by EMF Compare in order to provide difference filter facilities to the |
| structural differences view.</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"> </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 </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.Registry.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters">IDifferenceFilter.Registry</a></strong></code> |
| <div class="block">A registry of <a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters"><code>IDifferenceFilter</code></a>.</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"> </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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#defaultSelected()">defaultSelected</a></strong>()</code> |
| <div class="block">Returns the initial activation state that the filter should have.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#getDescription()">getDescription</a></strong>()</code> |
| <div class="block">A human-readable description for this filter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#getLabel()">getLabel</a></strong>()</code> |
| <div class="block">A human-readable label for this filter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>com.google.common.base.Predicate<? super <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#getPredicateWhenSelected()">getPredicateWhenSelected</a></strong>()</code> |
| <div class="block">Returns the predicate that will filter out objects in the structural differences view when this filter |
| will be selected.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>com.google.common.base.Predicate<? super <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#getPredicateWhenUnselected()">getPredicateWhenUnselected</a></strong>()</code> |
| <div class="block">Returns the predicate that will filter out objects in the structural differences view when this filter |
| will be unselected.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#isEnabled(org.eclipse.emf.compare.scope.IComparisonScope,%20org.eclipse.emf.compare.Comparison)">isEnabled</a></strong>(<a href="../../../../../../../../org/eclipse/emf/compare/scope/IComparisonScope.html" title="interface in org.eclipse.emf.compare.scope">IComparisonScope</a> scope, |
| <a href="../../../../../../../../org/eclipse/emf/compare/Comparison.html" title="interface in org.eclipse.emf.compare">Comparison</a> comparison)</code> |
| <div class="block">Returns the activation condition based on the scope and comparison objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#setDefaultSelected(boolean)">setDefaultSelected</a></strong>(boolean defaultSelected)</code> |
| <div class="block">Set the initial activation state that the filter should have.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#setDescription(java.lang.String)">setDescription</a></strong>(<a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> |
| <div class="block">Set the description for this filter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html#setLabel(java.lang.String)">setLabel</a></strong>(<a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> label)</code> |
| <div class="block">Set the label for this filter.</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="getPredicateWhenSelected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPredicateWhenSelected</h4> |
| <pre>com.google.common.base.Predicate<? super <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>> getPredicateWhenSelected()</pre> |
| <div class="block">Returns the predicate that will filter out objects in the structural differences view when this filter |
| will be selected.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the predicate that will filter out objects in the structural differences view when this filter |
| will be selected.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPredicateWhenUnselected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPredicateWhenUnselected</h4> |
| <pre>com.google.common.base.Predicate<? super <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>> getPredicateWhenUnselected()</pre> |
| <div class="block">Returns the predicate that will filter out objects in the structural differences view when this filter |
| will be unselected.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the predicate that will filter out objects in the structural differences view when this filter |
| will be unselected.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLabel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLabel</h4> |
| <pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLabel()</pre> |
| <div class="block">A human-readable label for this filter. This will be displayed in the EMF Compare UI.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The label for this filter.</dd></dl> |
| </li> |
| </ul> |
| <a name="setLabel(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLabel</h4> |
| <pre>void setLabel(<a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> label)</pre> |
| <div class="block">Set the label for this filter. This will be displayed in the EMF Compare UI.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - A human-readable label for this filter.</dd></dl> |
| </li> |
| </ul> |
| <a name="getDescription()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDescription()</pre> |
| <div class="block">A human-readable description for this filter. This will be displayed in the EMF Compare UI.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Description or <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="setDescription(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescription</h4> |
| <pre>void setDescription(<a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre> |
| <div class="block">Set the description for this filter. This will be displayed in the EMF Compare UI.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>description</code> - A human-readable description for this filter.</dd></dl> |
| </li> |
| </ul> |
| <a name="defaultSelected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultSelected</h4> |
| <pre>boolean defaultSelected()</pre> |
| <div class="block">Returns the initial activation state that the filter should have.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The initial activation state that the filter should have.</dd></dl> |
| </li> |
| </ul> |
| <a name="setDefaultSelected(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultSelected</h4> |
| <pre>void setDefaultSelected(boolean defaultSelected)</pre> |
| <div class="block">Set the initial activation state that the filter should have.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultSelected</code> - The initial activation state that the filter should have (true if the filter should be |
| active by default).</dd></dl> |
| </li> |
| </ul> |
| <a name="isEnabled(org.eclipse.emf.compare.scope.IComparisonScope, org.eclipse.emf.compare.Comparison)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isEnabled</h4> |
| <pre>boolean isEnabled(<a href="../../../../../../../../org/eclipse/emf/compare/scope/IComparisonScope.html" title="interface in org.eclipse.emf.compare.scope">IComparisonScope</a> scope, |
| <a href="../../../../../../../../org/eclipse/emf/compare/Comparison.html" title="interface in org.eclipse.emf.compare">Comparison</a> comparison)</pre> |
| <div class="block">Returns the activation condition based on the scope and comparison objects.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - The scope on which the filter will be applied.</dd><dd><code>comparison</code> - The comparison which is to be displayed in the structural view.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The activation condition based on the scope and comparison objects.</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><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/IDifferenceFilter.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><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/AbstractDifferenceFilter.html" title="class in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.Registry.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/structuremergeviewer/filters/IDifferenceFilter.html" target="_top">Frames</a></li> |
| <li><a href="IDifferenceFilter.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: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
