src/Pure/GUI/wrap_panel.scala
author wenzelm
Wed, 12 Mar 2025 11:39:00 +0100
changeset 82265 4b875a4c83b0
parent 78243 0e221a8128e4
permissions -rw-r--r--
update for release;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
53783
f5e9d182f645 clarified location of GUI modules (which depend on Swing of JFX);
wenzelm
parents: 53713
diff changeset
     1
/*  Title:      Pure/GUI/wrap_panel.scala
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     3
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     4
Panel with improved FlowLayout for wrapping of components over
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     5
multiple lines, see also
68224
1f7308050349 prefer HTTPS;
wenzelm
parents: 66206
diff changeset
     6
https://tips4java.wordpress.com/2008/11/06/wrap-layout/ and
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     7
scala.swing.FlowPanel.
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     8
*/
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
     9
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    10
package isabelle
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    11
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    12
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    13
import java.awt.{FlowLayout, Container, Dimension}
53713
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    14
import javax.swing.{JComponent, JPanel, JScrollPane}
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    15
53713
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    16
import scala.swing.{Panel, FlowPanel, Component, SequentialContainer, ScrollPane}
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    17
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    18
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
    19
object Wrap_Panel {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    20
  val Alignment = FlowPanel.Alignment
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    21
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    22
  class Layout(align: Int = FlowLayout.CENTER, hgap: Int = 5, vgap: Int = 5)
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
    23
      extends FlowLayout(align: Int, hgap: Int, vgap: Int) {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    24
    override def preferredLayoutSize(target: Container): Dimension =
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    25
      layout_size(target, true)
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    26
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
    27
    override def minimumLayoutSize(target: Container): Dimension = {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    28
      val minimum = layout_size(target, false)
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    29
      minimum.width -= (getHgap + 1)
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    30
      minimum
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    31
    }
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    32
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
    33
    private def layout_size(target: Container, preferred: Boolean): Dimension = {
75380
2cb2606ce075 tuned: avoid problems with scala3;
wenzelm
parents: 73340
diff changeset
    34
      target.getTreeLock.synchronized {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    35
        val target_width =
78243
0e221a8128e4 tuned: prefer Scala over Java;
wenzelm
parents: 75393
diff changeset
    36
          if (target.getSize.width == 0) Int.MaxValue
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    37
          else target.getSize.width
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    38
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    39
        val hgap = getHgap
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    40
        val vgap = getVgap
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    41
        val insets = target.getInsets
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    42
        val horizontal_insets_and_gap = insets.left + insets.right + (hgap * 2)
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    43
        val max_width = target_width - horizontal_insets_and_gap
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    44
53713
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    45
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    46
        /* fit components into rows */
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    47
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    48
        val dim = new Dimension(0, 0)
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    49
        var row_width = 0
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    50
        var row_height = 0
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
    51
        def add_row(): Unit = {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    52
          dim.width = dim.width max row_width
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    53
          if (dim.height > 0) dim.height += vgap
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    54
          dim.height += row_height
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    55
        }
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    56
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    57
        for {
56356
c3dbaa155ece tuned for-comprehensions -- less structure mapping;
wenzelm
parents: 53853
diff changeset
    58
          i <- (0 until target.getComponentCount).iterator
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    59
          m = target.getComponent(i)
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    60
          if m.isVisible
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    61
          d = if (preferred) m.getPreferredSize else m.getMinimumSize()
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
    62
        } {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    63
          if (row_width + d.width > max_width) {
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    64
            add_row()
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    65
            row_width = 0
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    66
            row_height = 0
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    67
          }
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    68
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    69
          if (row_width != 0) row_width += hgap
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    70
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    71
          row_width += d.width
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    72
          row_height = row_height max d.height
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    73
        }
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    74
        add_row()
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    75
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    76
        dim.width += horizontal_insets_and_gap
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    77
        dim.height += insets.top + insets.bottom + vgap * 2
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    78
53713
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    79
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    80
        /* special treatment for ScrollPane */
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    81
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    82
        val scroll_pane =
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    83
          GUI.ancestors(target).exists(
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    84
            {
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    85
              case _: JScrollPane => true
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    86
              case c: JComponent if Component.wrap(c).isInstanceOf[ScrollPane] => true
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    87
              case _ => false
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    88
            })
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    89
        if (scroll_pane && target.isValid)
bb15972a644d improved layout, with special treatment for ScrollPane;
wenzelm
parents: 53711
diff changeset
    90
          dim.width -= (hgap + 1)
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    91
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    92
        dim
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    93
      }
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    94
    }
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
    95
  }
66205
e9fa94f43a15 tuned signature;
wenzelm
parents: 60033
diff changeset
    96
e9fa94f43a15 tuned signature;
wenzelm
parents: 60033
diff changeset
    97
  def apply(contents: List[Component] = Nil,
66206
2d2082db735a clarified defaults;
wenzelm
parents: 66205
diff changeset
    98
      alignment: Alignment.Value = Alignment.Right): Wrap_Panel =
66205
e9fa94f43a15 tuned signature;
wenzelm
parents: 60033
diff changeset
    99
    new Wrap_Panel(contents, alignment)
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   100
}
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   101
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
   102
class Wrap_Panel(
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
   103
  contents0: List[Component] = Nil,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
   104
  alignment: Wrap_Panel.Alignment.Value = Wrap_Panel.Alignment.Right)
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75380
diff changeset
   105
extends Panel with SequentialContainer.Wrapper {
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   106
  override lazy val peer: JPanel =
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   107
    new JPanel(new Wrap_Panel.Layout(alignment.id)) with SuperMixin
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   108
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   109
  contents ++= contents0
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   110
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   111
  private def layoutManager = peer.getLayout.asInstanceOf[Wrap_Panel.Layout]
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   112
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   113
  def vGap: Int = layoutManager.getVgap
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 68224
diff changeset
   114
  def vGap_=(n: Int): Unit = layoutManager.setVgap(n)
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   115
  def hGap: Int = layoutManager.getHgap
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 68224
diff changeset
   116
  def hGap_=(n: Int): Unit = layoutManager.setHgap(n)
53711
8ce7795256e1 improved FlowLayout for wrapping of components over multiple lines;
wenzelm
parents:
diff changeset
   117
}