sim.util.gui.Utilities Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mason Show documentation
MASON is a fast discrete-event multiagent simulation library core in Java, designed to be the foundation for large custom-purpose Java simulations, and also to provide more than enough functionality for many lightweight simulation needs. MASON contains both a model library and an optional suite of visualization tools in 2D and 3D.
The newest version!
/*
  Copyright 2006 by Sean Luke and George Mason University
  Licensed under the Academic Free License version 3.0
  See the file "LICENSE" for more information
*/

package sim.util.gui;
import java.awt.*;
import javax.swing.*;
import java.io.*;

/** Various static utility methods. */

public class Utilities
    {
    /* Returns the integer floor of a double, or as close as possible. 
       The return value of NaN is undefined: it's often zero but doesn't
       have to be.  This is about twice as fast as (int)Math.floor(d) up through at least Java6. */
    private static int iFloor(double d)
        {
        int i = (int) d;
        if (d >= 0) return i;  // positives and zero
        else if (d < (Integer.MIN_VALUE + 1))  // handles the fact that negative integer range is one bigger than the positive integer range
            return Integer.MIN_VALUE;
        else if (i == d) return i;      // integer negatives
        else return i - 1;                      // non-integer negatives
        }
        
    /* Returns the integer ceiling of a double, or as close as possible. 
       The return value of NaN is undefined: it's often zero but doesn't
       have to be.  This is about twice as fast as (int)Math.ceil(d) up through at least Java6.   */
    private static int iCeil(double d)
        {
        int i = (int) d;
        if (d <= 0) return i;  // negatives and zero -- pretty because doubles pushed to ints don't go lower than the min int range
        else if (d >= (Integer.MAX_VALUE))
            return Integer.MAX_VALUE;
        else if (i == d) return i;  // integer positives
        else return (i + 1);            // non-integer positives
        }
        
    /* Returns the integer floor of a double, or as close as possible. 
       The return value of NaN is undefined: it's often zero but doesn't
       have to be.  This is about twice as fast as (int)Math.round(d), though it can't get inlined because it's 40 bytes.  :-( */
    private static int iRound(double d)
        {
        d += 0.5;               // same protocol as Math.round, see its documentation
        int i = (int) d;
        if (d >= 0) return i;  // positives and zero
        else if (d < (Integer.MIN_VALUE + 1))  // handles the fact that negative integer range is one bigger than the positive integer range
            return Integer.MIN_VALUE;
        else if (i == d) return i;      // integer negatives
        else return i - 1;                      // non-integer negatives
        }

    /** Returns a filename guaranteed to end with the given ending. */
    public static String ensureFileEndsWith(String filename, String ending)
        {
        // do we end with the string?
        if (filename.regionMatches(false,filename.length()-ending.length(),ending,0,ending.length()))
            return filename;
        else return filename + ending;
        }
                
    /** Does a repaint that is guaranteed to work (on some systems, plain repaint())
        fails if there's lots of updates going on as is the case in our simulator thread.  Notably,
        MacOS X 1.3.1 has problems. */
    public static void doEnsuredRepaint(final Component component)
        {
        SwingUtilities.invokeLater(new Runnable()
            {
            public void run()
                {
                if (component!=null) component.repaint();
                }
            });
        }
                
    /** Schedule something to occur at some specified point in the future in the Swing Event thread. */
    public static Thread doLater(final long milliseconds, final Runnable doThis)
        {
        Thread thread = new Thread(new Runnable()
            {
            public void run()
                {
                try
                    {
                    Thread.sleep(milliseconds);
                    SwingUtilities.invokeAndWait(doThis);
                    }
                catch (InterruptedException e) { /* shouldn't happen -- we could do an invokeAndWait in case tho */ }
                catch (java.lang.reflect.InvocationTargetException e) { /* shouldn't happen */ }
                }
            });
        thread.start();
        return thread;
        }
                
    static final int DIALOG_WIDTH = 400;  // in pixels
    static final int TRACE_FRAME_WIDTH = 600;
    static final int TRACE_FRAME_HEIGHT = 400;
    
    /** Pops up an error dialog box.  error should be the error proper, and description should
        be some user-informative item that's shown first (the user must explicitly ask to be shown
        the raw error itself).  frame is a window on which the error box should be centered: if it
        is null, the error box will be centered in the screen. The error is also printed to the console.  */
    
    public static void informOfError(Throwable error, String description, JFrame frame)
        {
        error.printStackTrace();
        Object[] options = { "Show Trace", "Okay" };
        JLabel label = new JLabel();
        Font labelFont = label.getFont();
        Font boldFont = labelFont.deriveFont(Font.BOLD);
        FontMetrics boldFontMetrics = label.getFontMetrics(boldFont);
        Font smallFont = labelFont.deriveFont(labelFont.getSize2D() - 2.0f);
        //FontMetrics smallFontMetrics = label.getFontMetrics(smallFont);
        
        label.setText(""+
            WordWrap.toHTML(WordWrap.wrap(""+description, DIALOG_WIDTH, boldFontMetrics)) + "" + 
            "" +
            error + "");
        int n = JOptionPane.showOptionDialog(frame, label, "Error",
            JOptionPane.YES_NO_OPTION,  
            JOptionPane.ERROR_MESSAGE,  
            null,   
            //don't use a custom Icon
            options, //the titles of buttons
            options[1]); //default button title
        if (n == 0)
            {
            StringWriter writer = new StringWriter();
            PrintWriter pWriter = new PrintWriter(writer);
            error.printStackTrace(pWriter);
            pWriter.flush();
            JTextArea area = new JTextArea(writer.toString());
            area.setFont(new Font("Monospaced",Font.PLAIN,12));
            JScrollPane pane = new JScrollPane(area)
                {
                public Dimension getPreferredSize()
                    {
                    return new Dimension(TRACE_FRAME_WIDTH,TRACE_FRAME_HEIGHT);
                    }
                public Dimension getMinimumSize()
                    {
                    return new Dimension(TRACE_FRAME_WIDTH,TRACE_FRAME_HEIGHT);
                    }
                };
            JOptionPane.showMessageDialog(null, pane);
            }
        }

    /** Pops up an message dialog box.  frame is a window on which the error box should be centered: if it
        is null, the error box will be centered in the screen. The error is also printed to the console.  */
    
    public static void inform(String description, String subDescription, JFrame frame)
        {
        //Object[] options = { "Okay" };
        JLabel label = new JLabel();
        Font labelFont = label.getFont();
        Font boldFont = labelFont.deriveFont(Font.BOLD);
        FontMetrics boldFontMetrics = label.getFontMetrics(boldFont);
        Font smallFont = labelFont.deriveFont(labelFont.getSize2D() - 2.0f);
        FontMetrics smallFontMetrics = label.getFontMetrics(smallFont);

        label.setText(""+
            WordWrap.toHTML(WordWrap.wrap(""+description, DIALOG_WIDTH, boldFontMetrics)) + "" + 
            "" +
            WordWrap.toHTML(WordWrap.wrap(""+subDescription, DIALOG_WIDTH, smallFontMetrics))  + "");
        JOptionPane.showMessageDialog(frame, label, "Error",
            JOptionPane.INFORMATION_MESSAGE);
        }

    }