Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / f998bb2b16354fd59b8a5b5c8f47d9f4a3020c64 / . / releases / latest / javadoc / org / eclipse / nebula / widgets / pshelf / PShelf.html
blob: 6f536c744ec0c39729372f3f777c1e29b7141ad4 [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:59 CEST 2020 -->
<title>PShelf</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="PShelf";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/PShelf.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/pshelf/PaletteShelfRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/pshelf/PShelf.html" target="_top">Frames</a></li>
<li><a href="PShelf.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="#fields.inherited.from.class.org.eclipse.swt.widgets.Control">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.pshelf</div>
<h2 title="Class PShelf" class="title">Class PShelf</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Widget</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Control</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Scrollable</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Composite</li>
<li>
<ul class="inheritance">
<li>org.eclipse.swt.widgets.Canvas</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.pshelf.PShelf</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.eclipse.swt.graphics.Drawable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PShelf</span>
extends org.eclipse.swt.widgets.Canvas</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>
Instances of this class implement a selectable accordion metaphor, where each shelf contains
a client area.
<p>
The item children that may be added to instances of this class
must be of type <code>PShelfItem</code>.
<code>Control</code> children are created on the body composite of each items accessed via
<code>PShelfItem#getBody</code>.
</p><p>
<dl>
<dt><b>Styles:</b></dt>
<dd>BORDER, SIMPLE</dd>
<dt><b>Events:</b></dt>
<dd>Selection</dd>
</dl>
<p>
IMPORTANT: This class is <em>not</em> intended to be subclassed.
</p></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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.swt.widgets.Control">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.swt.widgets.Control</h3>
<code>handle</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#PShelf-org.eclipse.swt.widgets.Composite-int-">PShelf</a></span>(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</code>
<div class="block">Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#addSelectionListener-org.eclipse.swt.events.SelectionListener-">addSelectionListener</a></span>(org.eclipse.swt.events.SelectionListener&nbsp;listener)</code>
<div class="block">Adds the listener to the collection of listeners who will
be notified when the receiver's selection changes, by sending
it one of the messages defined in the <code>SelectionListener</code>
interface.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#computeItemHeight--">computeItemHeight</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.eclipse.swt.graphics.Point</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#computeSize-int-int-boolean-">computeSize</a></span>(int&nbsp;wHint,
int&nbsp;hHint,
boolean&nbsp;changed)</code></td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#createItem-org.eclipse.nebula.widgets.pshelf.PShelfItem-int-">createItem</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;item,
int&nbsp;index)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#getItem-org.eclipse.swt.graphics.Point-">getItem</a></span>(org.eclipse.swt.graphics.Point&nbsp;point)</code>
<div class="block">Returns the item at the given location.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#getItems--">getItems</a></span>()</code>
<div class="block">Returns an array of <code>PShelfItem</code>s which are the items
in the receiver.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/pshelf/AbstractRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf">AbstractRenderer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#getRenderer--">getRenderer</a></span>()</code>
<div class="block">Returns the renderer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#getSelection--">getSelection</a></span>()</code>
<div class="block">Returns the <code>PShelfItem</code> that is currently
selected in the receiver.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#onResize--">onResize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#removeAll--">removeAll</a></span>()</code>
<div class="block">Removes all PShelfItems.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#removeItem-org.eclipse.nebula.widgets.pshelf.PShelfItem-">removeItem</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;item)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#removeSelectionListener-org.eclipse.swt.events.SelectionListener-">removeSelectionListener</a></span>(org.eclipse.swt.events.SelectionListener&nbsp;listener)</code>
<div class="block">Removes the listener from the collection of listeners who will
be notified when the receiver's selection changes.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#setAnimationSpeed-double-">setAnimationSpeed</a></span>(double&nbsp;animationSpeed)</code>
<div class="block">Sets the speed of animation.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#setRedrawOnAmination-boolean-">setRedrawOnAmination</a></span>(boolean&nbsp;redrawOnAnimation)</code>
<div class="block">Sets whether to redraw the items (previous and next item) when the open animation occours.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#setRenderer-org.eclipse.nebula.widgets.pshelf.AbstractRenderer-">setRenderer</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/AbstractRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf">AbstractRenderer</a>&nbsp;renderer)</code>
<div class="block">Sets the renderer.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#setSelection-org.eclipse.nebula.widgets.pshelf.PShelfItem-">setSelection</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;item)</code>
<div class="block">Sets the receiver's selection to the given item.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Canvas">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Canvas</h3>
<code>drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Composite">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Composite</h3>
<code>changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Scrollable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Scrollable</h3>
<code>computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Control">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Control</h3>
<code>addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Widget">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.swt.widgets.Widget</h3>
<code>addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.graphics.Drawable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.swt.graphics.Drawable</h3>
<code>isAutoScalable</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PShelf-org.eclipse.swt.widgets.Composite-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PShelf</h4>
<pre>public&nbsp;PShelf(org.eclipse.swt.widgets.Composite&nbsp;parent,
int&nbsp;style)</pre>
<div class="block">Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
<p>
The style value is either one of the style constants defined in
class <code>SWT</code> which is applicable to instances of this
class, or must be built by <em>bitwise OR</em>'ing together
(that is, using the <code>int</code> "|" operator) two or more
of those <code>SWT</code> style constants. The class description
lists the style constants that are applicable to the class.
Style bits are also inherited from superclasses.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - a composite control which will be the parent of the new instance (cannot be null)</dd>
<dd><code>style</code> - the style of control to construct</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the parent is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
<li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
</ul></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="setRenderer-org.eclipse.nebula.widgets.pshelf.AbstractRenderer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRenderer</h4>
<pre>public&nbsp;void&nbsp;setRenderer(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/AbstractRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf">AbstractRenderer</a>&nbsp;renderer)</pre>
<div class="block">Sets the renderer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>renderer</code> - the new renderer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the renderer is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver or the renderer has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="getRenderer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenderer</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/nebula/widgets/pshelf/AbstractRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf">AbstractRenderer</a>&nbsp;getRenderer()</pre>
<div class="block">Returns the renderer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the renderer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="computeSize-int-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeSize</h4>
<pre>public&nbsp;org.eclipse.swt.graphics.Point&nbsp;computeSize(int&nbsp;wHint,
int&nbsp;hHint,
boolean&nbsp;changed)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>computeSize</code>&nbsp;in class&nbsp;<code>org.eclipse.swt.widgets.Control</code></dd>
</dl>
</li>
</ul>
<a name="createItem-org.eclipse.nebula.widgets.pshelf.PShelfItem-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createItem</h4>
<pre>void&nbsp;createItem(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;item,
int&nbsp;index)</pre>
</li>
</ul>
<a name="removeItem-org.eclipse.nebula.widgets.pshelf.PShelfItem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItem</h4>
<pre>void&nbsp;removeItem(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;item)</pre>
</li>
</ul>
<a name="onResize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onResize</h4>
<pre>void&nbsp;onResize()</pre>
</li>
</ul>
<a name="computeItemHeight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeItemHeight</h4>
<pre>void&nbsp;computeItemHeight()</pre>
</li>
</ul>
<a name="getItem-org.eclipse.swt.graphics.Point-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItem</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;getItem(org.eclipse.swt.graphics.Point&nbsp;point)</pre>
<div class="block">Returns the item at the given location.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>point</code> - location</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the point is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver or the renderer has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="setSelection-org.eclipse.nebula.widgets.pshelf.PShelfItem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelection</h4>
<pre>public&nbsp;void&nbsp;setSelection(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;item)</pre>
<div class="block">Sets the receiver's selection to the given item.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - the item to select</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the item is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="getSelection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelection</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>&nbsp;getSelection()</pre>
<div class="block">Returns the <code>PShelfItem</code> that is currently
selected in the receiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the currently selected item</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="getItems--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItems</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelfItem</a>[]&nbsp;getItems()</pre>
<div class="block">Returns an array of <code>PShelfItem</code>s which are the items
in the receiver.
<p>
Note: This is not the actual structure used by the receiver
to maintain its list of items, so modifying the array will
not affect the receiver.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the items in the receiver</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="addSelectionListener-org.eclipse.swt.events.SelectionListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSelectionListener</h4>
<pre>public&nbsp;void&nbsp;addSelectionListener(org.eclipse.swt.events.SelectionListener&nbsp;listener)</pre>
<div class="block">Adds the listener to the collection of listeners who will
be notified when the receiver's selection changes, by sending
it one of the messages defined in the <code>SelectionListener</code>
interface.
<p>
When <code>widgetSelected</code> is called, the item field of the event object is valid.
<code>widgetDefaultSelected</code> is not called.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener which should be notified</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the listener is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SelectionListener</code>,
<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#removeSelectionListener-org.eclipse.swt.events.SelectionListener-"><code>removeSelectionListener(org.eclipse.swt.events.SelectionListener)</code></a>,
<code>SelectionEvent</code></dd>
</dl>
</li>
</ul>
<a name="removeSelectionListener-org.eclipse.swt.events.SelectionListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSelectionListener</h4>
<pre>public&nbsp;void&nbsp;removeSelectionListener(org.eclipse.swt.events.SelectionListener&nbsp;listener)</pre>
<div class="block">Removes the listener from the collection of listeners who will
be notified when the receiver's selection changes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener which should no longer be notified</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - <ul>
<li>ERROR_NULL_ARGUMENT - if the listener is null</li>
</ul></dd>
<dd><code>org.eclipse.swt.SWTException</code> - <ul>
<li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
<li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
</ul></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>SelectionListener</code>,
<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html#addSelectionListener-org.eclipse.swt.events.SelectionListener-"><code>addSelectionListener(org.eclipse.swt.events.SelectionListener)</code></a></dd>
</dl>
</li>
</ul>
<a name="removeAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>public&nbsp;void&nbsp;removeAll()</pre>
<div class="block">Removes all PShelfItems.</div>
</li>
</ul>
<a name="setAnimationSpeed-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAnimationSpeed</h4>
<pre>public&nbsp;void&nbsp;setAnimationSpeed(double&nbsp;animationSpeed)</pre>
<div class="block">Sets the speed of animation.
This value indicates the relative growing/shrinking value for one step.
Values between 0.0 and 1.0 are allowed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>animationSpeed</code> - </dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>05.02.2016</dd>
</dl>
</li>
</ul>
<a name="setRedrawOnAmination-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setRedrawOnAmination</h4>
<pre>public&nbsp;void&nbsp;setRedrawOnAmination(boolean&nbsp;redrawOnAnimation)</pre>
<div class="block">Sets whether to redraw the items (previous and next item) when the open animation occours.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>redrawOnAnimation</code> - </dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>05.02.2016</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/PShelf.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/pshelf/PaletteShelfRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/pshelf/PShelf.html" target="_top">Frames</a></li>
<li><a href="PShelf.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="#fields.inherited.from.class.org.eclipse.swt.widgets.Control">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>