| <!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>PShelfItem</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="PShelfItem"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/PShelfItem.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/PShelf.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/nebula/widgets/pshelf/RedmondShelfRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/pshelf/PShelfItem.html" target="_top">Frames</a></li> |
| <li><a href="PShelfItem.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 PShelfItem" class="title">Class PShelfItem</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.Item</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.nebula.widgets.pshelf.PShelfItem</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PShelfItem</span> |
| extends org.eclipse.swt.widgets.Item</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 represent an individual shelf. A shelf is a container widget similar |
| to a tab folder but with a list-like visualization. |
| <p> |
| Add controls to a shelf item by constructing them on the body (<code>getBody</code>) of the item. |
| <dl> |
| <dt><b>Styles:</b></dt> |
| <dd>(none)</dd> |
| <dt><b>Events:</b></dt> |
| <dd>(none)</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"> |
| <!-- ======== 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"> </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/PShelfItem.html#PShelfItem-org.eclipse.nebula.widgets.pshelf.PShelf-int-">PShelfItem</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelf</a> parent, |
| int style)</code> |
| <div class="block">Constructs a new instance of this class given its parent |
| (which must be a <code>PShelf</code>) and a style value |
| describing its behavior and appearance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html#PShelfItem-org.eclipse.nebula.widgets.pshelf.PShelf-int-int-">PShelfItem</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelf</a> parent, |
| int style, |
| int index)</code> |
| <div class="block">Constructs a new instance of this class given its parent |
| (which must be a <code>PShelf</code>), a style value |
| describing its behavior and appearance, and the index |
| at which to place it in the items maintained by its parent.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/PShelfItem.html#dispose--">dispose</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.swt.widgets.Composite</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html#getBody--">getBody</a></span>()</code> |
| <div class="block">Returns the client area of the shelf.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>(package private) org.eclipse.swt.widgets.Composite</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html#getBodyParent--">getBodyParent</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html#setImage-org.eclipse.swt.graphics.Image-">setImage</a></span>(org.eclipse.swt.graphics.Image image)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelfItem.html#setText-java.lang.String-">setText</a></span>(java.lang.String string)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.swt.widgets.Item"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.swt.widgets.Item</h3> |
| <code>checkSubclass, getImage, getText</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 org.eclipse.swt.widgets.Widget</h3> |
| <code>addDisposeListener, addListener, checkWidget, 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 java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="PShelfItem-org.eclipse.nebula.widgets.pshelf.PShelf-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PShelfItem</h4> |
| <pre>public PShelfItem(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelf</a> parent, |
| int style, |
| int index)</pre> |
| <div class="block">Constructs a new instance of this class given its parent |
| (which must be a <code>PShelf</code>), a style value |
| describing its behavior and appearance, and the index |
| at which to place it in the items maintained by its parent. |
| <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> |
| <dd><code>index</code> - the zero-relative index to store the receiver in its parent</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> |
| <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</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> |
| <a name="PShelfItem-org.eclipse.nebula.widgets.pshelf.PShelf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PShelfItem</h4> |
| <pre>public PShelfItem(<a href="../../../../../org/eclipse/nebula/widgets/pshelf/PShelf.html" title="class in org.eclipse.nebula.widgets.pshelf">PShelf</a> parent, |
| int style)</pre> |
| <div class="block">Constructs a new instance of this class given its parent |
| (which must be a <code>PShelf</code>) and a style value |
| describing its behavior and appearance. The item is added |
| to the end of the items maintained by its parent. |
| <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="getBody--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBody</h4> |
| <pre>public org.eclipse.swt.widgets.Composite getBody()</pre> |
| <div class="block">Returns the client area of the shelf. Users should add controls and a layout to the body. |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the body composite</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="getBodyParent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyParent</h4> |
| <pre>org.eclipse.swt.widgets.Composite getBodyParent()</pre> |
| </li> |
| </ul> |
| <a name="dispose--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>public void dispose()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>dispose</code> in class <code>org.eclipse.swt.widgets.Widget</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Widget.dispose()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setImage-org.eclipse.swt.graphics.Image-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setImage</h4> |
| <pre>public void setImage(org.eclipse.swt.graphics.Image image)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setImage</code> in class <code>org.eclipse.swt.widgets.Item</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Item.setImage(org.eclipse.swt.graphics.Image)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setText-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setText</h4> |
| <pre>public void setText(java.lang.String string)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setText</code> in class <code>org.eclipse.swt.widgets.Item</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Item.setText(java.lang.String)</code></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/PShelfItem.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/PShelf.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/nebula/widgets/pshelf/RedmondShelfRenderer.html" title="class in org.eclipse.nebula.widgets.pshelf"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/pshelf/PShelfItem.html" target="_top">Frames</a></li> |
| <li><a href="PShelfItem.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
