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:

  • Field Details

  • Constructor Details

    • 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:
      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:

  • Method Details

    • 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:
      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:

    • configure

      void configure()

    • createHandle

      void createHandle(int index)
      Overrides:
      createHandle in class Widget

    • gtk_css_provider_load_from_css

      void gtk_css_provider_load_from_css(long context, String css)

    • createWidget

      void createWidget(int index)
      Overrides:
      createWidget in class Widget

    • destroyWidget

      void destroyWidget()
      Overrides:
      destroyWidget in class Widget

    • 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

    • getLocation

      Point getLocation()

    • getMessage

      public 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

    • getNameText

      String getNameText()
      Overrides:
      getNameText in class Widget

    • 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

    • getSize

      Point getSize(int maxWidth)

    • getText

      public 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

    • gtk_button_press_event

      long gtk_button_press_event(long widget, long event)
      Overrides:
      gtk_button_press_event in class Widget

    • drawTooltip

      void drawTooltip(long cairo)

    • gtk_draw

      long gtk_draw(long widget, long cairo)
      Overrides:
      gtk_draw in class Widget

    • gtk_size_allocate

      long gtk_size_allocate(long widget, long allocation)
      Overrides:
      gtk_size_allocate in class Widget

    • hookEvents

      void hookEvents()
      Overrides:
      hookEvents in class Widget

    • 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:

    • 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:
      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:

    • 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:

    • 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:
      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(String string)
      Sets the receiver's message.
      Parameters:
      string - the new message
      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

    • setText

      public void setText(String string)
      Sets the receiver's text.
      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

    • 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

    • timerProc

      long timerProc(long widget)
      Overrides:
      timerProc in class Widget