| <!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:42 CEST 2020 --> |
| <title>BadgedLabel</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="BadgedLabel"; |
| } |
| } |
| 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,"i16":10,"i17":10,"i18":10,"i19":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/BadgedLabel.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html" target="_top">Frames</a></li> |
| <li><a href="BadgedLabel.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="#fields.inherited.from.class.org.eclipse.swt.widgets.Control">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>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.badgedlabel</div> |
| <h2 title="Class BadgedLabel" class="title">Class BadgedLabel</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.badgedlabel.BadgedLabel</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">BadgedLabel</span> |
| extends org.eclipse.swt.widgets.Canvas</pre> |
| <div class="block">Instances of this class represent a non-selectable user interface object that |
| displays a string or image. A badge is displayed on this label, so you can |
| add extra information (the most common used is a notification label that |
| shows the number of unread notifications). |
| |
| <dl> |
| <dt><b>Styles:</b></dt> |
| <dd>SWT.BORDER</dd> |
| <dd>SWT.LEFT or SWT.RIGHT (horizontal location)</dd> |
| <dd>SWT.TOP or SWT.BOTTOM (vertical location)</dd> |
| <dt><b>Events:</b></dt> |
| <dd>(none)</dd> |
| </dl></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 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"> </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/badgedlabel/BadgedLabel.html#BadgedLabel-org.eclipse.swt.widgets.Composite-int-">BadgedLabel</a></span>(org.eclipse.swt.widgets.Composite parent, |
| int 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"> </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>org.eclipse.swt.graphics.Point</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#computeSize-int-int-boolean-">computeSize</a></span>(int wHint, |
| int hHint, |
| boolean changed)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getBackgroundColor--">getBackgroundColor</a></span>()</code> |
| <div class="block">Returns the background color that the receiver will use to draw.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getBadgeBackground--">getBadgeBackground</a></span>()</code> |
| <div class="block">Returns the background color that the badge will use to draw.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getBadgeForeground--">getBadgeForeground</a></span>()</code> |
| <div class="block">Returns the foreground color that the badge will use to draw.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getBadgeValue--">getBadgeValue</a></span>()</code> |
| <div class="block">Returns the text of the badge</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getBorderColor--">getBorderColor</a></span>()</code> |
| <div class="block">Returns the border color that the receiver will use to draw.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.swt.graphics.Image</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getImage--">getImage</a></span>()</code> |
| <div class="block">Returns the receiver's image if it has one, or null if it does not.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getText--">getText</a></span>()</code> |
| <div class="block">Returns the receiver's text, which will be an empty string if it has never |
| been set or if the receiver is a <code>SEPARATOR</code> label.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.swt.graphics.Color</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#getTextColor--">getTextColor</a></span>()</code> |
| <div class="block">Returns the text color that the receiver will use to draw.</div> |
| </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/badgedlabel/BadgedLabel.html#setBackgroundColor-org.eclipse.swt.graphics.Color-">setBackgroundColor</a></span>(org.eclipse.swt.graphics.Color backgroundColor)</code> |
| <div class="block">Sets the receiver's background color to the color specified by the argument</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#setBadgeBackground-org.eclipse.swt.graphics.Color-">setBadgeBackground</a></span>(org.eclipse.swt.graphics.Color badgeBackground)</code> |
| <div class="block">Sets the badge's background color to the color specified by the argument</div> |
| </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/badgedlabel/BadgedLabel.html#setBadgeForeground-org.eclipse.swt.graphics.Color-">setBadgeForeground</a></span>(org.eclipse.swt.graphics.Color badgeForeground)</code> |
| <div class="block">Sets the badge's foreground color to the color specified by the argument</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/badgedlabel/BadgedLabel.html#setBadgeValue-java.lang.String-">setBadgeValue</a></span>(java.lang.String value)</code> |
| <div class="block">Sets the badge's value (text) to the text specified by the argument</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/badgedlabel/BadgedLabel.html#setBorderColor-org.eclipse.swt.graphics.Color-">setBorderColor</a></span>(org.eclipse.swt.graphics.Color borderColor)</code> |
| <div class="block">Sets the receiver's border color to the color specified by the argument</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/badgedlabel/BadgedLabel.html#setEnabled-boolean-">setEnabled</a></span>(boolean enabled)</code> </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/badgedlabel/BadgedLabel.html#setFont-org.eclipse.swt.graphics.Font-">setFont</a></span>(org.eclipse.swt.graphics.Font font)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#setImage-org.eclipse.swt.graphics.Image-">setImage</a></span>(org.eclipse.swt.graphics.Image image)</code> |
| <div class="block">Sets the receiver's image to the argument, which may be null indicating that |
| no image should be displayed.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#setPredefinedColor-int-">setPredefinedColor</a></span>(int color)</code> |
| <div class="block">Sets the badge's color theme to the theme specified by the argument</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#setText-java.lang.String-">setText</a></span>(java.lang.String text)</code> |
| <div class="block">Sets the receiver's text.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html#setTextColor-org.eclipse.swt.graphics.Color-">setTextColor</a></span>(org.eclipse.swt.graphics.Color textColor)</code> |
| <div class="block">Sets the receiver's text color to the color specified by the argument</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 org.eclipse.swt.widgets.Canvas</h3> |
| <code>drawBackground, getCaret, getIME, scroll, setCaret, 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 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 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 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, 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 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 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 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="BadgedLabel-org.eclipse.swt.widgets.Composite-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BadgedLabel</h4> |
| <pre>public BadgedLabel(org.eclipse.swt.widgets.Composite parent, |
| int 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="setPredefinedColor-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPredefinedColor</h4> |
| <pre>public void setPredefinedColor(int color)</pre> |
| <div class="block">Sets the badge's color theme to the theme specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>color</code> - the new color, can pick one of the following value: |
| SWT.COLOR_BLUE, SWT.COLOR_GRAY, SWT.COLOR_GREEN, SWT.COLOR_RED, |
| SWT.COLOR_YELLOW, SWT.COLOR_CYAN, SWT.COLOR_BLACK</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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="computeSize-int-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>computeSize</h4> |
| <pre>public org.eclipse.swt.graphics.Point computeSize(int wHint, |
| int hHint, |
| boolean changed)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>computeSize</code> in class <code>org.eclipse.swt.widgets.Control</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Control.computeSize(int, int, boolean)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBackgroundColor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBackgroundColor</h4> |
| <pre>public org.eclipse.swt.graphics.Color getBackgroundColor()</pre> |
| <div class="block">Returns the background color that the receiver will use to draw.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver's background color</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="getBadgeBackground--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBadgeBackground</h4> |
| <pre>public org.eclipse.swt.graphics.Color getBadgeBackground()</pre> |
| <div class="block">Returns the background color that the badge will use to draw.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the badge's backdground color</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="getBadgeForeground--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBadgeForeground</h4> |
| <pre>public org.eclipse.swt.graphics.Color getBadgeForeground()</pre> |
| <div class="block">Returns the foreground color that the badge will use to draw.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the badge's foreground color</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="getBadgeValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBadgeValue</h4> |
| <pre>public java.lang.String getBadgeValue()</pre> |
| <div class="block">Returns the text of the badge</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the badge's text</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="getBorderColor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBorderColor</h4> |
| <pre>public org.eclipse.swt.graphics.Color getBorderColor()</pre> |
| <div class="block">Returns the border color that the receiver will use to draw.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver's border color</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="getImage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImage</h4> |
| <pre>public org.eclipse.swt.graphics.Image getImage()</pre> |
| <div class="block">Returns the receiver's image if it has one, or null if it does not.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver's image</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="getText--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getText</h4> |
| <pre>public java.lang.String getText()</pre> |
| <div class="block">Returns the receiver's text, which will be an empty string if it has never |
| been set or if the receiver is a <code>SEPARATOR</code> label.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver's text</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="getTextColor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTextColor</h4> |
| <pre>public org.eclipse.swt.graphics.Color getTextColor()</pre> |
| <div class="block">Returns the text color that the receiver will use to draw.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver's text color</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="setBackgroundColor-org.eclipse.swt.graphics.Color-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBackgroundColor</h4> |
| <pre>public void setBackgroundColor(org.eclipse.swt.graphics.Color backgroundColor)</pre> |
| <div class="block">Sets the receiver's background color to the color specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>color</code> - the new color</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_INVALID_ARGUMENT - if the argument has been |
| disposed</li> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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="setBadgeBackground-org.eclipse.swt.graphics.Color-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBadgeBackground</h4> |
| <pre>public void setBadgeBackground(org.eclipse.swt.graphics.Color badgeBackground)</pre> |
| <div class="block">Sets the badge's background color to the color specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>color</code> - the new color</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_INVALID_ARGUMENT - if the argument has been |
| disposed</li> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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="setBadgeForeground-org.eclipse.swt.graphics.Color-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBadgeForeground</h4> |
| <pre>public void setBadgeForeground(org.eclipse.swt.graphics.Color badgeForeground)</pre> |
| <div class="block">Sets the badge's foreground color to the color specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>color</code> - the new color</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_INVALID_ARGUMENT - if the argument has been |
| disposed</li> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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="setBadgeValue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBadgeValue</h4> |
| <pre>public void setBadgeValue(java.lang.String value)</pre> |
| <div class="block">Sets the badge's value (text) to the text specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the new text value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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="setBorderColor-org.eclipse.swt.graphics.Color-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBorderColor</h4> |
| <pre>public void setBorderColor(org.eclipse.swt.graphics.Color borderColor)</pre> |
| <div class="block">Sets the receiver's border color to the color specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>color</code> - the new color</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_INVALID_ARGUMENT - if the argument has been |
| disposed</li> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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="setEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnabled</h4> |
| <pre>public void setEnabled(boolean enabled)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setEnabled</code> in class <code>org.eclipse.swt.widgets.Control</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Control.setEnabled(boolean)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFont-org.eclipse.swt.graphics.Font-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFont</h4> |
| <pre>public void setFont(org.eclipse.swt.graphics.Font font)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setFont</code> in class <code>org.eclipse.swt.widgets.Canvas</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Canvas.setFont(org.eclipse.swt.graphics.Font)</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> |
| <div class="block">Sets the receiver's image to the argument, which may be null indicating that |
| no image should be displayed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>image</code> - the image to display on the receiver (may be null)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_INVALID_ARGUMENT - if the image has been |
| disposed</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="setText-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setText</h4> |
| <pre>public void setText(java.lang.String text)</pre> |
| <div class="block">Sets the receiver's text. |
| <p> |
| This method sets the widget label. The label may include the mnemonic |
| character and line delimiters. |
| </p> |
| <p> |
| Mnemonics are indicated by an '&' that causes the next character to be |
| the mnemonic. When the user presses a key sequence that matches the mnemonic, |
| focus is assigned to the control that follows the label. On most platforms, |
| the mnemonic appears underlined but may be emphasised in a platform specific |
| manner. The mnemonic indicator character '&' can be escaped by doubling |
| it in the string, causing a single '&' to be displayed. |
| </p> |
| <p> |
| Note: If control characters like '\n', '\t' etc. are used in the string, then |
| the behavior is platform dependent. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>string</code> - the new text</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_NULL_ARGUMENT - if the text 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="setTextColor-org.eclipse.swt.graphics.Color-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setTextColor</h4> |
| <pre>public void setTextColor(org.eclipse.swt.graphics.Color textColor)</pre> |
| <div class="block">Sets the receiver's text color to the color specified by the argument</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>color</code> - the new color</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - <ul> |
| <li>ERROR_INVALID_ARGUMENT - if the argument has been |
| disposed</li> |
| <li>ERROR_NULL_ARGUMENT - if the argument 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> |
| </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/BadgedLabel.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/nebula/widgets/badgedlabel/BadgedLabel.html" target="_top">Frames</a></li> |
| <li><a href="BadgedLabel.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="#fields.inherited.from.class.org.eclipse.swt.widgets.Control">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>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> |