org.eclipse.swt.widgets

Class Link

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Link

All Implemented Interfaces:

Adaptable, Drawable

public class Link
extends Control

Instances of this class represent a selectable user interface object that displays a text with links.

Styles:

(none)

Events:

Selection

IMPORTANT: This class is not intended to be subclassed.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Link(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

Modifier and Type	Method and Description
void	addSelectionListener(SelectionListener listener) Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.
Point	computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.
<T> T	getAdapter(java.lang.Class<T> adapter) Implementation of the Adaptable interface.
java.lang.String	getText() Returns the receiver's text, which will be an empty string if it has never been set.
void	removeSelectionListener(SelectionListener listener) Removes the listener from the collection of listeners who will be notified when the control is selected.
void	setText(java.lang.String string) Sets the receiver's text.

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addTouchListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCursor, setData, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setSize, setSize, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, update

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

addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link(Composite 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:

Widget.checkSubclass(), Widget.getStyle()

Method Detail

setText

public void setText(java.lang.String string)

Sets the receiver's text.

The string can contain both regular text and hyperlinks. A hyperlink is delimited by an anchor tag, <A> and </A>. Within an anchor, a single HREF attribute is supported. When a hyperlink is selected, the text field of the selection event contains either the text of the hyperlink or the value of its HREF, if one was specified. In the rare case of identical hyperlinks within the same string, the HREF tag can be used to distinguish between them. The string may include the mnemonic character and line delimiters.

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

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

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.

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

Parameters:

listener - the listener which should 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, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the control is selected.

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)

computeSize

public Point computeSize(int wHint,
                         int hHint,
                         boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

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.

Overrides:

computeSize in class Control

Parameters:

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

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(boolean), "computeTrim, getClientArea for controls that implement them"

getAdapter

public <T> T getAdapter(java.lang.Class<T> adapter)

Description copied from class: Widget

Implementation of the 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.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class Control

Parameters:

adapter - the lookup class

Returns:

an object that can be cast to the given class or null if there is no adapter associated with the given class.