X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FJvSwingUtils.java;h=e7f992dd37faff03ba188e5f32600d10a4a1a75e;hb=afe4b88500a5d61bc8d312909cfdde2b7cdd53df;hp=c420dc0682cb596bd1669dd92393e7146467f423;hpb=47168f025aefdaa044802bd5f8f510ffe43a4808;p=jalview.git
diff --git a/src/jalview/gui/JvSwingUtils.java b/src/jalview/gui/JvSwingUtils.java
index c420dc0..e7f992d 100644
--- a/src/jalview/gui/JvSwingUtils.java
+++ b/src/jalview/gui/JvSwingUtils.java
@@ -1,6 +1,6 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
@@ -20,18 +20,33 @@
*/
package jalview.gui;
+import java.awt.BorderLayout;
import java.awt.Color;
+import java.awt.Component;
import java.awt.Font;
+import java.awt.GridLayout;
import java.awt.Rectangle;
import java.awt.event.ActionListener;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.List;
+import java.util.Objects;
+import javax.swing.AbstractButton;
+import javax.swing.BorderFactory;
import javax.swing.JButton;
+import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
+import javax.swing.JScrollBar;
import javax.swing.SwingConstants;
+import javax.swing.border.Border;
+import javax.swing.border.TitledBorder;
+
+import jalview.util.MessageManager;
/**
* useful functions for building Swing GUIs
@@ -42,26 +57,55 @@ import javax.swing.SwingConstants;
public final class JvSwingUtils
{
/**
- * wrap a bare html safe string to around 60 characters per line using a
- *
- *
- * | field
+ * wrap a bare html safe string to around 60 characters per line using a CSS
+ * style class specifying word-wrap and break-word
*
+ * @param enclose
+ * if true, add <html> wrapper tags
* @param ttext
+ *
* @return
*/
- public static String wrapTooltip(String ttext)
+ public static String wrapTooltip(boolean enclose, String ttext)
{
- if (ttext.length() < 60)
+ Objects.requireNonNull(ttext,
+ "Tootip text to format must not be null!");
+ ttext = ttext.trim();
+ boolean maxLengthExceeded = false;
+
+ if (ttext.contains("
"))
{
- return ttext;
+ String[] htmllines = ttext.split("
");
+ for (String line : htmllines)
+ {
+ maxLengthExceeded = line.length() > 60;
+ if (maxLengthExceeded)
+ {
+ break;
+ }
+ }
}
else
{
- return "";
+ maxLengthExceeded = ttext.length() > 60;
+ }
+
+ if (!maxLengthExceeded)
+ {
+ return enclose ? "" + ttext + "" : ttext;
}
- }
+
+ return (enclose ? "" : "")
+ // BH 2018
+ + ""
+ // + "
"
+ + ttext + "
"
+ // + ""
+ + ((enclose ? "" : ""));
+ }
+
public static JButton makeButton(String label, String tooltip,
ActionListener action)
{
@@ -89,8 +133,8 @@ public final class JvSwingUtils
for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
{
if (menu.getMenuComponent(i) instanceof JMenu
- && ((JMenu) menu.getMenuComponent(i)).getText().equals(
- submenu))
+ && ((JMenu) menu.getMenuComponent(i)).getText()
+ .equals(submenu))
{
submenuinstance = (JMenu) menu.getMenuComponent(i);
}
@@ -116,14 +160,12 @@ public final class JvSwingUtils
public static JPanel addtoLayout(JPanel panel, String tooltip,
JComponent label, JComponent valBox)
{
- JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
- // laypanel.setSize(panel.getPreferredSize());
- // laypanel.setLayout(null);
+ JPanel laypanel = new JPanel(new GridLayout(1, 2));
+ JPanel labPanel = new JPanel(new BorderLayout());
+ JPanel valPanel = new JPanel();
labPanel.setBounds(new Rectangle(7, 7, 158, 23));
valPanel.setBounds(new Rectangle(172, 7, 270, 23));
- // labPanel.setLayout(new GridLayout(1,1));
- // valPanel.setLayout(new GridLayout(1,1));
- labPanel.add(label);
+ labPanel.add(label, BorderLayout.WEST);
valPanel.add(valBox);
laypanel.add(labPanel);
laypanel.add(valPanel);
@@ -170,8 +212,10 @@ public final class JvSwingUtils
public static Font getLabelFont(boolean bold, boolean italic)
{
- return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
- : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
+ return new java.awt.Font("Verdana",
+ (!bold && !italic) ? Font.PLAIN
+ : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0),
+ 11);
}
/**
@@ -206,4 +250,139 @@ public final class JvSwingUtils
}
}
+ /**
+ * Returns the proportion of its range that a scrollbar's position represents,
+ * as a value between 0 and 1. For example if the whole range is from 0 to
+ * 200, then a position of 40 gives proportion = 0.2.
+ *
+ * @see http://www.javalobby.org/java/forums/t33050.html#91885334
+ *
+ * @param scroll
+ * @return
+ */
+ public static float getScrollBarProportion(JScrollBar scroll)
+ {
+ /*
+ * The extent (scroll handle width) deduction gives the true operating range
+ * of possible positions.
+ */
+ int possibleRange = scroll.getMaximum() - scroll.getMinimum()
+ - scroll.getModel().getExtent();
+ float valueInRange = scroll.getValue()
+ - (scroll.getModel().getExtent() / 2f);
+ float proportion = valueInRange / possibleRange;
+ return proportion;
+ }
+
+ /**
+ * Returns the scroll bar position in its range that would match the given
+ * proportion (between 0 and 1) of the whole. For example if the whole range
+ * is from 0 to 200, then a proportion of 0.25 gives position 50.
+ *
+ * @param scrollbar
+ * @param proportion
+ * @return
+ */
+ public static int getScrollValueForProportion(JScrollBar scrollbar,
+ float proportion)
+ {
+ /*
+ * The extent (scroll handle width) deduction gives the true operating range
+ * of possible positions.
+ */
+ float fraction = proportion
+ * (scrollbar.getMaximum() - scrollbar.getMinimum()
+ - scrollbar.getModel().getExtent())
+ + (scrollbar.getModel().getExtent() / 2f);
+ return Math.min(Math.round(fraction), scrollbar.getMaximum());
+ }
+
+ public static void jvInitComponent(AbstractButton comp, String i18nString)
+ {
+ setColorAndFont(comp);
+ if (i18nString != null && !i18nString.isEmpty())
+ {
+ comp.setText(MessageManager.getString(i18nString));
+ }
+ }
+
+ public static void jvInitComponent(JComponent comp)
+ {
+ setColorAndFont(comp);
+ }
+
+ private static void setColorAndFont(JComponent comp)
+ {
+ comp.setBackground(Color.white);
+ comp.setFont(JvSwingUtils.getLabelFont());
+ }
+
+ /**
+ * A helper method to build a drop-down choice of values, with tooltips for
+ * the entries
+ *
+ * @param entries
+ * @param tooltips
+ */
+ public static JComboBox