| |
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
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.
Shadow styles are hints and may not be honored
by the platform. To create a separator label
with the default shadow style for the platform,
do not specify a shadow style.
-
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.
-
See Also:
-
Label snippets,
SWT Example: ControlExample,
Sample code and further information
-
Restriction:
- This class is not intended to be subclassed by clients.
|
Fields inherited from class org.eclipse.swt.widgets.
Control
|
handle
|
|
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
|
Point
|
computeSize
(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver. |
int
|
getAlignment
()
Returns a value which describes the position of the
text or image in the receiver. |
Image
|
getImage
()
Returns the receiver's image if it has one, or null
if it does not. |
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. |
void
|
setAlignment
(int alignment)
Controls how text and images will be displayed in the receiver. |
void
|
setImage
(
Image image)
Sets the receiver's image to the argument, which may be
null indicating that no image should be displayed. |
void
|
setText
(
String string)
Sets the receiver's text. |
|
Methods inherited from class org.eclipse.swt.widgets.
Control
|
addControlListener,
addDragDetectListener,
addFocusListener,
addHelpListener,
addKeyListener,
addMenuDetectListener,
addMouseListener,
addMouseMoveListener,
addMouseTrackListener,
addMouseWheelListener,
addPaintListener,
addTraverseListener,
computeSize,
dragDetect,
dragDetect,
forceFocus,
getAccessible,
getBackground,
getBackgroundImage,
getBorderWidth,
getBounds,
getCursor,
getDragDetect,
getEnabled,
getFont,
getForeground,
getLayoutData,
getLocation,
getMenu,
getMonitor,
getParent,
getRegion,
getShell,
getSize,
getToolTipText,
getVisible,
internal_dispose_GC,
internal_new_GC,
isEnabled,
isFocusControl,
isReparentable,
isVisible,
moveAbove,
moveBelow,
pack,
pack,
print,
redraw,
redraw,
removeControlListener,
removeDragDetectListener,
removeFocusListener,
removeHelpListener,
removeKeyListener,
removeMenuDetectListener,
removeMouseListener,
removeMouseMoveListener,
removeMouseTrackListener,
removeMouseWheelListener,
removePaintListener,
removeTraverseListener,
setBackground,
setBackgroundImage,
setBounds,
setBounds,
setCapture,
setCursor,
setDragDetect,
setEnabled,
setFocus,
setFont,
setForeground,
setLayoutData,
setLocation,
setLocation,
setMenu,
setParent,
setRedraw,
setRegion,
setSize,
setSize,
setToolTipText,
setVisible,
toControl,
toControl,
toDisplay,
toDisplay,
traverse,
update
|
|
Methods inherited from class org.eclipse.swt.widgets.
Widget
|
addDisposeListener,
addListener,
checkSubclass,
checkWidget,
dispose,
getData,
getData,
getDisplay,
getListeners,
getStyle,
isDisposed,
isListening,
notifyListeners,
removeDisposeListener,
removeListener,
removeListener,
setData,
setData,
toString
|
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.
-
Parameters:
-
parent - a composite control which will be the parent of the new instance (cannot be null) -
style - the style of control to construct
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the parent is null
-
SWTException
-
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
- ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
-
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()
computeSize
public
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
-
-
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(boolean),
"computeTrim, getClientArea for controls that implement them"
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.
-
-
Returns:
- the alignment
-
Throws:
-
SWTException
-
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getImage
public
Image getImage()
- Returns the receiver's image if it has one, or null
if it does not.
-
-
Returns:
- the receiver's image
-
Throws:
-
SWTException
-
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getText
public
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.
-
-
Returns:
- the receiver's text
-
Throws:
-
SWTException
-
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
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.
-
-
Parameters:
-
alignment - the new alignment
-
Throws:
-
SWTException
-
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setImage
public void setImage(
Image image)
- 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)
-
Throws:
-
IllegalArgumentException
-
- ERROR_INVALID_ARGUMENT - if the image has been disposed
-
SWTException
-
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setText
public void setText(
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.
-
-
Parameters:
-
string - the new text
-
Throws:
-
IllegalArgumentException
-
- ERROR_NULL_ARGUMENT - if the text is null
-
SWTException
-
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
