Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / f998bb2b16354fd59b8a5b5c8f47d9f4a3020c64 / . / releases / latest / javadoc / org / eclipse / nebula / widgets / grid / IInternalWidget.html
blob: b8f5dc3829eb56279d8b8b7bc061d4d814d15ac2 [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:56 CEST 2020 -->
<title>IInternalWidget</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="IInternalWidget";
}
}
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/IInternalWidget.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/grid/GridVisibleRangeSupport.VisibleRangeChangedListener.html" title="interface in org.eclipse.nebula.widgets.grid"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html" title="interface in org.eclipse.nebula.widgets.grid"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/grid/IInternalWidget.html" target="_top">Frames</a></li>
<li><a href="IInternalWidget.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><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.nebula.widgets.grid</div>
<h2 title="Interface IInternalWidget" class="title">Interface IInternalWidget</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html" title="interface in org.eclipse.nebula.widgets.grid">IRenderer</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/grid/AbstractInternalWidget.html" title="class in org.eclipse.nebula.widgets.grid">AbstractInternalWidget</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/DefaultCellRenderer.html" title="class in org.eclipse.nebula.widgets.grid">DefaultCellRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/internal/DefaultColumnFooterRenderer.html" title="class in org.eclipse.nebula.widgets.grid.internal">DefaultColumnFooterRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/internal/DefaultColumnGroupHeaderRenderer.html" title="class in org.eclipse.nebula.widgets.grid.internal">DefaultColumnGroupHeaderRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/internal/DefaultColumnHeaderRenderer.html" title="class in org.eclipse.nebula.widgets.grid.internal">DefaultColumnHeaderRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/DefaultEmptyCellRenderer.html" title="class in org.eclipse.nebula.widgets.grid">DefaultEmptyCellRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/GridCellRenderer.html" title="class in org.eclipse.nebula.widgets.grid">GridCellRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/GridFooterRenderer.html" title="class in org.eclipse.nebula.widgets.grid">GridFooterRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/GridHeaderRenderer.html" title="class in org.eclipse.nebula.widgets.grid">GridHeaderRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/internal/win7/Win7ColumnGroupHeaderRenderer.html" title="class in org.eclipse.nebula.widgets.grid.internal.win7">Win7ColumnGroupHeaderRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/internal/win7/Win7GridColumnHeaderRenderer.html" title="class in org.eclipse.nebula.widgets.grid.internal.win7">Win7GridColumnHeaderRenderer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IInternalWidget</span>
extends <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html" title="interface in org.eclipse.nebula.widgets.grid">IRenderer</a></pre>
<div class="block"><p>
NOTE: THIS WIDGET AND ITS API ARE STILL UNDER DEVELOPMENT. THIS IS A PRE-RELEASE ALPHA
VERSION. USERS SHOULD EXPECT API CHANGES IN FUTURE VERSIONS.
</p>
TODO fill in.</div>
</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="memberSummary" 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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/grid/IInternalWidget.html#LeftMouseButtonDown">LeftMouseButtonDown</a></span></code>
<div class="block">Mouse down state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/grid/IInternalWidget.html#MouseMove">MouseMove</a></span></code>
<div class="block">Hover State.</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="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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/grid/IInternalWidget.html#getHoverDetail--">getHoverDetail</a></span>()</code>
<div class="block">Returns the hover detail object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/grid/IInternalWidget.html#notify-int-org.eclipse.swt.graphics.Point-java.lang.Object-">notify</a></span>(int&nbsp;event,
org.eclipse.swt.graphics.Point&nbsp;point,
java.lang.Object&nbsp;value)</code>
<div class="block">Mechanism used to notify the light weight widgets that an event occurred
that it might be interested in.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/grid/IInternalWidget.html#setHoverDetail-java.lang.String-">setHoverDetail</a></span>(java.lang.String&nbsp;detail)</code>
<div class="block">Sets a string object that represents which part of the rendered image is currently under the
mouse pointer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.nebula.widgets.grid.IRenderer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.nebula.widgets.grid.<a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html" title="interface in org.eclipse.nebula.widgets.grid">IRenderer</a></h3>
<code><a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#computeSize-org.eclipse.swt.graphics.GC-int-int-java.lang.Object-">computeSize</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#paint-org.eclipse.swt.graphics.GC-java.lang.Object-">paint</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setBounds-int-int-int-int-">setBounds</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setBounds-org.eclipse.swt.graphics.Rectangle-">setBounds</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setDisplay-org.eclipse.swt.widgets.Display-">setDisplay</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setExpanded-boolean-">setExpanded</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setFocus-boolean-">setFocus</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setHover-boolean-">setHover</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setLocation-int-int-">setLocation</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setLocation-org.eclipse.swt.graphics.Point-">setLocation</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setMouseDown-boolean-">setMouseDown</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setSelected-boolean-">setSelected</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setSize-int-int-">setSize</a>, <a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html#setSize-org.eclipse.swt.graphics.Point-">setSize</a></code></li>
</ul>
</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="MouseMove">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MouseMove</h4>
<pre>static final&nbsp;int MouseMove</pre>
<div class="block">Hover State.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.grid.IInternalWidget.MouseMove">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LeftMouseButtonDown">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LeftMouseButtonDown</h4>
<pre>static final&nbsp;int LeftMouseButtonDown</pre>
<div class="block">Mouse down state.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.grid.IInternalWidget.LeftMouseButtonDown">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="notify-int-org.eclipse.swt.graphics.Point-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notify</h4>
<pre>boolean&nbsp;notify(int&nbsp;event,
org.eclipse.swt.graphics.Point&nbsp;point,
java.lang.Object&nbsp;value)</pre>
<div class="block">Mechanism used to notify the light weight widgets that an event occurred
that it might be interested in.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - Event type.</dd>
<dd><code>point</code> - Location of event.</dd>
<dd><code>value</code> - New value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>widget handled the event.</dd>
</dl>
</li>
</ul>
<a name="getHoverDetail--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHoverDetail</h4>
<pre>java.lang.String&nbsp;getHoverDetail()</pre>
<div class="block">Returns the hover detail object. This detail is used by the renderer to
determine which part or piece of the rendered image is hovered over.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string identifying which part of the image is being hovered over.</dd>
</dl>
</li>
</ul>
<a name="setHoverDetail-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setHoverDetail</h4>
<pre>void&nbsp;setHoverDetail(java.lang.String&nbsp;detail)</pre>
<div class="block">Sets a string object that represents which part of the rendered image is currently under the
mouse pointer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>detail</code> - identifying string.</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/IInternalWidget.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/grid/GridVisibleRangeSupport.VisibleRangeChangedListener.html" title="interface in org.eclipse.nebula.widgets.grid"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/grid/IRenderer.html" title="interface in org.eclipse.nebula.widgets.grid"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/grid/IInternalWidget.html" target="_top">Frames</a></li>
<li><a href="IInternalWidget.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><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 ======= -->
</body>
</html>