org.eclipse.swt.widgets

Class ToolTip

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.ToolTip

public class ToolTip
extends Widget

Instances of this class represent popup windows that are used to inform or warn the user.

Styles:

BALLOON, ICON_ERROR, ICON_INFORMATION, ICON_WARNING

Events:

Selection

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.

Since:

3.2

See Also:

Tool Tips snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	autoHide
(package private) boolean	hasLocation
(package private) int	id
(package private) TrayItem	item
(package private) java.lang.String	message
(package private) Shell	parent
(package private) java.lang.String	text
(package private) static int	TIMER_ID
(package private) boolean	visible
(package private) int	x
(package private) int	y

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

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

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.

Method Summary

Methods

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.
(package private) static int	checkStyle(int style)
(package private) void	destroyWidget() Destroys the widget in the operating system and releases the widget's handle.
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.
(package private) int	hwndToolTip()
boolean	isVisible() Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.
(package private) void	releaseHandle()
(package private) void	releaseWidget()
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	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 string) Sets the receiver's message.
void	setText(java.lang.String string) Sets the receiver's text.
void	setVisible(boolean visible) Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

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

_addListener, addDisposeListener, addListener, callWindowProc, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getMenu, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, new_GC, notifyListeners, postEvent, postEvent, release, releaseChildren, releaseParent, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendFocusEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, setTabItemFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

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

Field Detail

parent

Shell parent

item

TrayItem item

text

java.lang.String text

message

java.lang.String message

id

int id

x

int x

y

int y

autoHide

boolean autoHide

hasLocation

boolean hasLocation

visible

boolean visible

TIMER_ID

static final int TIMER_ID

See Also:

Constant Field Values

Constructor Detail

ToolTip

public ToolTip(Shell 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:

java.lang.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.BALLOON, SWT.ICON_ERROR, SWT.ICON_INFORMATION, SWT.ICON_WARNING, Widget.checkSubclass(), Widget.getStyle()

Method Detail

checkStyle

static int checkStyle(int style)

addSelectionListener

public 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.

widgetSelected is called when the receiver is selected. widgetDefaultSelected is not called.

Parameters:

listener - the listener which should be notified when the receiver is selected by the user

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener 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

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

destroyWidget

void destroyWidget()

Description copied from class: Widget

Destroys the widget in the operating system and releases the widget's handle. If the widget does not have a handle, this method may hide the widget, mark the widget as destroyed or do nothing, depending on the widget.

When a widget is destroyed in the operating system, its descendants are also destroyed by the operating system. This means that it is only necessary to call destroyWidget on the root of the widget tree.

This method is called after releaseWidget().

See also releaseChild(), releaseWidget() and releaseHandle().

Overrides:

destroyWidget in class Widget

See Also:

Widget.dispose()

getAutoHide

public boolean getAutoHide()

Returns true if the receiver is automatically hidden by the platform, and false otherwise.

Returns:

the receiver's auto hide state

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

getMessage

public java.lang.String getMessage()

Returns the receiver's message, which will be an empty string if it has never been set.

Returns:

the receiver's message

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

getParent

public Shell getParent()

Returns the receiver's parent, which must be a Shell.

Returns:

the receiver's parent

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 java.lang.String getText()

Returns the receiver's text, which will be an empty string if it has never been set.

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

getVisible

public boolean getVisible()

Returns 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.

Returns:

the receiver's visibility state

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

hwndToolTip

int hwndToolTip()

isVisible

public boolean isVisible()

Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.

Returns:

the receiver's visibility state

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

See Also:

getVisible()

releaseHandle

void releaseHandle()

Overrides:

releaseHandle in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Widget

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the receiver is selected by the user.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener 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

See Also:

SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

setAutoHide

public void setAutoHide(boolean autoHide)

Makes the receiver hide automatically when true, and remain visible when false.

Parameters:

autoHide - the auto hide state

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

See Also:

getVisible(), setVisible(boolean)

setLocation

public 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.

Note that this is different from most widgets where the location of the widget is relative to the parent.

Parameters:

x - the new x coordinate for the receiver

y - the new y coordinate for the receiver

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

setLocation

public 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.

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.

Parameters:

location - the new location for the receiver

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point 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

setMessage

public void setMessage(java.lang.String string)

Sets the receiver's message.

Parameters:

string - the new message

Throws:

java.lang.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

setText

public void setText(java.lang.String string)

Sets the receiver's text.

Parameters:

string - the new text

Throws:

java.lang.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

setVisible

public void setVisible(boolean visible)

Marks the receiver as visible if the argument is 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.

Parameters:

visible - the new visibility state

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