ComponentGaugeUtil.java

/*
Copyright 2011, Aiki IT, FotoRenamer
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 de.aikiit.fotorenamer.util;

import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;

import javax.swing.ImageIcon;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Toolkit;

/**
 * Helper class to center Swing-components.
 *
 * @author hirsch, 20.10.2003
 * @version 2003-10-22
 */
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class ComponentGaugeUtil {
    /**
     * Logger for this class.
     */
    private static final Logger LOG =
            LogManager.getLogger(ComponentGaugeUtil.class);

    /**
     * Gauge the given component on screen.
     *
     * @param component Swing-component to gauge.
     */
    public static void makeCentered(final Component component) {
        Toolkit toolkit = Toolkit.getDefaultToolkit();
        Dimension dim = toolkit.getScreenSize();
        int screenWidth = dim.width;
        int screenHeight = dim.height;
        component.setLocation((screenWidth - component.getSize().width) / 2,
                (screenHeight - component.getSize().height) / 2);
    }

    /**
     * Helper that transforms a given path into an ImageIcon. In case of errors
     * <code>null</code> is returned.
     *
     * @param path File path that is to be converted into an icon.
     * @return ImageIcon, located at the given path.
     */
    public static ImageIcon createImageIcon(final String path) {
        assert path != null : "Path for image icon needs to be set.";
        LOG.debug("Creating image icon from path {}", path);
        java.net.URL imgURL = ComponentGaugeUtil.class.getResource(path);
        LOG.debug("extracted URL is: {}", imgURL);

        if (imgURL != null) {
            return new ImageIcon(imgURL);
        } else {
            LOG.error("Could not generate a valid URL from the given path: {}", path);
            return null;
        }
    }
}