LayoutFactory.java

/**
 * This file is part of JSkat.
 *
 * JSkat is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JSkat is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with JSkat.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jskat.gui.swing;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import net.miginfocom.swing.MigLayout;

/**
 * Layout factory for creation of layout managers
 */
public class LayoutFactory {

	private final static Logger LOG = LoggerFactory
			.getLogger(LayoutFactory.class);

	/**
	 * Gets layout manager for {@link MigLayout}<br>
	 * Sets smaller insets on Mac OS platform
	 * 
	 * @return Layout manager
	 */
	public static MigLayout getMigLayout() {

		return getMigLayout(null, null, null);
	}

	/**
	 * Gets layout manager for {@link MigLayout}<br>
	 * Sets smaller insets on Mac OS platform
	 * 
	 * @param layoutConstraints
	 *            Layout constraints for MigLayout
	 * @return Layout manager
	 */
	public static MigLayout getMigLayout(String layoutConstraints) {

		return getMigLayout(layoutConstraints, null, null);
	}

	/**
	 * Gets layout manager for {@link MigLayout}<br>
	 * Sets smaller insets on Mac OS platform
	 * 
	 * @param layoutConstraints
	 *            Layout constraints for MigLayout
	 * @param columnConstraints
	 *            Column constraints for MigLayout
	 * @return Layout manager
	 */
	public static MigLayout getMigLayout(String layoutConstraints,
			String columnConstraints) {

		return getMigLayout(layoutConstraints, columnConstraints, null);
	}

	/**
	 * Gets layout manager for {@link MigLayout}<br>
	 * Sets smaller insets on Mac OS platform
	 * 
	 * @param layoutConstraints
	 *            Layout constraints for MigLayout
	 * @param columnConstraints
	 *            Column constraints for MigLayout
	 * @param rowConstraints
	 *            Row constraints for MigLayout
	 * @return Layout manager
	 */
	public static MigLayout getMigLayout(String layoutConstraints,
			String columnConstraints, String rowConstraints) {

		String finalLayoutConstraints = layoutConstraints;

		if (layoutConstraints != null && isMacOS()) {
			finalLayoutConstraints = injectMacOSLayoutConstraints(layoutConstraints);
		}

		return new MigLayout(finalLayoutConstraints, columnConstraints,
				rowConstraints);
	}

	private static String injectMacOSLayoutConstraints(String layoutConstraints) {

		String result = layoutConstraints;

		if (layoutConstraints == null || layoutConstraints.length() == 0) {
			// no layout constraints set
			result = getMacOSInsets();
		} else if (!layoutConstraints.contains("ins") && !layoutConstraints.contains("insets")) { //$NON-NLS-1$ //$NON-NLS-2$
			// set Mac OS specific insets only if insets are not set already
			result = getMacOSInsets() + ", " + layoutConstraints; //$NON-NLS-1$
		}

		LOG.debug("Layout constraints: " + result);

		return result;
	}

	private static boolean isMacOS() {
		String osName = System.getProperty("os.name").toUpperCase();

		if (osName.contains("MAC")) { //$NON-NLS-1$ //$NON-NLS-2$
			return true;
		}
		return false;
	}

	private static String getMacOSInsets() {
		return "insets 5"; //$NON-NLS-1$
	}
}