public class ToolTip extends Widget
Note: Only one of the styles ICON_ERROR, ICON_INFORMATION, and ICON_WARNING may be specified.
IMPORTANT: This class is not intended to be subclassed.
Constructor and Description |
---|
ToolTip(Shell parent,
int style)
Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
|
Modifier and Type | Method and Description |
---|---|
void |
addSelectionListener(SelectionListener listener)
Adds the listener to the collection of listeners who will
be notified when the receiver is selected by the user, by sending
it one of the messages defined in the
SelectionListener
interface. |
<T> T |
getAdapter(java.lang.Class<T> adapter)
Implementation of the
Adaptable interface. |
boolean |
getAutoHide()
Returns
true if the receiver is automatically
hidden by the platform, and false otherwise. |
java.lang.String |
getMessage()
Returns the receiver's message, which will be an empty
string if it has never been set.
|
Shell |
getParent()
Returns the receiver's parent, which must be a
Shell . |
java.lang.String |
getText()
Returns the receiver's text, which will be an empty
string if it has never been set.
|
boolean |
getVisible()
Returns
true if the receiver is visible, and
false otherwise. |
boolean |
isVisible()
Returns
true if the receiver is visible, and
false otherwise. |
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will
be notified when the receiver is selected by the user.
|
void |
setAutoHide(boolean autoHide)
Makes the receiver hide automatically when
true ,
and remain visible when false . |
void |
setData(java.lang.String key,
java.lang.Object value)
Sets the application defined property of the receiver
with the specified name to the given value.
|
void |
setLocation(int x,
int y)
Sets the location of the receiver, which must be a tooltip,
to the point specified by the arguments which are relative
to the display.
|
void |
setLocation(Point location)
Sets the location of the receiver, which must be a tooltip,
to the point specified by the argument which is relative
to the display.
|
void |
setMessage(java.lang.String message)
Sets the receiver's message.
|
void |
setText(java.lang.String text)
Sets the receiver's text.
|
void |
setVisible(boolean visible)
Marks the receiver as visible if the argument is
true ,
and marks it invisible otherwise. |
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, toString
public ToolTip(Shell 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 constructjava.lang.IllegalArgumentException
- SWTException
- SWT.BALLOON
,
SWT.ICON_ERROR
,
SWT.ICON_INFORMATION
,
SWT.ICON_WARNING
,
Widget.checkSubclass()
,
Widget.getStyle()
public <T> T getAdapter(java.lang.Class<T> adapter)
Widget
Adaptable
interface.
IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
getAdapter
in interface Adaptable
getAdapter
in class Widget
adapter
- the lookup classnull
if
there is no adapter associated with the given class.public Shell getParent()
Shell
.SWTException
- public boolean getAutoHide()
true
if the receiver is automatically
hidden by the platform, and false
otherwise.SWTException
- public void setAutoHide(boolean autoHide)
true
,
and remain visible when false
.autoHide
- the auto hide stateSWTException
- getVisible()
,
setVisible(boolean)
public boolean isVisible()
true
if the receiver is visible, and
false
otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.
SWTException
- public boolean getVisible()
true
if the receiver is visible, and
false
otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.
SWTException
- public void setVisible(boolean visible)
true
,
and marks it invisible otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.
visible
- the new visibility stateSWTException
- public java.lang.String getText()
SWTException
- public void setText(java.lang.String text)
text
- the new textjava.lang.IllegalArgumentException
- SWTException
- public java.lang.String getMessage()
SWTException
- public void setMessage(java.lang.String message)
message
- the new messagejava.lang.IllegalArgumentException
- SWTException
- public void setLocation(int x, int y)
Note that this is different from most widgets where the location of the widget is relative to the parent.
x
- the new x coordinate for the receivery
- the new y coordinate for the receiverSWTException
- public void setLocation(Point location)
Note that this is different from most widgets where the location of the widget is relative to the parent.
Note that the platform window manager ultimately has control over the location of tooltips.
location
- the new location for the receiverjava.lang.IllegalArgumentException
- SWTException
- public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
widgetSelected
is called when the receiver is selected.
widgetDefaultSelected
is not called.
listener
- the listener which should be notified when the receiver is selected by the userjava.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
public void setData(java.lang.String key, java.lang.Object value)
Widget
Applications may associate arbitrary objects with the receiver in this fashion. If the objects stored in the properties need to be notified when the widget is disposed of, it is the application's responsibility to hook the Dispose event on the widget and do so.
setData
in class Widget
key
- the name of the propertyvalue
- the new value for the propertyWidget.getData(String)
Copyright (c) EclipseSource and others 2002, 2020.
All rights reserved. This program and the accompanying materials
are made available under the terms of the
Eclipse Public License v1.0