|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.swt.widgets.Widget | +--org.eclipse.swt.widgets.Control | +--org.eclipse.swt.widgets.Label
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.
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 |
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. |
boolean |
setFocus()
Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it. |
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.Widget |
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getStyle, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Label(Composite parent, int style)
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.
parent
- a composite control which will be the parent of the new instance (cannot be null)style
- the style of control to construct
IllegalArgumentException
- SWTException
- 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 |
public Point computeSize(int wHint, int hHint, boolean changed)
Control
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.
computeSize
in class Control
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
Layout
,
Control.getBorderWidth()
,
Control.getBounds()
,
Control.getSize()
,
Control.pack()
,
"computeTrim, getClientArea for controls that implement them"public int getAlignment()
LEFT
, RIGHT
or CENTER
unless the receiver is a SEPARATOR
label, in
which case, NONE
is returned.
SWTException
- public Image getImage()
SWTException
- public String getText()
SEPARATOR
label.
SWTException
- public void setAlignment(int alignment)
LEFT
, RIGHT
or CENTER
. If the receiver is a SEPARATOR
label, the argument is ignored and the alignment is not changed.
alignment
- the new alignment
SWTException
- public boolean setFocus()
Control
setFocus
in class Control
true
if the control got focus, and false
if it was unable to.Control.forceFocus()
public void setImage(Image image)
image
- the image to display on the receiver (may be null)
IllegalArgumentException
- SWTException
- public void setText(String string)
This method sets the widget label. The label may include the mnemonic characters and line delimiters.
string
- the new text
IllegalArgumentException
- SWTException
-
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |