blob: 31f3cdcc054d0df0ae5d1b3fc102f70369eed75a [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2009 IBM Corporation 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
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.internal.cocoa.*;
import org.eclipse.swt.*;
import org.eclipse.swt.events.*;
import org.eclipse.swt.graphics.*;
/**
* Instances of this class represent a selectable
* user interface object that displays a text with
* links.
* <p>
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>(none)</dd>
* <dt><b>Events:</b></dt>
* <dd>Selection</dd>
* </dl>
* <p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
* </p>
*
* @see <a href="http://www.eclipse.org/swt/snippets/#link">Link snippets</a>
* @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a>
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
*
* @since 3.1
* @noextend This class is not intended to be subclassed by clients.
*/
public class Link extends Control {
NSScrollView scrollView;
String text;
Point [] offsets;
Point selection;
String [] ids;
int [] mnemonics;
NSColor linkColor;
/**
* Constructs a new instance of this class given its parent
* and a style value describing its behavior and appearance.
* <p>
* The style value is either one of the style constants defined in
* class <code>SWT</code> which is applicable to instances of this
* class, or must be built by <em>bitwise OR</em>'ing together
* (that is, using the <code>int</code> "|" operator) two or more
* of those <code>SWT</code> style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
* </p>
*
* @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 <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Link (Composite parent, int style) {
super (parent, style);
}
/**
* 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 <code>SelectionListener</code>
* interface.
* <p>
* <code>widgetSelected</code> is called when the control is selected by the user.
* <code>widgetDefaultSelected</code> is not called.
* </p>
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @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);
}
boolean textView_clickOnLink_atIndex(int /*long*/ id, int /*long*/ sel, int /*long*/ textView, int /*long*/ link, int /*long*/ charIndex) {
NSString str = new NSString (link);
Event event = new Event ();
event.text = str.getString();
sendEvent (SWT.Selection, event);
return true;
}
public Point computeSize (int wHint, int hHint, boolean changed) {
checkWidget ();
if (wHint != SWT.DEFAULT && wHint < 0) wHint = 0;
if (hHint != SWT.DEFAULT && hHint < 0) hHint = 0;
int width, height;
//TODO wrapping, wHint
int borderStyle = hasBorder() ? OS.NSBezelBorder : OS.NSNoBorder;
NSSize borderSize = NSScrollView.frameSizeForContentSize(new NSSize(), false, false, borderStyle);
NSTextView widget = (NSTextView)view;
NSSize size = widget.textStorage().size();
width = (int)(size.width + borderSize.width);
height = (int)(size.height + borderSize.height);
if (wHint != SWT.DEFAULT) width = wHint;
if (hHint != SWT.DEFAULT) height = hHint;
int border = getBorderWidth ();
width += border * 2;
height += border * 2;
// TODO is this true? if so, can this rounding be turned off?
/*
* Bug in Cocoa. NSTextStorage.size() seems to return a width
* value that is rounded down, because its result is never
* fractional. The workaround is to increment width by 1
* to ensure that it is wide enough to show the full text.
*/
width += 1;
return new Point (width, height);
}
void createHandle () {
state |= THEME_BACKGROUND;
NSScrollView scrollWidget = (NSScrollView)new SWTScrollView().alloc();
scrollWidget.init();
scrollWidget.setDrawsBackground(false);
scrollWidget.setBorderType(hasBorder() ? OS.NSBezelBorder : OS.NSNoBorder);
NSTextView widget = (NSTextView)new SWTTextView().alloc();
widget.init();
widget.setEditable(false);
widget.setDrawsBackground(false);
widget.setDelegate(widget);
widget.setAutoresizingMask (OS.NSViewWidthSizable | OS.NSViewHeightSizable);
widget.textContainer().setLineFragmentPadding(0);
scrollView = scrollWidget;
view = widget;
}
void createWidget () {
super.createWidget ();
text = "";
NSDictionary dict = ((NSTextView)view).linkTextAttributes();
linkColor = new NSColor(dict.valueForKey(OS.NSForegroundColorAttributeName));
}
NSFont defaultNSFont () {
return display.textViewFont;
}
void deregister () {
super.deregister ();
if (scrollView != null) display.removeWidget (scrollView);
}
void enableWidget (boolean enabled) {
super.enableWidget (enabled);
NSColor nsColor = null;
if (enabled) {
if (foreground == null) {
nsColor = NSColor.textColor ();
} else {
nsColor = NSColor.colorWithDeviceRed (foreground [0], foreground [1], foreground [2], foreground[3]);
}
} else {
nsColor = NSColor.disabledControlTextColor();
}
NSTextView widget = (NSTextView)view;
widget.setTextColor(nsColor);
NSDictionary linkTextAttributes = widget.linkTextAttributes();
int count = (int)/*64*/linkTextAttributes.count();
NSMutableDictionary dict = NSMutableDictionary.dictionaryWithCapacity(count);
dict.setDictionary(linkTextAttributes);
dict.setValue(enabled ? linkColor : nsColor, OS.NSForegroundColorAttributeName);
widget.setLinkTextAttributes(dict);
}
String getNameText () {
return getText ();
}
/**
* Returns the receiver's text, which will be an empty
* string if it has never been set.
*
* @return the receiver's text
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public String getText () {
checkWidget ();
return text;
}
void register () {
super.register ();
if (scrollView != null) display.addWidget (scrollView, this);
}
void releaseWidget () {
super.releaseWidget ();
offsets = null;
ids = null;
mnemonics = null;
text = null;
linkColor = null;
}
/**
* Removes the listener from the collection of listeners who will
* be notified when the control is selected by the user.
*
* @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @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);
}
String parse (String string) {
int length = string.length ();
offsets = new Point [length / 4];
ids = new String [length / 4];
mnemonics = new int [length / 4 + 1];
StringBuffer result = new StringBuffer ();
char [] buffer = new char [length];
string.getChars (0, string.length (), buffer, 0);
int index = 0, state = 0, linkIndex = 0;
int start = 0, tagStart = 0, linkStart = 0, endtagStart = 0, refStart = 0;
while (index < length) {
char c = Character.toLowerCase (buffer [index]);
switch (state) {
case 0:
if (c == '<') {
tagStart = index;
state++;
}
break;
case 1:
if (c == 'a') state++;
break;
case 2:
switch (c) {
case 'h':
state = 7;
break;
case '>':
linkStart = index + 1;
state++;
break;
default:
if (Character.isWhitespace(c)) break;
else state = 13;
}
break;
case 3:
if (c == '<') {
endtagStart = index;
state++;
}
break;
case 4:
state = c == '/' ? state + 1 : 3;
break;
case 5:
state = c == 'a' ? state + 1 : 3;
break;
case 6:
if (c == '>') {
mnemonics [linkIndex] = parseMnemonics (buffer, start, tagStart, result);
int offset = result.length ();
parseMnemonics (buffer, linkStart, endtagStart, result);
offsets [linkIndex] = new Point (offset, result.length () - 1);
if (ids [linkIndex] == null) {
ids [linkIndex] = new String (buffer, linkStart, endtagStart - linkStart);
}
linkIndex++;
start = tagStart = linkStart = endtagStart = refStart = index + 1;
state = 0;
} else {
state = 3;
}
break;
case 7:
state = c == 'r' ? state + 1 : 0;
break;
case 8:
state = c == 'e' ? state + 1 : 0;
break;
case 9:
state = c == 'f' ? state + 1 : 0;
break;
case 10:
state = c == '=' ? state + 1 : 0;
break;
case 11:
if (c == '"') {
state++;
refStart = index + 1;
} else {
state = 0;
}
break;
case 12:
if (c == '"') {
ids[linkIndex] = new String (buffer, refStart, index - refStart);
state = 2;
}
break;
case 13:
if (Character.isWhitespace (c)) {
state = 0;
} else if (c == '='){
state++;
}
break;
case 14:
state = c == '"' ? state + 1 : 0;
break;
case 15:
if (c == '"') state = 2;
break;
default:
state = 0;
break;
}
index++;
}
if (start < length) {
int tmp = parseMnemonics (buffer, start, tagStart, result);
int mnemonic = parseMnemonics (buffer, Math.max (tagStart, linkStart), length, result);
if (mnemonic == -1) mnemonic = tmp;
mnemonics [linkIndex] = mnemonic;
} else {
mnemonics [linkIndex] = -1;
}
if (offsets.length != linkIndex) {
Point [] newOffsets = new Point [linkIndex];
System.arraycopy (offsets, 0, newOffsets, 0, linkIndex);
offsets = newOffsets;
String [] newIDs = new String [linkIndex];
System.arraycopy (ids, 0, newIDs, 0, linkIndex);
ids = newIDs;
int [] newMnemonics = new int [linkIndex + 1];
System.arraycopy (mnemonics, 0, newMnemonics, 0, linkIndex + 1);
mnemonics = newMnemonics;
}
return result.toString ();
}
int parseMnemonics (char[] buffer, int start, int end, StringBuffer result) {
int mnemonic = -1, index = start;
while (index < end) {
if (buffer [index] == '&') {
if (index + 1 < end && buffer [index + 1] == '&') {
result.append (buffer [index]);
index++;
} else {
mnemonic = result.length();
}
} else {
result.append (buffer [index]);
}
index++;
}
return mnemonic;
}
void updateBackground () {
NSColor nsColor = null;
if (backgroundImage != null) {
nsColor = NSColor.colorWithPatternImage(backgroundImage.handle);
} else if (background != null) {
nsColor = NSColor.colorWithDeviceRed(background[0], background[1], background[2], background[3]);
}
setBackground(nsColor);
}
void setBackground(NSColor nsColor) {
NSTextView widget = (NSTextView)view;
if (nsColor == null) {
widget.setDrawsBackground(false);
} else {
widget.setDrawsBackground(true);
widget.setBackgroundColor (nsColor);
}
}
void setFont(NSFont font) {
((NSTextView) view).setFont(font);
}
void setForeground (float /*double*/ [] color) {
if (!getEnabled ()) return;
NSColor nsColor;
if (color == null) {
nsColor = NSColor.textColor ();
} else {
nsColor = NSColor.colorWithDeviceRed (color [0], color [1], color [2], 1);
}
((NSTextView) view).setTextColor (nsColor);
}
/**
* Sets the receiver's text.
* <p>
* The string can contain both regular text and hyperlinks. A hyperlink
* is delimited by an anchor tag, &lt;A&gt; and &lt;/A&gt;. 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 (").
* </p>
*
* @param string the new text
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the text is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setText (String string) {
checkWidget ();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
if (string.equals (text)) return;
text = string;
NSTextView widget = (NSTextView)view;
widget.setString(NSString.stringWith(parse(string)));
NSTextStorage textStorage = widget.textStorage();
NSRange range = new NSRange();
for (int i = 0; i < offsets.length; i++) {
range.location = offsets[i].x;
range.length = offsets[i].y - offsets[i].x + 1;
textStorage.addAttribute(OS.NSLinkAttributeName, NSString.stringWith(ids[i]), range);
}
}
void setZOrder () {
super.setZOrder ();
if (scrollView != null) scrollView.setDocumentView (view);
}
NSView topView () {
return scrollView;
}
void updateCursorRects (boolean enabled) {
super.updateCursorRects (enabled);
if (scrollView == null) return;
updateCursorRects (enabled, scrollView);
NSClipView contentView = scrollView.contentView ();
updateCursorRects (enabled, contentView);
contentView.setDocumentCursor (enabled ? NSCursor.IBeamCursor () : null);
}
//int traversalCode (int key, int theEvent) {
// if (offsets.length == 0) return 0;
// int bits = super.traversalCode (key, theEvent);
// if (key == 48 /* Tab */ && theEvent != 0) {
// int [] modifiers = new int [1];
// OS.GetEventParameter (theEvent, OS.kEventParamKeyModifiers, OS.typeUInt32, null, 4, null, modifiers);
// boolean next = (modifiers [0] & OS.shiftKey) == 0;
// if (next && focusIndex < offsets.length - 1) {
// return bits & ~ SWT.TRAVERSE_TAB_NEXT;
// }
// if (!next && focusIndex > 0) {
// return bits & ~ SWT.TRAVERSE_TAB_PREVIOUS;
// }
// }
// return bits;
//}
}