org.eclipse.swt.widgets
Class Label

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Control
              |
              +--org.eclipse.swt.widgets.Label

All Implemented Interfaces:

Drawable

public class Label

extends Control

Safe: Instances of this class represent a non-selectable user interface object that displays a string or image. When SEPARATOR is specified, displays a single vertical or horizontal line.

Styles:

SEPARATOR, HORIZONTAL, VERTICAL

SHADOW_IN, SHADOW_OUT, SHADOW_NONE

CENTER, LEFT, RIGHT, WRAP

Events:

(none)

Note: Only one of SHADOW_IN, SHADOW_OUT and SHADOW_NONE may be specified. SHADOW_NONE is a HINT. Only one of HORIZONTAL and VERTICAL may be specified. Only one of CENTER, LEFT and RIGHT may be specified.

IMPORTANT: This class is intended to be subclassed only within the SWT implementation.

Field Summary

(package private) int	font
(package private) Image	image
(package private) static org.eclipse.swt.internal.win32.TCHAR	LabelClass
(package private) static int	LabelProc

Fields inherited from class org.eclipse.swt.widgets.Control

ACCENTS, accessible, background, drawCount, foreground, handle, hCursor, layoutData, menu, parent, toolTipText

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values

Constructor Summary

Label(Composite parent, int style)
Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

(package private) int	callWindowProc(int msg, int wParam, int lParam)
(package private) static int	checkStyle(int style)
Point	computeSize(int wHint, int hHint, boolean changed) Enabled:
int	getAlignment() Enabled: Returns a value which describes the position of the text or image in the receiver.
Image	getImage() Enabled: Returns the receiver's image if it has one, or null if it does not.
(package private) String	getNameText()
String	getText() Enabled: Returns the receiver's text, which will be an empty string if it has never been set or if the receiver is a SEPARATOR label.
(package private) boolean	getWrap()
(package private) boolean	mnemonicHit(char key)
(package private) boolean	mnemonicMatch(char key)
(package private) void	releaseWidget()
void	setAlignment(int alignment) Enabled: Controls how text and images will be displayed in the receiver.
boolean	setFocus() Suppressed:
void	setImage(Image image) Enabled: Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
void	setText(String string) Enabled: Sets the receiver's text.
(package private) void	setWrap(boolean wrap)
(package private) int	widgetExtStyle()
(package private) int	widgetStyle()
(package private) org.eclipse.swt.internal.win32.TCHAR	windowClass()
(package private) int	windowProc()
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_ERASEBKGND(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_GETFONT(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_SETFONT(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	WM_SIZE(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmDrawChild(int wParam, int lParam)

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, checkOrientation, computeSize, computeTabGroup, computeTabList, computeTabRoot, createHandle, createWidget, defaultBackground, defaultFont, defaultForeground, deregister, destroyWidget, drawBackground, drawBackground, findBrush, findCursor, findMnemonic, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundPixel, getBorderWidth, getBounds, getCodePage, getDisplay, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getParent, getPath, getShell, getSize, getToolTipText, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isDisposed, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, moveAbove, moveBelow, new_Accessible, pack, pack, redraw, redraw, register, releaseHandle, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, setBackground, setBackgroundPixel, setBounds, setBounds, setBounds, setCapture, setCursor, setDefaultFont, setEnabled, setFont, setForeground, setForegroundPixel, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioFocus, setRadioSelection, setRedraw, setSavedFocus, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, sort, subclass, toControl, toControl, toDisplay, toDisplay, transferActive, transferFocus, translateAccelerator, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateFont, windowProc, WM_ACTIVATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_GETDLGCODE, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_HSCROLL, WM_IME_CHAR, WM_IME_COMPOSITION, WM_INITMENUPOPUP, WM_KEYDOWN, WM_KEYUP, WM_KILLFOCUS, WM_LBUTTONDBLCLK, WM_LBUTTONDOWN, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOUSEWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCHITTEST, WM_NOTIFY, WM_PAINT, WM_PALETTECHANGED, WM_PASTE, WM_PRINTCLIENT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETFOCUS, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSCOLORCHANGE, WM_SYSCOMMAND, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TIMER, WM_UNDO, WM_VSCROLL, WM_WINDOWPOSCHANGING, wmColorChild, wmCommandChild, wmMeasureChild, wmNotifyChild, wmScrollChild

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkBits, checkParent, checkSubclass, checkWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseChild, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

image

Image image

font

int font

LabelProc

static final int LabelProc

LabelClass

static final org.eclipse.swt.internal.win32.TCHAR LabelClass

Constructor Detail

Label

public Label(Composite parent,
             int style)

Enabled: Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

See Also:

SWT.SEPARATOR, SWT.HORIZONTAL, SWT.VERTICAL, SWT.SHADOW_IN, SWT.SHADOW_OUT, SWT.SHADOW_NONE, SWT.CENTER, SWT.LEFT, SWT.RIGHT, SWT.WRAP, Widget.checkSubclass(), Widget.getStyle()

Method Detail

callWindowProc

int callWindowProc(int msg,
                   int wParam,
                   int lParam)

Specified by:

callWindowProc in class Control

checkStyle

static int checkStyle(int style)

computeSize

public Point computeSize(int wHint,
                         int hHint,
                         boolean changed)

Enabled:

Overrides:

computeSize in class Control

Parameters:

wHint - the width hint (can be SWT.DEFAULT)

hHint - the height hint (can be SWT.DEFAULT)

changed - true if the control's contents have changed, and false otherwise

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(), "computeTrim, getClientArea for controls that implement them"

getAlignment

public int getAlignment()

Enabled: Returns a value which describes the position of the text or image in the receiver. The value will be one of LEFT, RIGHT or CENTER unless the receiver is a SEPARATOR label, in which case, NONE is returned.

Returns:

the alignment

getImage

public Image getImage()

Enabled: Returns the receiver's image if it has one, or null if it does not.

Returns:

the receiver's image

getNameText

String getNameText()

Overrides:

getNameText in class Widget

getText

public String getText()

Enabled: Returns the receiver's text, which will be an empty string if it has never been set or if the receiver is a SEPARATOR label.

Returns:

the receiver's text

getWrap

boolean getWrap()

mnemonicHit

boolean mnemonicHit(char key)

Overrides:

mnemonicHit in class Control

mnemonicMatch

boolean mnemonicMatch(char key)

Overrides:

mnemonicMatch in class Control

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

setAlignment

public void setAlignment(int alignment)

Enabled: Controls how text and images will be displayed in the receiver. The argument should be one of LEFT, RIGHT or CENTER. If the receiver is a SEPARATOR label, the argument is ignored and the alignment is not changed.

Parameters:

alignment - the new alignment

setFocus

public boolean setFocus()

Suppressed:

Overrides:

setFocus in class Control

Returns:

true if the control got focus, and false if it was unable to.

See Also:

Control.forceFocus()

setImage

public void setImage(Image image)

Enabled: Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.

Parameters:

image - the image to display on the receiver (may be null)

setText

public void setText(String string)

Enabled: Sets the receiver's text.

This method sets the widget label. The label may include the mnemonic character and line delimiters.

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.

Parameters:

string - the new text

setWrap

void setWrap(boolean wrap)

widgetExtStyle

int widgetExtStyle()

Overrides:

widgetExtStyle in class Control

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Control

windowClass

org.eclipse.swt.internal.win32.TCHAR windowClass()

Specified by:

windowClass in class Control

windowProc

int windowProc()

Specified by:

windowProc in class Control

WM_ERASEBKGND

org.eclipse.swt.internal.win32.LRESULT WM_ERASEBKGND(int wParam,
                                                     int lParam)

Overrides:

WM_ERASEBKGND in class Control

WM_GETFONT

org.eclipse.swt.internal.win32.LRESULT WM_GETFONT(int wParam,
                                                  int lParam)

Overrides:

WM_GETFONT in class Control

WM_SETFONT

org.eclipse.swt.internal.win32.LRESULT WM_SETFONT(int wParam,
                                                  int lParam)

Overrides:

WM_SETFONT in class Control

WM_SIZE

org.eclipse.swt.internal.win32.LRESULT WM_SIZE(int wParam,
                                               int lParam)

Overrides:

WM_SIZE in class Control

wmDrawChild

org.eclipse.swt.internal.win32.LRESULT wmDrawChild(int wParam,
                                                   int lParam)

Overrides:

wmDrawChild in class Control