Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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:

org.eclipse.swt.graphics.Drawable

---

public class Label

extends Control

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)  long	frameHandle
(package private)  org.eclipse.swt.graphics.Image	image
(package private)  long	imageHandle
(package private)  long	labelHandle
(package private)  java.lang.String	text

 

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

accessible, cursor, drawCount, enableWindow, fixedHandle, font, layoutData, menu, parent, redrawWindow, toolTipText

 

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

ACTIVATE, BUTTON_PRESS_EVENT, BUTTON_RELEASE_EVENT, CANVAS, CHANGED, CLICKED, COMMIT, CONFIGURE_EVENT, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DELETE_EVENT, DELETE_RANGE, DELETE_TEXT, DISABLED, display, DISPOSED, ENTER_NOTIFY_EVENT, EVENT, EVENT_AFTER, eventTable, EXPOSE_EVENT, FOCUS, FOCUS_IN_EVENT, FOCUS_OUT_EVENT, handle, HANDLE, HIDE, INSERT_TEXT, KEY_PRESS_EVENT, KEY_RELEASE_EVENT, KEYED_DATA, LEAVE_NOTIFY_EVENT, MAP_EVENT, MENU, MNEMONIC_ACTIVATE, MOTION_NOTIFY_EVENT, OBSCURED, POPUP_MENU, PREEDIT_CHANGED, REALIZE, ROW_ACTIVATED, SCROLL_CHILD, SELECT, SHOW, SHOW_HELP, SIZE_ALLOCATE, state, style, STYLE_SET, SWITCH_PAGE, TEST_COLLAPSE_ROW, TEST_EXPAND_ROW, TOGGLED, UNMAP_EVENT, UNREALIZE, VALUE_CHANGED, VISIBILITY_NOTIFY_EVENT, WINDOW_STATE_EVENT

 

Constructor Summary

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

 

Method Summary
(package private) static int	checkStyle(int style)
org.eclipse.swt.graphics.Point	computeSize(int wHint, int hHint, boolean changed)           Returns the preferred size of the receiver.
(package private)  void	createHandle(int index)
(package private)  void	createWidget(int index)
(package private)  void	deregister()
(package private)  long	eventHandle()
int	getAlignment()           Returns a value which describes the position of the text or image in the receiver.
org.eclipse.swt.graphics.Image	getImage()           Returns the receiver's image if it has one, or null if it does not.
(package private)  java.lang.String	getNameText()
java.lang.String	getText()           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)  void	hookEvents()
(package private)  boolean	mnemonicHit(char key)
(package private)  boolean	mnemonicMatch(char key)
(package private)  void	register()
(package private)  void	releaseHandle()
(package private)  void	releaseWidget()
(package private)  void	resizeHandle(int width, int height)
void	setAlignment(int alignment)           Controls how text and images will be displayed in the receiver.
(package private)  void	setBackgroundColor(org.eclipse.swt.internal.gtk.GdkColor color)
(package private)  boolean	setBounds(int x, int y, int width, int height, boolean move, boolean resize)
(package private)  void	setFontDescription(long font)
(package private)  void	setForegroundColor(org.eclipse.swt.internal.gtk.GdkColor color)
void	setImage(org.eclipse.swt.graphics.Image image)           Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
(package private)  void	setOrientation()
void	setText(java.lang.String string)           Sets the receiver's text.

 

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

_getShell, addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeNativeSize, computeSize, computeTabGroup, computeTabList, computeTabRoot, defaultFont, drawGripper, enableWidget, filterKey, findMenus, fixChildren, fixFocus, focusHandle, fontHandle, forceFocus, forceFocus, getAccessible, getBackground, getBackgroundColor, getBaseColor, getBgColor, getBorderWidth, getBounds, getEnabled, getFgColor, getFont, getFontDescription, getForeground, getForegroundColor, getIMCaretPos, getLayoutData, getLocation, getMenu, getMonitor, getParent, getPath, getShell, getSize, getTextColor, getToolTipText, getVisible, gtk_button_press_event, gtk_button_release_event, gtk_commit, gtk_enter_notify_event, gtk_event_after, gtk_expose_event, gtk_focus_in_event, gtk_focus_out_event, gtk_focus, gtk_key_press_event, gtk_key_release_event, gtk_leave_notify_event, gtk_mnemonic_activate, gtk_motion_notify_event, gtk_popup_menu, gtk_preedit_changed, gtk_realize, gtk_show_help, gtk_unrealize, gtk_visibility_notify_event, hasFocus, hoverProc, imHandle, internal_dispose_GC, internal_new_GC, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, menuShell, moveAbove, moveBelow, moveHandle, pack, pack, paintHandle, paintWindow, redraw, redraw, redrawWidget, releaseChild, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, sendFocusEvent, sendHelpEvent, sendIMKeyEvent, sendKeyEvent, sendMouseEvent, setBackground, setBackgroundColor, setBounds, setBounds, setCapture, setCursor, setCursor, setEnabled, setFocus, setFont, setForeground, setInitialSize, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioSelection, setRedraw, setSize, setSize, setTabGroupFocus, setTabItemFocus, setToolTipText, setVisible, setZOrder, setZOrder, showMenu, sort, toControl, toControl, toDisplay, toDisplay, topHandle, translateMnemonic, translateMnemonic, translateTraversal, traversalCode, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update

 

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkSubclass, checkWidget, destroyWidget, dispose, error, filterProc, filters, fixMnemonic, fontHeight, getData, getData, getDisplay, getName, getStyle, gtk_activate, gtk_changed, gtk_clicked, gtk_configure_event, gtk_delete_event, gtk_delete_range, gtk_delete_text, gtk_event, gtk_hide, gtk_insert_text, gtk_map_event, gtk_row_activated, gtk_scroll_child, gtk_select, gtk_show, gtk_size_allocate, gtk_style_set, gtk_switch_page, gtk_test_collapse_row, gtk_test_expand_row, gtk_timer, gtk_toggled, gtk_unmap_event, gtk_value_changed, gtk_window_state_event, hooks, isDisposed, isListening, isValidSubclass, isValidThread, isValidWidget, menuPositionProc, mnemonicHit, mnemonicMatch, notifyListeners, pixbufCellDataProc, postEvent, postEvent, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, shellMapProc, textCellDataProc, timerProc, toString, translateTraversal, treeSelectionProc, windowProc, windowProc, windowProc, windowProc

 

Methods inherited from class java.lang.Object

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

 

Field Detail

frameHandle

long frameHandle

---

labelHandle

long labelHandle

---

imageHandle

long imageHandle

---

image

org.eclipse.swt.graphics.Image image

---

text

java.lang.String text

Constructor Detail

Label

public Label(Composite parent,
             int style)

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.

Method Detail

checkStyle

static int checkStyle(int style)

---

computeSize

public org.eclipse.swt.graphics.Point computeSize(int wHint,
                                                  int hHint,
                                                  boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

Overrides:

computeSize in class Control

---

createHandle

void createHandle(int index)

Overrides:

createHandle in class Widget

---

createWidget

void createWidget(int index)

Overrides:

createWidget in class Control

---

deregister

void deregister()

Overrides:

deregister in class Control

---

eventHandle

long eventHandle()

Overrides:

eventHandle in class Control

---

getAlignment

public int getAlignment()

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.

---

getImage

public org.eclipse.swt.graphics.Image getImage()

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

---

getNameText

java.lang.String getNameText()

Overrides:

getNameText in class Widget

---

getText

public java.lang.String getText()

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.

---

hookEvents

void hookEvents()

Overrides:

hookEvents in class Control

---

mnemonicHit

boolean mnemonicHit(char key)

Overrides:

mnemonicHit in class Control

---

mnemonicMatch

boolean mnemonicMatch(char key)

Overrides:

mnemonicMatch in class Control

---

register

void register()

Overrides:

register in class Control

---

releaseHandle

void releaseHandle()

Overrides:

releaseHandle in class Control

---

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

---

resizeHandle

void resizeHandle(int width,
                  int height)

Overrides:

resizeHandle in class Control

---

setAlignment

public void setAlignment(int alignment)

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.

---

setBackgroundColor

void setBackgroundColor(org.eclipse.swt.internal.gtk.GdkColor color)

Overrides:

setBackgroundColor in class Control

---

setBounds

boolean setBounds(int x,
                  int y,
                  int width,
                  int height,
                  boolean move,
                  boolean resize)

Overrides:

setBounds in class Control

---

setFontDescription

void setFontDescription(long font)

Overrides:

setFontDescription in class Control

---

setForegroundColor

void setForegroundColor(org.eclipse.swt.internal.gtk.GdkColor color)

Overrides:

setForegroundColor in class Control

---

setOrientation

void setOrientation()

Overrides:

setOrientation in class Widget

---

setImage

public void setImage(org.eclipse.swt.graphics.Image image)

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

---

setText

public void setText(java.lang.String string)

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.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> swt >> [ widgets overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---