org.devzendo.commonapp.gui.GUIUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CommonGui Show documentation
Common application GUI code (Apache License v2) 2008-2013 Matt Gumbley, DevZendo.org
The newest version!
/**
 * Copyright (C) 2008-2010 Matt Gumbley, DevZendo.org 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.devzendo.commonapp.gui;

import java.awt.Color;
import java.awt.Component;
import java.lang.reflect.InvocationTargetException;

import javax.swing.JTextArea;
import javax.swing.SwingUtilities;

import org.apache.log4j.Logger;

/**
 * Various GUI utilitiy toolkit methods.
 * 
 * @author matt
 *
 */
public final class GUIUtils {
    private static final Logger LOGGER = Logger.getLogger(GUIUtils.class);
   
    private GUIUtils() {
        super();
    }
   
    /**
     * Pass a Runnable to be run immediately on the event thread. If we're
     * already on the event thread, run it immediately.
     * @param run the Runnable to run.
     */
    public static void runOnEventThread(final Runnable run) {
        if (SwingUtilities.isEventDispatchThread()) {
            run.run();
        } else {
            try {
                SwingUtilities.invokeAndWait(run);
            } catch (final InterruptedException e) {
                LOGGER.warn(run.getClass().getSimpleName() + " was interrupted", e);
            } catch (final InvocationTargetException e) {
                LOGGER.warn("InvocationTargetExcpetion running " + run.getClass().getSimpleName() + ": " + e.getMessage(), e);
            }
        }
    }
    
    /**
     * Start a Runnable on the event thread and wait for it to complete.
     * If we're already on the event thread, run it immediately.
     * @param run the Runnable to run.
     */
    public static void invokeLaterOnEventThread(final Runnable run) {
        if (SwingUtilities.isEventDispatchThread()) {
            run.run();
        } else {
            SwingUtilities.invokeLater(run);
        }
    }
    

    private static final double FACTOR = 0.92;

    /**
     * Compute a colour slightly darker than the one passed in
     * @param color a colour
     * @return a shade darker
     */
    public static Color slightlyDarkerColor(final Color color) {
        return new Color(Math.max((int) (color.getRed() * FACTOR), 0), 
                 Math.max((int) (color.getGreen() * FACTOR), 0),
                 Math.max((int) (color.getBlue() * FACTOR), 0));
    }
    
    /**
     * Creates a JTextArea that's not editable, suitable for copying text from,
     * but with the background colour the same as some parent component, into
     * which client code will add the JTextArea. (By default, the background
     * colour would possibly lead the user to think they could edit the text)
     * 
     * @param parent the parent component
     * @return the JTextArea
     */
    public static JTextArea createNonEditableJTextAreaWithParentBackground(final Component parent) {
        final JTextArea textArea = new JTextArea();
        textArea.setEditable(false);
        textArea.setBackground(parent.getBackground());
        return textArea;
    }
}