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:

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:

3.1

See Also:

Link snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Color	disabledColor
(package private) int	focusIndex
(package private) int	font
(package private) java.lang.String[]	ids
(package private) TextLayout	layout
(package private) static RGB	LINK_FOREGROUND
(package private) static TCHAR	LinkClass
(package private) Color	linkColor
(package private) static int	LinkProc
(package private) int[]	mnemonics
(package private) int	mouseDownIndex
(package private) Point[]	offsets
(package private) Point	selection
(package private) java.lang.String	text

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

accessible, background, backgroundImage, cursor, drawCount, foreground, handle, layoutData, menu, parent, region, toolTipText

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

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 control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
Point	computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.
(package private) void	createHandle()
(package private) void	createWidget()
(package private) void	drawWidget(GC gc, RECT rect)
(package private) void	enableWidget(boolean enabled)
(package private) java.lang.String	getNameText()
(package private) Rectangle[]	getRectangles(int linkIndex)
java.lang.String	getText() Returns the receiver's text, which will be an empty string if it has never been set.
(package private) void	initAccessible()
(package private) boolean	mnemonicHit(char key)
(package private) boolean	mnemonicMatch(char key)
(package private) java.lang.String	parse(java.lang.String string)
(package private) int	parseMnemonics(char[] buffer, int start, int end, java.lang.StringBuffer result)
(package private) void	releaseWidget()
void	removeSelectionListener(SelectionListener listener) Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
void	setText(java.lang.String string) Sets the receiver's text.
(package private) int	widgetStyle()
(package private) TCHAR	windowClass()
(package private) int	windowProc()
(package private) LRESULT	WM_CHAR(int wParam, int lParam)
(package private) LRESULT	WM_GETDLGCODE(int wParam, int lParam)
(package private) LRESULT	WM_GETFONT(int wParam, int lParam)
(package private) LRESULT	WM_KEYDOWN(int wParam, int lParam)
(package private) LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONUP(int wParam, int lParam)
(package private) LRESULT	WM_MOUSEMOVE(int wParam, int lParam)
(package private) LRESULT	WM_NCHITTEST(int wParam, int lParam)
(package private) LRESULT	WM_PAINT(int wParam, int lParam)
(package private) LRESULT	WM_PRINTCLIENT(int wParam, int lParam)
(package private) LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_SETFONT(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	wmColorChild(int wParam, int lParam)
(package private) LRESULT	wmNotifyChild(NMHDR hdr, int wParam, int lParam)

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, binarySearch, borderHandle, checkBackground, checkBorder, checkBuffered, checkComposited, checkGesture, checkHandle, checkMirrored, computeSize, computeTabGroup, computeTabList, computeTabRoot, defaultBackground, defaultFont, defaultForeground, deregister, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, drawThemeBackground, enableDrag, fillBackground, fillImageBackground, fillThemeBackground, findBackgroundControl, findBrush, findCursor, findImageControl, findMenus, findMnemonic, findThemeControl, fixChildren, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundImage, getBackgroundPixel, getBorderWidth, getBounds, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, mapEvent, markLayout, menuShell, moveAbove, moveBelow, new_Accessible, new_GC, pack, pack, print, printWidget, redraw, redraw, redraw, redrawChildren, register, releaseHandle, releaseParent, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, sendFocusEvent, sendGestureEvent, sendMove, sendResize, sendTouchEvent, setBackground, setBackground, setBackgroundImage, setBackgroundImage, setBackgroundPixel, setBounds, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setDefaultFont, setDragDetect, setEnabled, setFocus, setFont, setForeground, setForegroundPixel, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRadioFocus, setRadioSelection, setRedraw, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, setVisible, showWidget, sort, subclass, toControl, toControl, toDisplay, toDisplay, topHandle, translateAccelerator, translateMnemonic, translateMnemonic, translateTraversal, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateImages, updateLayout, updateOrientation, widgetCreateStruct, widgetExtStyle, widgetParent, windowProc, WM_ACTIVATE, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ENTERIDLE, WM_ERASEBKGND, WM_GESTURE, WM_GETMINMAXINFO, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_HSCROLL, WM_IME_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INITMENUPOPUP, WM_INPUTLANGCHANGE, WM_KEYUP, WM_LBUTTONDBLCLK, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSEHWHEEL, WM_MOUSELEAVE, WM_MOUSEWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PALETTECHANGED, WM_PARENTNOTIFY, WM_PASTE, WM_PRINT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSCOLORCHANGE, WM_SYSCOMMAND, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TIMER, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, WM_UPDATEUISTATE, WM_VSCROLL, WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING, WM_XBUTTONDBLCLK, WM_XBUTTONDOWN, WM_XBUTTONUP, wmCommandChild, wmDrawChild, wmMeasureChild, wmNotify, wmScrollChild

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

_addListener, addDisposeListener, addListener, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, notifyListeners, postEvent, postEvent, release, releaseChildren, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, 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

text

java.lang.String text

layout

TextLayout layout

linkColor

Color linkColor

disabledColor

Color disabledColor

offsets

Point[] offsets

selection

Point selection

ids

java.lang.String[] ids

mnemonics

int[] mnemonics

focusIndex

int focusIndex

mouseDownIndex

int mouseDownIndex

font

int font

LINK_FOREGROUND

static final RGB LINK_FOREGROUND

LinkProc

static final int LinkProc

LinkClass

static final TCHAR LinkClass

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

addSelectionListener

public void addSelectionListener(SelectionListener listener)

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

widgetSelected is called when the control is selected by the user. 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

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam)

