blob: 22ee4ad879b716a86f211afe68031b5035c7631e [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 May 18 03:56:42 EDT 2015 -->
<title>ITypedElement (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="ITypedElement (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/ITypedElement.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/contentmergeviewer/accessor/legacy/IStreamContentAccessor.html" title="interface in org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/legacy/ITypedElement.html" target="_top">Frames</a></li>
<li><a href="ITypedElement.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>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.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy</div>
<h2 title="Interface ITypedElement" class="title">Interface ITypedElement</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/ICompareAccessor.html" title="interface in org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor">ICompareAccessor</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/IResourceContentsAccessor.html" title="interface in org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor">IResourceContentsAccessor</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/IStructuralFeatureAccessor.html" title="interface in org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor">IStructuralFeatureAccessor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/AbstractStructuralFeatureAccessor.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">AbstractStructuralFeatureAccessor</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/legacy/impl/AbstractTypedElementAdapter.html" title="class in org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy.impl">AbstractTypedElementAdapter</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/ContainmentReferenceChangeAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">ContainmentReferenceChangeAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/FeatureMapKeyChangeAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">FeatureMapKeyChangeAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/ManyStructuralFeatureAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">ManyStructuralFeatureAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/MatchAccessor.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">MatchAccessor</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/ResourceContentsAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">ResourceContentsAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/ResourceLocationChangeAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">ResourceLocationChangeAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/ResourceStreamAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">ResourceStreamAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/SingleStructuralFeatureAccessorImpl.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">SingleStructuralFeatureAccessorImpl</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/impl/StringAttributeChangeAccessor.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.impl">StringAttributeChangeAccessor</a>, <a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/contentmergeviewer/accessor/legacy/impl/TypedNotifier.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.contentmergeviewer.accessor.legacy.impl">TypedNotifier</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ITypedElement</span></pre>
<div class="block">Interface for getting the name, image, and type for an object.
<p>
These methods are typically used to present an input object in the compare UI (<code>getName</code> and
<code>getImage</code>) and for finding a viewer for a given input type (<code>getType</code>).
<p>
Clients may implement this interface.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" 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 <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/contentmergeviewer/accessor/legacy/ITypedElement.html#FOLDER_TYPE">FOLDER_TYPE</a></strong></code>
<div class="block">Type for a folder input (value <code>"FOLDER"</code>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/contentmergeviewer/accessor/legacy/ITypedElement.html#TEXT_TYPE">TEXT_TYPE</a></strong></code>
<div class="block">Type for an element whose actual type is text (value <code>"txt"</code>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/contentmergeviewer/accessor/legacy/ITypedElement.html#UNKNOWN_TYPE">UNKNOWN_TYPE</a></strong></code>
<div class="block">Type for an element whose actual type could not be determined.</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><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Image.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Image</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/legacy/ITypedElement.html#getImage()">getImage</a></strong>()</code>
<div class="block">Returns an image for this object.</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/contentmergeviewer/accessor/legacy/ITypedElement.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the name of this object.</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/contentmergeviewer/accessor/legacy/ITypedElement.html#getType()">getType</a></strong>()</code>
<div class="block">Returns the type of this object.</div>
</td>
</tr>
</table>
</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="FOLDER_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FOLDER_TYPE</h4>
<pre>static final&nbsp;<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> FOLDER_TYPE</pre>
<div class="block">Type for a folder input (value <code>"FOLDER"</code>). Folders are comparison elements that have no
contents, only a name and children.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../../../constant-values.html#org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy.ITypedElement.FOLDER_TYPE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TEXT_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_TYPE</h4>
<pre>static final&nbsp;<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> TEXT_TYPE</pre>
<div class="block">Type for an element whose actual type is text (value <code>"txt"</code>).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../../../constant-values.html#org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy.ITypedElement.TEXT_TYPE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNKNOWN_TYPE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UNKNOWN_TYPE</h4>
<pre>static final&nbsp;<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> UNKNOWN_TYPE</pre>
<div class="block">Type for an element whose actual type could not be determined. (value <code>"???"</code>).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../../../constant-values.html#org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy.ITypedElement.UNKNOWN_TYPE">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="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</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>&nbsp;getName()</pre>
<div class="block">Returns the name of this object. The name is used when displaying this object in the UI.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of this object</dd></dl>
</li>
</ul>
<a name="getImage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImage</h4>
<pre><a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Image.html?is-external=true" title="class or interface in org.eclipse.swt.graphics">Image</a>&nbsp;getImage()</pre>
<div class="block">Returns an image for this object. This image is used when displaying this object in the UI.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the image of this object or <code>null</code> if this type of input has no image</dd></dl>
</li>
</ul>
<a name="getType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getType</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>&nbsp;getType()</pre>
<div class="block">Returns the type of this object. For objects with a file name this is typically the file extension. For
folders its the constant <code>FOLDER_TYPE</code>. The type is used for determining a suitable viewer
for this object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the type of this object</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/ITypedElement.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/contentmergeviewer/accessor/legacy/IStreamContentAccessor.html" title="interface in org.eclipse.emf.compare.rcp.ui.contentmergeviewer.accessor.legacy"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/contentmergeviewer/accessor/legacy/ITypedElement.html" target="_top">Frames</a></li>
<li><a href="ITypedElement.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>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 ======= -->
<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>