src/Pure/GUI/gui.scala
author wenzelm
Fri Nov 30 14:46:00 2018 +0100 (12 months ago)
changeset 69377 81ae5893c556
parent 69376 53194e2a969d
child 69378 429426640596
permissions -rw-r--r--
use Isabelle fonts for all GUI look-and-feels;
     1 /*  Title:      Pure/GUI/gui.scala
     2     Author:     Makarius
     3 
     4 Basic GUI tools (for AWT/Swing).
     5 */
     6 
     7 package isabelle
     8 
     9 import java.lang.{ClassLoader, ClassNotFoundException, NoSuchMethodException}
    10 import java.awt.{Image, Component, Container, Toolkit, Window, Font, KeyboardFocusManager}
    11 import java.awt.font.{TextAttribute, TransformAttribute, FontRenderContext, LineMetrics}
    12 import java.awt.geom.AffineTransform
    13 import javax.swing.{ImageIcon, JOptionPane, UIManager, JLayeredPane, JFrame, JWindow, JDialog,
    14   JButton, JTextField, JLabel}
    15 
    16 import scala.swing.{ComboBox, TextArea, ScrollPane}
    17 import scala.swing.event.SelectionChanged
    18 
    19 
    20 object GUI
    21 {
    22   /* Swing look-and-feel */
    23 
    24   def find_laf(name: String): Option[String] =
    25     UIManager.getInstalledLookAndFeels().
    26       find(c => c.getName == name || c.getClassName == name).
    27       map(_.getClassName)
    28 
    29   def get_laf(): String =
    30     find_laf(System.getProperty("isabelle.laf")) getOrElse {
    31       if (Platform.is_windows || Platform.is_macos)
    32         UIManager.getSystemLookAndFeelClassName()
    33       else
    34         UIManager.getCrossPlatformLookAndFeelClassName()
    35     }
    36 
    37   def init_laf(): Unit = UIManager.setLookAndFeel(get_laf())
    38 
    39   def is_macos_laf(): Boolean =
    40     Platform.is_macos &&
    41     UIManager.getSystemLookAndFeelClassName() == UIManager.getLookAndFeel.getClass.getName
    42 
    43   def is_windows_laf(): Boolean =
    44     Platform.is_windows &&
    45     UIManager.getSystemLookAndFeelClassName() == UIManager.getLookAndFeel.getClass.getName
    46 
    47 
    48   /* plain focus traversal, notably for text fields */
    49 
    50   def plain_focus_traversal(component: Component)
    51   {
    52     val dummy_button = new JButton
    53     def apply(id: Int): Unit =
    54       component.setFocusTraversalKeys(id, dummy_button.getFocusTraversalKeys(id))
    55     apply(KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS)
    56     apply(KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS)
    57   }
    58 
    59 
    60   /* simple dialogs */
    61 
    62   def scrollable_text(raw_txt: String, width: Int = 60, height: Int = 20, editable: Boolean = false)
    63     : ScrollPane =
    64   {
    65     val txt = Output.clean_yxml(raw_txt)
    66     val text = new TextArea(txt)
    67     if (width > 0) text.columns = width
    68     if (height > 0 && split_lines(txt).length > height) text.rows = height
    69     text.editable = editable
    70     new ScrollPane(text)
    71   }
    72 
    73   private def simple_dialog(kind: Int, default_title: String,
    74     parent: Component, title: String, message: Iterable[Any])
    75   {
    76     GUI_Thread.now {
    77       val java_message =
    78         message.iterator.map({ case x: scala.swing.Component => x.peer case x => x }).
    79           toArray.asInstanceOf[Array[AnyRef]]
    80       JOptionPane.showMessageDialog(parent, java_message,
    81         if (title == null) default_title else title, kind)
    82     }
    83   }
    84 
    85   def dialog(parent: Component, title: String, message: Any*): Unit =
    86     simple_dialog(JOptionPane.PLAIN_MESSAGE, null, parent, title, message)
    87 
    88   def warning_dialog(parent: Component, title: String, message: Any*): Unit =
    89     simple_dialog(JOptionPane.WARNING_MESSAGE, "Warning", parent, title, message)
    90 
    91   def error_dialog(parent: Component, title: String, message: Any*): Unit =
    92     simple_dialog(JOptionPane.ERROR_MESSAGE, "Error", parent, title, message)
    93 
    94   def confirm_dialog(parent: Component, title: String, option_type: Int, message: Any*): Int =
    95     GUI_Thread.now {
    96       val java_message = message map { case x: scala.swing.Component => x.peer case x => x }
    97       JOptionPane.showConfirmDialog(parent,
    98         java_message.toArray.asInstanceOf[Array[AnyRef]], title,
    99           option_type, JOptionPane.QUESTION_MESSAGE)
   100     }
   101 
   102 
   103   /* zoom box */
   104 
   105   private val Zoom_Factor = "([0-9]+)%?".r
   106 
   107   abstract class Zoom_Box extends ComboBox[String](
   108     List("50%", "70%", "85%", "100%", "125%", "150%", "175%", "200%", "300%", "400%"))
   109   {
   110     def changed: Unit
   111     def factor: Int = parse(selection.item)
   112 
   113     private def parse(text: String): Int =
   114       text match {
   115         case Zoom_Factor(s) =>
   116           val i = Integer.parseInt(s)
   117           if (10 <= i && i < 1000) i else 100
   118         case _ => 100
   119       }
   120 
   121     private def print(i: Int): String = i.toString + "%"
   122 
   123     def set_item(i: Int) {
   124       peer.getEditor match {
   125         case null =>
   126         case editor => editor.setItem(print(i))
   127       }
   128     }
   129 
   130     makeEditable()(c => new ComboBox.BuiltInEditor(c)(text => print(parse(text)), x => x))
   131     peer.getEditor.getEditorComponent match {
   132       case text: JTextField => text.setColumns(4)
   133       case _ =>
   134     }
   135 
   136     selection.index = 3
   137 
   138     listenTo(selection)
   139     reactions += { case SelectionChanged(_) => changed }
   140   }
   141 
   142 
   143   /* tooltip with multi-line support */
   144 
   145   def tooltip_lines(text: String): String =
   146     if (text == null || text == "") null
   147     else "<html>" + HTML.output(text) + "</html>"
   148 
   149 
   150   /* icon */
   151 
   152   def isabelle_icon(): ImageIcon =
   153     new ImageIcon(getClass.getClassLoader.getResource("isabelle/isabelle_transparent-32.gif"))
   154 
   155   def isabelle_icons(): List[ImageIcon] =
   156     for (icon <- List("isabelle/isabelle_transparent-32.gif", "isabelle/isabelle_transparent.gif"))
   157       yield new ImageIcon(getClass.getClassLoader.getResource(icon))
   158 
   159   def isabelle_image(): Image = isabelle_icon().getImage
   160 
   161 
   162   /* component hierachy */
   163 
   164   def get_parent(component: Component): Option[Container] =
   165     component.getParent match {
   166       case null => None
   167       case parent => Some(parent)
   168     }
   169 
   170   def ancestors(component: Component): Iterator[Container] = new Iterator[Container] {
   171     private var next_elem = get_parent(component)
   172     def hasNext(): Boolean = next_elem.isDefined
   173     def next(): Container =
   174       next_elem match {
   175         case Some(parent) =>
   176           next_elem = get_parent(parent)
   177           parent
   178         case None => Iterator.empty.next()
   179       }
   180   }
   181 
   182   def parent_window(component: Component): Option[Window] =
   183     ancestors(component).collectFirst({ case x: Window => x })
   184 
   185   def layered_pane(component: Component): Option[JLayeredPane] =
   186     parent_window(component) match {
   187       case Some(w: JWindow) => Some(w.getLayeredPane)
   188       case Some(w: JFrame) => Some(w.getLayeredPane)
   189       case Some(w: JDialog) => Some(w.getLayeredPane)
   190       case _ => None
   191     }
   192 
   193   def traverse_components(component: Component, apply: Component => Unit)
   194   {
   195     def traverse(comp: Component)
   196     {
   197       apply(comp)
   198       comp match {
   199         case cont: Container =>
   200           for (i <- 0 until cont.getComponentCount)
   201             traverse(cont.getComponent(i))
   202         case _ =>
   203       }
   204     }
   205     traverse(component)
   206   }
   207 
   208 
   209   /* font operations */
   210 
   211   def copy_font(font: Font): Font =
   212     if (font == null) null
   213     else new Font(font.getFamily, font.getStyle, font.getSize)
   214 
   215   def line_metrics(font: Font): LineMetrics =
   216     font.getLineMetrics("", new FontRenderContext(null, false, false))
   217 
   218   def transform_font(font: Font, transform: AffineTransform): Font =
   219   {
   220     import scala.collection.JavaConversions._
   221     font.deriveFont(Map(TextAttribute.TRANSFORM -> new TransformAttribute(transform)))
   222   }
   223 
   224   def font(family: String = Isabelle_Fonts.sans, size: Int = 1, bold: Boolean = false): Font =
   225     new Font(family, if (bold) Font.BOLD else Font.PLAIN, size)
   226 
   227   def label_font(): Font = (new JLabel).getFont
   228 
   229 
   230   /* Isabelle fonts */
   231 
   232   def imitate_font(font: Font,
   233     family: String = Isabelle_Fonts.sans,
   234     scale: Double = 1.0): Font =
   235   {
   236     val font1 = new Font(family, font.getStyle, font.getSize)
   237     val rel_size = line_metrics(font).getHeight.toDouble / line_metrics(font1).getHeight
   238     new Font(family, font.getStyle, (scale * rel_size * font.getSize).toInt)
   239   }
   240 
   241   def imitate_font_css(font: Font,
   242     family: String = Isabelle_Fonts.sans,
   243     scale: Double = 1.0): String =
   244   {
   245     val font1 = new Font(family, font.getStyle, font.getSize)
   246     val rel_size = line_metrics(font).getHeight.toDouble / line_metrics(font1).getHeight
   247     "font-family: " + family + "; font-size: " + (scale * rel_size * 100).toInt + "%;"
   248   }
   249 
   250   def use_isabelle_fonts()
   251   {
   252     val default_font = label_font()
   253     val ui = UIManager.getDefaults
   254     for (prop <- List("Label.font", "TextArea.font", "TextPane.font", "Tooltip.font", "Tree.font"))
   255     {
   256       val font = ui.get(prop) match { case font: Font => font case _ => default_font }
   257       ui.put(prop, GUI.imitate_font(font))
   258     }
   259   }
   260 }