| |
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
-
Restriction:
- This class is not intended to be subclassed by clients.
|
Fields inherited from class org.eclipse.swt.widgets.
Control
|
handle
|
|
Constructor Summary
|
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
|
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. |
Point
|
computeSize
(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver. |
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 by the user. |
void
|
setText
(
String string)
Sets the receiver's text. |
|
Methods inherited from class org.eclipse.swt.widgets.
Control
|
addControlListener,
addDragDetectListener,
addFocusListener,
addHelpListener,
addKeyListener,
addMenuDetectListener,
addMouseListener,
addMouseMoveListener,
addMouseTrackListener,
addMouseWheelListener,
addPaintListener,
addTraverseListener,
computeSize,
dragDetect,
dragDetect,
forceFocus,
getAccessible,
getBackground,
getBackgroundImage,
getBorderWidth,
getBounds,
getCursor,
getDragDetect,
getEnabled,
getFont,
getForeground,
getLayoutData,
getLocation,
getMenu,
getMonitor,
getParent,
getRegion,
getShell,
getSize,
getToolTipText,
getVisible,
internal_dispose_GC,
internal_new_GC,
isEnabled,
isFocusControl,
isReparentable,
isVisible,
moveAbove,
moveBelow,
pack,
pack,
print,
redraw,
redraw,
removeControlListener,
removeDragDetectListener,
removeFocusListener,
removeHelpListener,
removeKeyListener,
removeMenuDetectListener,
removeMouseListener,
removeMouseMoveListener,
removeMouseTrackListener,
removeMouseWheelListener,
removePaintListener,
removeTraverseListener,
setBackground,
setBackgroundImage,
setBounds,
setBounds,
setCapture,
setCursor,
setDragDetect,
setEnabled,
setFocus,
setFont,
setForeground,
setLayoutData,
setLocation,
setLocation,
setMenu,
setParent,
setRedraw,
setRegion,
setSize,
setSize,
setToolTipText,
setVisible,
toControl,
toControl,
toDisplay,
toDisplay,
traverse,
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,
setData,
setData,
toString
|
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:
-
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()
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:
-
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
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"
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
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:
-
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(
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 (").
-
-
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
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
