// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.widgets;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.Cursor;
import java.awt.Font;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import javax.swing.Icon;
import javax.swing.JLabel;
import javax.swing.SwingUtilities;
import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
import org.openstreetmap.josm.tools.OpenBrowser;
import org.openstreetmap.josm.tools.Utils;
/**
* Label that contains a clickable link.
* @since 6340
*/
public class UrlLabel extends JLabel implements MouseListener {
private String url = "";
private String description = "";
/**
* Constructs a new empty {@code UrlLabel}.
*/
public UrlLabel() {
init("", "", 0);
}
/**
* Constructs a new {@code UrlLabel} for the given URL.
* @param url The URL to use, also used as description
*/
public UrlLabel(String url) {
this(url, url, 0);
}
/**
* Constructs a new {@code UrlLabel} for the given URL and font increase.
* @param url The URL to use, also used as description
* @param fontPlus The font increase in 1/72 of an inch units.
*/
public UrlLabel(String url, int fontPlus) {
this(url, url, fontPlus);
}
/**
* Constructs a new {@code UrlLabel} for the given URL and description.
* @param url The URL to use
* @param description The description to display
*/
public UrlLabel(String url, String description) {
this(url, description, 0);
}
/**
* Constructs a new {@code UrlLabel} for the given URL, description and image.
* @param url The URL to use
* @param description The description to display
* @param image The image to be displayed by the label instead of text
* @since 14822
*/
public UrlLabel(String url, String description, Icon image) {
super(image);
init(url, description, 0);
}
/**
* Constructs a new {@code UrlLabel} for the given URL, description and font increase.
* @param url The URL to use
* @param description The description to display
* @param fontPlus The font increase in 1/72 of an inch units.
*/
public UrlLabel(String url, String description, int fontPlus) {
init(url, description, fontPlus);
}
private void init(String url, String description, int fontPlus) {
addMouseListener(this);
setUrl(url);
setDescription(description);
if (fontPlus != 0) {
setFont(getFont().deriveFont(Font.PLAIN, (float) getFont().getSize()+fontPlus));
}
refresh();
}
protected final void refresh() {
if (!Utils.isEmpty(url)) {
refresh("" + description + "",
Cursor.getPredefinedCursor(Cursor.HAND_CURSOR),
String.format("%s
%s", url, tr("Right click = copy to clipboard")));
} else {
refresh("" + description + "", null, null);
}
}
private void refresh(String text, Cursor cursor, String tooltip) {
boolean hasImage = getIcon() != null;
if (!hasImage) {
setText(text);
}
setCursor(cursor);
setToolTipText(tooltip);
}
/**
* Sets the URL to be visited if the user clicks on this URL label.
* If null or empty, the label turns into a normal label without hyperlink.
*
* @param url the url. Can be null.
*/
public final void setUrl(String url) {
this.url = url;
refresh();
}
/**
* Sets the text part of the URL label. Defaults to the empty string if description is null.
*
* @param description the description
*/
public final void setDescription(String description) {
setDescription(description, true);
}
/**
* Sets the text part of the URL label. Defaults to the empty string if description is null.
*
* @param description the description
* @param escapeReservedCharacters if {@code true}, HTML reserved characters will be escaped
* @since 13853
*/
public final void setDescription(String description, boolean escapeReservedCharacters) {
this.description = description == null ? "" : description;
if (escapeReservedCharacters) {
this.description = Utils.escapeReservedCharactersHTML(this.description);
}
refresh();
}
@Override
public void mouseClicked(MouseEvent e) {
if (!Utils.isEmpty(url)) {
if (SwingUtilities.isLeftMouseButton(e)) {
OpenBrowser.displayUrl(url);
} else if (SwingUtilities.isRightMouseButton(e)) {
ClipboardUtils.copyString(url);
}
}
}
@Override
public void mousePressed(MouseEvent e) {
// Ignored
}
@Override
public void mouseEntered(MouseEvent e) {
// Ignored
}
@Override
public void mouseExited(MouseEvent e) {
// Ignored
}
@Override
public void mouseReleased(MouseEvent e) {
// Ignored
}
}