org.devzendo.commonapp.gui.WindowGeometryStore 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.Rectangle;

import javax.swing.JFrame;

import org.apache.log4j.Logger;


/**
 * Stores the geometry of Windows in the Prefs, and allows
 * them to be restored on creation.
 * 
 * @author matt
 *
 */
public final class WindowGeometryStore {
    private static final Logger LOGGER = Logger
            .getLogger(WindowGeometryStore.class);
    private final WindowGeometryStorePersistence mPersistence;

    /**
     * Create the WindowGeometryStore
     * @param persistence the persistence mechanism for geometry storage
     */
    public WindowGeometryStore(final WindowGeometryStorePersistence persistence) {
        mPersistence = persistence;
    }

    /**
     * Does this frame have any geometry stored? Use this on
     * creating your frame. If there is no stored geometry,
     * you may want to set a default, or pack();
     * @param frame the frame to check for geometry storage.
     * @return true if this frame has had its geometry stored.
     */
    public boolean hasStoredGeometry(final JFrame frame) {
        final String name = frame.getName();
        LOGGER.debug("Trying to load stored geometry for JFrame '" + name + "'");
        final String geomStr = mPersistence.getWindowGeometry(name);
        return (!geomStr.equals(""));
    }
    
    /**
     * Load and set the geometry for this frame, if there is any stored.
     * @param frame the frame whose geometry should be loaded and set.
     */
    public void loadGeometry(final JFrame frame) {
        final String name = frame.getName();
        LOGGER.debug("Trying to load stored geometry for JFrame '" + name + "'");
        final String geomStr = mPersistence.getWindowGeometry(name);
        if (geomStr.equals("")) {
            LOGGER.debug("No geometry stored for JFrame '" + name + "'");
            return;
        }
        LOGGER.debug("Setting starting geometry is " + geomStr);
        // x,y,width,height
        final String[] geomNumStrs = geomStr.split(",");
        final int[] geomNums = new int[geomNumStrs.length];
        for (int i = 0; i < geomNumStrs.length; i++) {
            geomNums[i] = Integer.parseInt(geomNumStrs[i]);
        }
        frame.setBounds(geomNums[0], geomNums[1], geomNums[2], geomNums[3]);
        LOGGER.debug("Starting geometry set for window '" + name + "'");
    }

    /**
     * Store this frame's geometry for later restoration.
     * Typically called when the frame is about to close.
     * @param frame the frame whose geometry will be stored.
     */
    public void saveGeometry(final JFrame frame) {
        final String windowName = frame.getName();
        LOGGER.debug("should we store window " + windowName);
        final Rectangle rect = frame.getBounds();
        final String geomStr = String.format("%d,%d,%d,%d",
            rect.x, rect.y, rect.width, rect.height);
        LOGGER.debug("Storing window '" + windowName + "' geometry " + geomStr);
        mPersistence.setWindowGeometry(windowName, geomStr);
    }
}