bundles/org.eclipse.wst.wsdl.ui/src/org/eclipse/wst/wsdl/ui/internal/util/flatui/HyperlinkHandler.java

/*******************************************************************************
 * Copyright (c) 2001, 2004 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.wst.wsdl.ui.internal.util.flatui;

import java.util.Enumeration;
import java.util.Hashtable;

import org.eclipse.swt.SWT;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.MouseListener;
import org.eclipse.swt.events.MouseTrackListener;
import org.eclipse.swt.events.PaintEvent;
import org.eclipse.swt.events.PaintListener;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;

public class HyperlinkHandler implements MouseListener, MouseTrackListener, PaintListener {

  	public static final int UNDERLINE_NEVER = 1;
    public static final int UNDERLINE_ROLLOVER = 2;
    public static final int UNDERLINE_ALWAYS = 3;

    private static Cursor hyperlinkCursor;
    private static Cursor busyCursor;
    private boolean hyperlinkCursorUsed=true;
    private int hyperlinkUnderlineMode=UNDERLINE_ALWAYS;
    private Color background;
    private Color foreground;
    private Color activeBackground;
    private Color activeForeground;
    private Hashtable hyperlinkListeners;
    private Control lastLink;

public HyperlinkHandler() {
    hyperlinkListeners = new Hashtable();
    if (hyperlinkCursor == null)
    {
      hyperlinkCursor = new Cursor(Display.getCurrent(), SWT.CURSOR_HAND);
      busyCursor = new Cursor(Display.getCurrent(), SWT.CURSOR_WAIT);
    }
}
public void dispose() {
    hyperlinkCursor.dispose();
    busyCursor.dispose();
}
public org.eclipse.swt.graphics.Color getActiveBackground() {
    return activeBackground;
}
public org.eclipse.swt.graphics.Color getActiveForeground() {
    return activeForeground;
}
public org.eclipse.swt.graphics.Color getBackground() {
    return background;
}
public org.eclipse.swt.graphics.Cursor getBusyCursor() {
    return busyCursor;
}
public org.eclipse.swt.graphics.Color getForeground() {
    return foreground;
}
public org.eclipse.swt.graphics.Cursor getHyperlinkCursor() {
    return hyperlinkCursor;
}
public int getHyperlinkUnderlineMode() {
    return hyperlinkUnderlineMode;
}
public org.eclipse.swt.widgets.Control getLastLink() {
    return lastLink;
}
public boolean isHyperlinkCursorUsed() {
    return hyperlinkCursorUsed;
}
        public void mouseDoubleClick(MouseEvent e) {
        }
public void mouseDown(MouseEvent e) {
    if (e.button == 1)
        return;
    lastLink = (Control)e.widget;
}
public void mouseEnter(MouseEvent e) {
    Control control = (Control) e.widget;
    if (isHyperlinkCursorUsed())
        control.setCursor(hyperlinkCursor);
    if (activeBackground != null)
        control.setBackground(activeBackground);
    if (activeForeground != null)
        control.setForeground(activeForeground);
    if (hyperlinkUnderlineMode==UNDERLINE_ROLLOVER) underline(control, true);    

    IHyperlinkListener action =
        (IHyperlinkListener) hyperlinkListeners.get(control);
    if (action != null)
        action.linkEntered(control);
}
public void mouseExit(MouseEvent e) {
    Control control = (Control) e.widget;
    if (isHyperlinkCursorUsed())
        control.setCursor(null);
    if (hyperlinkUnderlineMode==UNDERLINE_ROLLOVER)
        underline(control, false);
    if (background != null)
        control.setBackground(background);
    if (foreground != null)
        control.setForeground(foreground);
    IHyperlinkListener action =
        (IHyperlinkListener) hyperlinkListeners.get(control);
    if (action != null)
        action.linkExited(control);
}
        public void mouseHover(MouseEvent e) {
        }
public void mouseUp(MouseEvent e) {
    if (e.button != 1)
        return;
    IHyperlinkListener action =
        (IHyperlinkListener) hyperlinkListeners.get(e.widget);
    if (action != null) {
        Control c = (Control) e.widget;
        c.setCursor(busyCursor);
        action.linkActivated(c);
        if (!c.isDisposed()) 
           c.setCursor(isHyperlinkCursorUsed()?hyperlinkCursor:null);
    }
}
public void paintControl(PaintEvent e) {
    Control label = (Control) e.widget;
    if (hyperlinkUnderlineMode == UNDERLINE_ALWAYS)
        HyperlinkHandler.underline(label, true);
}
public void registerHyperlink(Control control, IHyperlinkListener listener) {
    if (background != null)
        control.setBackground(background);
    if (foreground != null)
        control.setForeground(foreground);
    control.addMouseListener(this);
    control.addMouseTrackListener(this);
    if (hyperlinkUnderlineMode == UNDERLINE_ALWAYS)
        control.addPaintListener(this);
    hyperlinkListeners.put(control, listener);
    removeDisposedLinks();
}
private void removeDisposedLinks() {
    for (Enumeration keys = hyperlinkListeners.keys(); keys.hasMoreElements();) {
        Control control = (Control)keys.nextElement();
        if (control.isDisposed()) {
            hyperlinkListeners.remove(control);
        }
    }
}
public void reset() {
    hyperlinkListeners.clear();
}
public void setActiveBackground(org.eclipse.swt.graphics.Color newActiveBackground) {
    activeBackground = newActiveBackground;
}
public void setActiveForeground(org.eclipse.swt.graphics.Color newActiveForeground) {
    activeForeground = newActiveForeground;
}
public void setBackground(org.eclipse.swt.graphics.Color newBackground) {
    background = newBackground;
}
public void setForeground(org.eclipse.swt.graphics.Color newForeground) {
    foreground = newForeground;
}
public void setHyperlinkCursorUsed(boolean newHyperlinkCursorUsed) {
    hyperlinkCursorUsed = newHyperlinkCursorUsed;
}
public void setHyperlinkUnderlineMode(int newHyperlinkUnderlineMode) {
    hyperlinkUnderlineMode = newHyperlinkUnderlineMode;
}
public static void underline(Control control, boolean inside) {
    if (!(control instanceof Label))
        return;
    Composite parent = control.getParent();
    Rectangle bounds = control.getBounds();
    GC gc = new GC(parent);
    Color color = inside? control.getForeground() : control.getBackground();
    gc.setForeground(color);
    int y = bounds.y + bounds.height;
    gc.drawLine(bounds.x, y, bounds.x+bounds.width, y);
    gc.dispose();
}
}