Overrides:

callWindowProc in class Widget

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"

createHandle

void createHandle()

Overrides:

createHandle in class Control

createWidget

void createWidget()

Overrides:

createWidget in class Control

drawWidget

void drawWidget(GC gc,
              RECT rect)

enableWidget

void enableWidget(boolean enabled)

Overrides:

enableWidget in class Control

initAccessible

void initAccessible()

getNameText

java.lang.String getNameText()

Overrides:

getNameText in class Widget

getRectangles

Rectangle[] getRectangles(int linkIndex)

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

mnemonicHit

boolean mnemonicHit(char key)

Overrides:

mnemonicHit in class Control

mnemonicMatch

boolean mnemonicMatch(char key)

Overrides:

mnemonicMatch in class Control

parse

java.lang.String parse(java.lang.String string)

parseMnemonics

int parseMnemonics(char[] buffer,
                 int start,
                 int end,
                 java.lang.StringBuffer result)

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the control 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)

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 attribute can be used to distinguish between them. The string may include the mnemonic character and line delimiters. The only delimiter the HREF attribute supports is the quotation mark (").

Mnemonics are indicated by an '&' that causes the next character to be the mnemonic. The receiver can have a mnemonic in the text preceding each link. When the user presses a key sequence that matches the mnemonic, focus is assigned to the link that follows the text. Mnemonics in links and in the trailing text are ignored. On most platforms, the mnemonic appears underlined but may be emphasised in a platform specific manner. The mnemonic indicator character '&' can be escaped by doubling it in the string, causing a single '&' to be displayed.

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

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Control

windowClass

TCHAR windowClass()

Specified by:

windowClass in class Control

windowProc

int windowProc()

Specified by:

windowProc in class Control

WM_CHAR

LRESULT WM_CHAR(int wParam,
              int lParam)

Overrides:

WM_CHAR in class Control

WM_GETDLGCODE

LRESULT WM_GETDLGCODE(int wParam,
                    int lParam)

Overrides:

WM_GETDLGCODE in class Control

WM_GETFONT

LRESULT WM_GETFONT(int wParam,
                 int lParam)

Overrides:

WM_GETFONT in class Control

WM_KEYDOWN

LRESULT WM_KEYDOWN(int wParam,
                 int lParam)

Overrides:

WM_KEYDOWN in class Control

WM_KILLFOCUS

LRESULT WM_KILLFOCUS(int wParam,
                   int lParam)

Overrides:

WM_KILLFOCUS in class Control

WM_LBUTTONDOWN

LRESULT WM_LBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_LBUTTONDOWN in class Control

WM_LBUTTONUP

LRESULT WM_LBUTTONUP(int wParam,
                   int lParam)

Overrides:

WM_LBUTTONUP in class Control

WM_NCHITTEST

LRESULT WM_NCHITTEST(int wParam,
                   int lParam)

Overrides:

WM_NCHITTEST in class Control

WM_MOUSEMOVE

LRESULT WM_MOUSEMOVE(int wParam,
                   int lParam)

Overrides:

WM_MOUSEMOVE in class Control

WM_PAINT

LRESULT WM_PAINT(int wParam,
               int lParam)

Overrides:

WM_PAINT in class Control

WM_PRINTCLIENT

LRESULT WM_PRINTCLIENT(int wParam,
                     int lParam)

Overrides:

WM_PRINTCLIENT in class Control

WM_SETFOCUS

LRESULT WM_SETFOCUS(int wParam,
                  int lParam)

Overrides:

WM_SETFOCUS in class Control

WM_SETFONT

LRESULT WM_SETFONT(int wParam,
                 int lParam)

Overrides:

WM_SETFONT in class Control

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Control

wmColorChild

LRESULT wmColorChild(int wParam,
                   int lParam)

Overrides:

wmColorChild in class Control

wmNotifyChild

LRESULT wmNotifyChild(NMHDR hdr,
                    int wParam,
                    int lParam)

Overrides:

wmNotifyChild in class Control