| <!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:59:00 CEST 2020 --> |
| <title>AbstractGalleryItemRenderer</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="AbstractGalleryItemRenderer"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"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"],4:["t3","Abstract 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/AbstractGalleryItemRenderer.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/gallery/AbstractGalleryGroupRenderer.html" title="class in org.eclipse.nebula.widgets.gallery"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGridGroupRenderer.html" title="class in org.eclipse.nebula.widgets.gallery"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html" target="_top">Frames</a></li> |
| <li><a href="AbstractGalleryItemRenderer.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.gallery</div> |
| <h2 title="Class AbstractGalleryItemRenderer" class="title">Class AbstractGalleryItemRenderer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/eclipse/nebula/widgets/gallery/DefaultGalleryItemRenderer.html" title="class in org.eclipse.nebula.widgets.gallery">DefaultGalleryItemRenderer</a>, <a href="../../../../../org/eclipse/nebula/widgets/gallery/ListItemRenderer.html" title="class in org.eclipse.nebula.widgets.gallery">ListItemRenderer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractGalleryItemRenderer</span> |
| extends java.lang.Object</pre> |
| <div class="block"><p> |
| Base class used to implement a custom gallery item renderer. |
| </p> |
| <p> |
| NOTE: THIS WIDGET AND ITS API ARE STILL UNDER DEVELOPMENT. |
| </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> |
| <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"> </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>protected static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#EMPTY_STRING">EMPTY_STRING</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html" title="class in org.eclipse.nebula.widgets.gallery">Gallery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#gallery">gallery</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>(package private) org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#galleryBackgroundColor">galleryBackgroundColor</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>(package private) org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#galleryForegroundColor">galleryForegroundColor</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#OVERLAY_BOTTOM_LEFT">OVERLAY_BOTTOM_LEFT</a></span></code> |
| <div class="block">Id for decorators located at the bottom left of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#OVERLAY_BOTTOM_RIGHT">OVERLAY_BOTTOM_RIGHT</a></span></code> |
| <div class="block">Id for decorators located at the bottom right of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#OVERLAY_TOP_LEFT">OVERLAY_TOP_LEFT</a></span></code> |
| <div class="block">Id for decorators located at the top left of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#OVERLAY_TOP_RIGHT">OVERLAY_TOP_RIGHT</a></span></code> |
| <div class="block">Id for decorators located at the top right of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#selected">selected</a></span></code> </td> |
| </tr> |
| </table> |
| </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"> </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/gallery/AbstractGalleryItemRenderer.html#AbstractGalleryItemRenderer--">AbstractGalleryItemRenderer</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#dispose--">dispose</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#draw-org.eclipse.swt.graphics.GC-org.eclipse.nebula.widgets.gallery.GalleryItem-int-int-int-int-int-">draw</a></span>(org.eclipse.swt.graphics.GC gc, |
| <a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item, |
| int index, |
| int x, |
| int y, |
| int width, |
| int height)</code> |
| <div class="block">Draws an item.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#drawAllOverlays-org.eclipse.swt.graphics.GC-org.eclipse.nebula.widgets.gallery.GalleryItem-int-int-org.eclipse.swt.graphics.Point-int-int-">drawAllOverlays</a></span>(org.eclipse.swt.graphics.GC gc, |
| <a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item, |
| int x, |
| int y, |
| org.eclipse.swt.graphics.Point imageSize, |
| int xShift, |
| int yShift)</code> |
| <div class="block">Draw image overlays.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#drawOverlayImages-org.eclipse.swt.graphics.GC-int-int-double-org.eclipse.swt.graphics.Image:A-">drawOverlayImages</a></span>(org.eclipse.swt.graphics.GC gc, |
| int x, |
| int y, |
| double ratio, |
| org.eclipse.swt.graphics.Image[] images)</code> |
| <div class="block">Draw overlay images for one corner.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getBackground-org.eclipse.nebula.widgets.gallery.GalleryItem-">getBackground</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item)</code> |
| <div class="block">Check the GalleryItem, Gallery, and Display in order for the active |
| background color for the given GalleryItem.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected org.eclipse.swt.graphics.Font</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getFont-org.eclipse.nebula.widgets.gallery.GalleryItem-">getFont</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item)</code> |
| <div class="block">Check the GalleryItem, Gallery, and Display in order for the active font |
| for the given GalleryItem.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getForeground-org.eclipse.nebula.widgets.gallery.GalleryItem-">getForeground</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item)</code> |
| <div class="block">Check the GalleryItem, Gallery, and Display in order for the active |
| foreground color for the given GalleryItem.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html" title="class in org.eclipse.nebula.widgets.gallery">Gallery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getGallery--">getGallery</a></span>()</code> |
| <div class="block">Get current gallery.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.swt.graphics.Image[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getImageOverlay-org.eclipse.nebula.widgets.gallery.GalleryItem-java.lang.String-">getImageOverlay</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item, |
| java.lang.String id)</code> |
| <div class="block">Returns an array of images or null of no overlay was defined for this |
| image.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getOverlayRatio-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-">getOverlayRatio</a></span>(org.eclipse.swt.graphics.Point imageSize, |
| org.eclipse.swt.graphics.Point overlaySizeTopLeft, |
| org.eclipse.swt.graphics.Point overlaySizeTopRight, |
| org.eclipse.swt.graphics.Point overlaySizeBottomLeft, |
| org.eclipse.swt.graphics.Point overlaySizeBottomRight)</code> |
| <div class="block">Returns the best size ratio for overlay images.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.swt.graphics.Point</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#getOverlaySize-org.eclipse.swt.graphics.Image:A-">getOverlaySize</a></span>(org.eclipse.swt.graphics.Image[] images)</code> |
| <div class="block">Return overlay size, summing all images sizes</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html#isSelected--">isSelected</a></span>()</code> |
| <div class="block">true is the current item is selected</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/gallery/AbstractGalleryItemRenderer.html#postDraw-org.eclipse.swt.graphics.GC-">postDraw</a></span>(org.eclipse.swt.graphics.GC gc)</code> |
| <div class="block">This method is called after drawing the last item.</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/gallery/AbstractGalleryItemRenderer.html#preDraw-org.eclipse.swt.graphics.GC-">preDraw</a></span>(org.eclipse.swt.graphics.GC gc)</code> |
| <div class="block">This method is called before drawing the first item.</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/gallery/AbstractGalleryItemRenderer.html#setGallery-org.eclipse.nebula.widgets.gallery.Gallery-">setGallery</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html" title="class in org.eclipse.nebula.widgets.gallery">Gallery</a> gallery)</code> |
| <div class="block">Set the current gallery.</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/gallery/AbstractGalleryItemRenderer.html#setSelected-boolean-">setSelected</a></span>(boolean selected)</code> </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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="OVERLAY_BOTTOM_RIGHT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OVERLAY_BOTTOM_RIGHT</h4> |
| <pre>public static final java.lang.String OVERLAY_BOTTOM_RIGHT</pre> |
| <div class="block">Id for decorators located at the bottom right of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="OVERLAY_BOTTOM_LEFT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OVERLAY_BOTTOM_LEFT</h4> |
| <pre>public static final java.lang.String OVERLAY_BOTTOM_LEFT</pre> |
| <div class="block">Id for decorators located at the bottom left of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer.OVERLAY_BOTTOM_LEFT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="OVERLAY_TOP_RIGHT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OVERLAY_TOP_RIGHT</h4> |
| <pre>public static final java.lang.String OVERLAY_TOP_RIGHT</pre> |
| <div class="block">Id for decorators located at the top right of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer.OVERLAY_TOP_RIGHT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="OVERLAY_TOP_LEFT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OVERLAY_TOP_LEFT</h4> |
| <pre>public static final java.lang.String OVERLAY_TOP_LEFT</pre> |
| <div class="block">Id for decorators located at the top left of the item image |
| |
| Example : item.setData( AbstractGalleryItemRenderer.OVERLAY_BOTTOM_RIGHT |
| , <Image or Image[]> );</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer.OVERLAY_TOP_LEFT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="EMPTY_STRING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_STRING</h4> |
| <pre>protected static final java.lang.String EMPTY_STRING</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer.EMPTY_STRING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="gallery"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>gallery</h4> |
| <pre>protected <a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html" title="class in org.eclipse.nebula.widgets.gallery">Gallery</a> gallery</pre> |
| </li> |
| </ul> |
| <a name="galleryBackgroundColor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>galleryBackgroundColor</h4> |
| <pre>org.eclipse.swt.graphics.Color galleryBackgroundColor</pre> |
| </li> |
| </ul> |
| <a name="galleryForegroundColor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>galleryForegroundColor</h4> |
| <pre>org.eclipse.swt.graphics.Color galleryForegroundColor</pre> |
| </li> |
| </ul> |
| <a name="selected"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>selected</h4> |
| <pre>protected boolean selected</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractGalleryItemRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractGalleryItemRenderer</h4> |
| <pre>public AbstractGalleryItemRenderer()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isSelected--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSelected</h4> |
| <pre>public boolean isSelected()</pre> |
| <div class="block">true is the current item is selected</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSelected-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSelected</h4> |
| <pre>public void setSelected(boolean selected)</pre> |
| </li> |
| </ul> |
| <a name="draw-org.eclipse.swt.graphics.GC-org.eclipse.nebula.widgets.gallery.GalleryItem-int-int-int-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>draw</h4> |
| <pre>public abstract void draw(org.eclipse.swt.graphics.GC gc, |
| <a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item, |
| int index, |
| int x, |
| int y, |
| int width, |
| int height)</pre> |
| <div class="block">Draws an item.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>gc</code> - </dd> |
| <dd><code>item</code> - </dd> |
| <dd><code>index</code> - </dd> |
| <dd><code>x</code> - </dd> |
| <dd><code>y</code> - </dd> |
| <dd><code>width</code> - </dd> |
| <dd><code>height</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dispose--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>public abstract void dispose()</pre> |
| </li> |
| </ul> |
| <a name="preDraw-org.eclipse.swt.graphics.GC-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preDraw</h4> |
| <pre>public void preDraw(org.eclipse.swt.graphics.GC gc)</pre> |
| <div class="block">This method is called before drawing the first item. It may be used to |
| calculate some values (like font metrics) that will be used for each |
| item.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>gc</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postDraw-org.eclipse.swt.graphics.GC-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postDraw</h4> |
| <pre>public void postDraw(org.eclipse.swt.graphics.GC gc)</pre> |
| <div class="block">This method is called after drawing the last item. It may be used to |
| cleanup and release resources created in preDraw().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>gc</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGallery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGallery</h4> |
| <pre>public <a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html" title="class in org.eclipse.nebula.widgets.gallery">Gallery</a> getGallery()</pre> |
| <div class="block">Get current gallery.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGallery-org.eclipse.nebula.widgets.gallery.Gallery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGallery</h4> |
| <pre>public void setGallery(<a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html" title="class in org.eclipse.nebula.widgets.gallery">Gallery</a> gallery)</pre> |
| <div class="block">Set the current gallery. This method is automatically called by |
| <a href="../../../../../org/eclipse/nebula/widgets/gallery/Gallery.html#setItemRenderer-org.eclipse.nebula.widgets.gallery.AbstractGalleryItemRenderer-"><code>Gallery.setItemRenderer(AbstractGalleryItemRenderer)</code></a>. There is |
| not need to call it from user code.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>gallery</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOverlayRatio-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-org.eclipse.swt.graphics.Point-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOverlayRatio</h4> |
| <pre>protected double getOverlayRatio(org.eclipse.swt.graphics.Point imageSize, |
| org.eclipse.swt.graphics.Point overlaySizeTopLeft, |
| org.eclipse.swt.graphics.Point overlaySizeTopRight, |
| org.eclipse.swt.graphics.Point overlaySizeBottomLeft, |
| org.eclipse.swt.graphics.Point overlaySizeBottomRight)</pre> |
| <div class="block">Returns the best size ratio for overlay images. This ensure that all |
| images can fit without being drawn on top of others.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>imageSize</code> - </dd> |
| <dd><code>overlaySizeTopLeft</code> - </dd> |
| <dd><code>overlaySizeTopRight</code> - </dd> |
| <dd><code>overlaySizeBottomLeft</code> - </dd> |
| <dd><code>overlaySizeBottomRight</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="drawAllOverlays-org.eclipse.swt.graphics.GC-org.eclipse.nebula.widgets.gallery.GalleryItem-int-int-org.eclipse.swt.graphics.Point-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>drawAllOverlays</h4> |
| <pre>protected void drawAllOverlays(org.eclipse.swt.graphics.GC gc, |
| <a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item, |
| int x, |
| int y, |
| org.eclipse.swt.graphics.Point imageSize, |
| int xShift, |
| int yShift)</pre> |
| <div class="block">Draw image overlays. Overlays are defined with image.setData using the |
| following keys : |
| <ul> |
| <li>org.eclipse.nebula.widget.gallery.bottomLeftOverlay</li> |
| <li>org.eclipse.nebula.widget.gallery.bottomRightOverlay</li> |
| <li>org.eclipse.nebula.widget.gallery.topLeftOverlay</li> |
| <li>org.eclipse.nebula.widget.gallery.topRightOverlay</li> |
| </ul></div> |
| </li> |
| </ul> |
| <a name="drawOverlayImages-org.eclipse.swt.graphics.GC-int-int-double-org.eclipse.swt.graphics.Image:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>drawOverlayImages</h4> |
| <pre>protected void drawOverlayImages(org.eclipse.swt.graphics.GC gc, |
| int x, |
| int y, |
| double ratio, |
| org.eclipse.swt.graphics.Image[] images)</pre> |
| <div class="block">Draw overlay images for one corner.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>gc</code> - </dd> |
| <dd><code>x</code> - </dd> |
| <dd><code>y</code> - </dd> |
| <dd><code>ratio</code> - </dd> |
| <dd><code>images</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOverlaySize-org.eclipse.swt.graphics.Image:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOverlaySize</h4> |
| <pre>protected org.eclipse.swt.graphics.Point getOverlaySize(org.eclipse.swt.graphics.Image[] images)</pre> |
| <div class="block">Return overlay size, summing all images sizes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>images</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="getImageOverlay-org.eclipse.nebula.widgets.gallery.GalleryItem-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImageOverlay</h4> |
| <pre>protected org.eclipse.swt.graphics.Image[] getImageOverlay(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item, |
| java.lang.String id)</pre> |
| <div class="block">Returns an array of images or null of no overlay was defined for this |
| image.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>item</code> - </dd> |
| <dd><code>id</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Image[] or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBackground-org.eclipse.nebula.widgets.gallery.GalleryItem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBackground</h4> |
| <pre>protected org.eclipse.swt.graphics.Color getBackground(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item)</pre> |
| <div class="block">Check the GalleryItem, Gallery, and Display in order for the active |
| background color for the given GalleryItem.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>item</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the background Color to use for this item</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForeground-org.eclipse.nebula.widgets.gallery.GalleryItem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForeground</h4> |
| <pre>protected org.eclipse.swt.graphics.Color getForeground(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item)</pre> |
| <div class="block">Check the GalleryItem, Gallery, and Display in order for the active |
| foreground color for the given GalleryItem.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>item</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the foreground Color to use for this item</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFont-org.eclipse.nebula.widgets.gallery.GalleryItem-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFont</h4> |
| <pre>protected org.eclipse.swt.graphics.Font getFont(<a href="../../../../../org/eclipse/nebula/widgets/gallery/GalleryItem.html" title="class in org.eclipse.nebula.widgets.gallery">GalleryItem</a> item)</pre> |
| <div class="block">Check the GalleryItem, Gallery, and Display in order for the active font |
| for the given GalleryItem.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>item</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Font to use for this item</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/AbstractGalleryItemRenderer.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/gallery/AbstractGalleryGroupRenderer.html" title="class in org.eclipse.nebula.widgets.gallery"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/nebula/widgets/gallery/AbstractGridGroupRenderer.html" title="class in org.eclipse.nebula.widgets.gallery"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/gallery/AbstractGalleryItemRenderer.html" target="_top">Frames</a></li> |
| <li><a href="AbstractGalleryItemRenderer.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
