org.eclipse.swt.widgets.ToolTip Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2000, 2010, 2012 IBM Corporation, Gerhardt Informatics Kft. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Gerhardt Informatics Kft. - GEFGWT port
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Point;
/**
* 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.
*
*
* @see Tool Tips
* snippets
* @see SWT Example:
* ControlExample
* @see Sample code and further
* information
*
* @since 3.2
* @noextend This class is not intended to be subclassed by clients.
*/
public class ToolTip extends Widget {
Shell parent;
String text, message;
TrayItem item;
int x, y, timerId;
long /* int */layoutText = 0, layoutMessage = 0;
int[] borderPolygon;
boolean spikeAbove, autohide;
static final int BORDER = 5;
static final int PADDING = 5;
static final int INSET = 4;
static final int TIP_HEIGHT = 20;
static final int IMAGE_SIZE = 16;
static final int DELAY = 8000;
/**
* 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.
*
*
* @param parent
* a composite control which will be the parent of the new
* instance (cannot be null)
* @param style
* the style of control to construct
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if the parent is null
*
* @exception 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 SWT#BALLOON
* @see SWT#ICON_ERROR
* @see SWT#ICON_INFORMATION
* @see SWT#ICON_WARNING
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public ToolTip(Shell parent, int style) {
super(parent, checkStyle(style));
this.parent = parent;
createWidget(0);
parent.addToolTip(this);
}
static int checkStyle(int style) {
int mask = SWT.ICON_ERROR | SWT.ICON_INFORMATION | SWT.ICON_WARNING;
if ((style & mask) == 0)
return style;
return checkBits(style, SWT.ICON_INFORMATION, SWT.ICON_WARNING,
SWT.ICON_ERROR, 0, 0, 0);
}
/**
* 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.
*
*
* @param listener
* the listener which should be notified when the receiver is
* selected by the user
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if the listener is null
*
* @exception 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 SelectionListener
* @see #removeSelectionListener
* @see SelectionEvent
*/
public void addSelectionListener(SelectionListener listener) {
checkWidget();
if (listener == null)
error(SWT.ERROR_NULL_ARGUMENT);
TypedListener typedListener = new TypedListener(listener);
addListener(SWT.Selection, typedListener);
addListener(SWT.DefaultSelection, typedListener);
}
void createHandle(int index) {
}
void createWidget(int index) {
super.createWidget(index);
text = "";
message = "";
x = y = -1;
autohide = true;
}
void destroyWidget() {
}
/**
* Returns true if the receiver is automatically hidden by the
* platform, and false otherwise.
*
* @return the receiver's auto hide state
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*
*/
public boolean getAutoHide() {
checkWidget();
return autohide;
}
/**
* Returns the receiver's message, which will be an empty string if it has
* never been set.
*
* @return the receiver's message
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public String getMessage() {
checkWidget();
return message;
}
String getNameText() {
return getText();
}
/**
* Returns the receiver's parent, which must be a Shell.
*
* @return the receiver's parent
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public Shell getParent() {
checkWidget();
return parent;
}
/**
* Returns the receiver's text, which will be an empty string if it has
* never been set.
*
* @return the receiver's text
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public String getText() {
checkWidget();
return text;
}
/**
* 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.
*
*
* @return the receiver's visibility state
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public boolean getVisible() {
return false;
}
void hookEvents() {
}
/**
* Returns true if the receiver is visible and all of the
* receiver's ancestors are visible and false otherwise.
*
* @return the receiver's visibility state
*
* @exception 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 #getVisible
*/
public boolean isVisible() {
checkWidget();
return getVisible();
}
void register() {
}
void releaseWidget() {
}
/**
* Removes the listener from the collection of listeners who will be
* notified when the receiver is selected by the user.
*
* @param listener
* the listener which should no longer be notified
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if the listener is null
*
* @exception 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 SelectionListener
* @see #addSelectionListener
*/
public void removeSelectionListener(SelectionListener listener) {
checkWidget();
if (listener == null)
error(SWT.ERROR_NULL_ARGUMENT);
if (eventTable == null)
return;
eventTable.unhook(SWT.Selection, listener);
eventTable.unhook(SWT.DefaultSelection, listener);
}
/**
* Makes the receiver hide automatically when true, and remain
* visible when false.
*
* @param autoHide
* the auto hide state
*
* @exception 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 #getVisible
* @see #setVisible
*/
public void setAutoHide(boolean autohide) {
checkWidget();
this.autohide = autohide;
// TODO - update when visible
}
/**
* 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.
*
*
* @param x
* the new x coordinate for the receiver
* @param y
* the new y coordinate for the receiver
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setLocation(int x, int y) {
}
/**
* 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.
*
*
* @param location
* the new location for the receiver
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if the point is null
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setLocation(Point location) {
checkWidget();
if (location == null)
SWT.error(SWT.ERROR_NULL_ARGUMENT);
setLocation(location.x, location.y);
}
/**
* Sets the receiver's message.
*
* @param string
* the new message
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if the text is null
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setMessage(String string) {
}
/**
* Sets the receiver's text.
*
* @param string
* the new text
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if the text is null
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setText(String string) {
}
/**
* 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.
*
*
* @param visible
* the new visibility state
*
* @exception SWTException
*
* - ERROR_WIDGET_DISPOSED - if the receiver has been
* disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the
* thread that created the receiver
*
*/
public void setVisible(boolean visible) {
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy