| <!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 May 18 03:56:43 EDT 2015 --> |
| <title>InteractiveUIContent (EMF Compare API Specification)</title> |
| <meta name="date" content="2015-05-18"> |
| <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="InteractiveUIContent (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/InteractiveUIContent.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.201505180755</span></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/GroupsInteractiveContent.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.preferences.impl"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.InteractiveUIBuilder.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.preferences.impl"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.html" target="_top">Frames</a></li> |
| <li><a href="InteractiveUIContent.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.internal.preferences.impl</div> |
| <h2 title="Class InteractiveUIContent" class="title">Class InteractiveUIContent</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.emf.compare.rcp.ui.internal.preferences.impl.InteractiveUIContent</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="strong">InteractiveUIContent</span> |
| extends <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">A User interface that holds a viewer and satellites elements. |
| <p> |
| This viewer can have a satellite configuration composite reacting on selection. It displays a configuration |
| UI for the current selection. It's requires a configuration UI registry. |
| </p> |
| <p> |
| This viewer can have a satellite text field holding the description of the current selection. This field |
| display the description for the current element. |
| </p> |
| <p> |
| This class allows a user to select and check elements. |
| </p> |
| <p> |
| It can also synchronize the state of checked element into a <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/DataHolder.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.preferences"><code>DataHolder</code></a> |
| </p></div> |
| </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">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.InteractiveUIBuilder.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.preferences.impl">InteractiveUIContent.InteractiveUIBuilder</a><<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.InteractiveUIBuilder.html" title="type parameter in InteractiveUIContent.InteractiveUIBuilder">T</a>></strong></code> |
| <div class="block">Builder for an Interactive UI.</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.html#addConfigurator(java.lang.String,%20org.eclipse.emf.compare.rcp.ui.internal.configuration.ui.IConfigurationUIFactory,%20org.osgi.service.prefs.Preferences)">addConfigurator</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> id, |
| <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/configuration/ui/IConfigurationUIFactory.html" title="interface in org.eclipse.emf.compare.rcp.ui.internal.configuration.ui">IConfigurationUIFactory</a> configuratorfactory, |
| org.osgi.service.prefs.Preferences pref)</code> |
| <div class="block">Adds a configuration to this Interactive content.</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/internal/preferences/impl/InteractiveUIContent.html#checkElement(org.eclipse.emf.compare.rcp.internal.extension.IItemDescriptor)">checkElement</a></strong>(<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a><?> descriptor)</code> |
| <div class="block">Checks one element in the viewer.</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/internal/preferences/impl/InteractiveUIContent.html#checkElements(org.eclipse.emf.compare.rcp.internal.extension.IItemDescriptor[])">checkElements</a></strong>(<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a><?>[] descriptors)</code> |
| <div class="block">Checks multiple element in the viewer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/configuration/ui/AbstractConfigurationUI.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.configuration.ui">AbstractConfigurationUI</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.html#getConfigurators()">getConfigurators</a></strong>()</code> </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/internal/preferences/impl/InteractiveUIContent.html#select(org.eclipse.emf.compare.rcp.internal.extension.IItemDescriptor)">select</a></strong>(<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a><?> descriptor)</code> |
| <div class="block">Handles a selection in the viewer.</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/internal/preferences/impl/InteractiveUIContent.html#setViewer(org.eclipse.jface.viewers.CheckboxTableViewer)">setViewer</a></strong>(<a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/CheckboxTableViewer.html?is-external=true" title="class or interface in org.eclipse.jface.viewers">CheckboxTableViewer</a> inputViewer)</code> |
| <div class="block">Sets the viewer in the interactive content.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </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="addConfigurator(java.lang.String, org.eclipse.emf.compare.rcp.ui.internal.configuration.ui.IConfigurationUIFactory, org.osgi.service.prefs.Preferences)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addConfigurator</h4> |
| <pre>public void addConfigurator(<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> id, |
| <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/configuration/ui/IConfigurationUIFactory.html" title="interface in org.eclipse.emf.compare.rcp.ui.internal.configuration.ui">IConfigurationUIFactory</a> configuratorfactory, |
| org.osgi.service.prefs.Preferences pref)</pre> |
| <div class="block">Adds a configuration to this Interactive content.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - Id of the item to configure</dd><dd><code>configuratorfactory</code> - Factory for the configuration</dd><dd><code>pref</code> - Preference store that will hold this <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/configuration/ui/IConfigurationUIFactory.html" title="interface in org.eclipse.emf.compare.rcp.ui.internal.configuration.ui"><code>IConfigurationUIFactory</code></a> value.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkElement(org.eclipse.emf.compare.rcp.internal.extension.IItemDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkElement</h4> |
| <pre>public void checkElement(<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a><?> descriptor)</pre> |
| <div class="block">Checks one element in the viewer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>descriptor</code> - element to check.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkElements(org.eclipse.emf.compare.rcp.internal.extension.IItemDescriptor[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkElements</h4> |
| <pre>public void checkElements(<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a><?>[] descriptors)</pre> |
| <div class="block">Checks multiple element in the viewer. (Only use if multiple selection is allowed)</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>descriptors</code> - elements to check.</dd></dl> |
| </li> |
| </ul> |
| <a name="getConfigurators()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigurators</h4> |
| <pre>public <a href="http://download.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/configuration/ui/AbstractConfigurationUI.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.configuration.ui">AbstractConfigurationUI</a>> getConfigurators()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>A map of all configuration.</dd></dl> |
| </li> |
| </ul> |
| <a name="select(org.eclipse.emf.compare.rcp.internal.extension.IItemDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>public void select(<a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a><?> descriptor)</pre> |
| <div class="block">Handles a selection in the viewer. Update related components.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>descriptor</code> - Item to select.</dd></dl> |
| </li> |
| </ul> |
| <a name="setViewer(org.eclipse.jface.viewers.CheckboxTableViewer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setViewer</h4> |
| <pre>public void setViewer(<a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/CheckboxTableViewer.html?is-external=true" title="class or interface in org.eclipse.jface.viewers">CheckboxTableViewer</a> inputViewer)</pre> |
| <div class="block">Sets the viewer in the interactive content.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputViewer</code> - A <a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/StructuredViewer.html?is-external=true" title="class or interface in org.eclipse.jface.viewers"><code>StructuredViewer</code></a> of <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension"><code>IItemDescriptor</code></a></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/InteractiveUIContent.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.201505180755</span></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/GroupsInteractiveContent.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.preferences.impl"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.InteractiveUIBuilder.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.preferences.impl"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/internal/preferences/impl/InteractiveUIContent.html" target="_top">Frames</a></li> |
| <li><a href="InteractiveUIContent.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> |
