BaseController.java

package de.eisfeldj.augendiagnosefx.controller;

import java.util.ArrayList;
import java.util.List;

import de.eisfeldj.augendiagnosefx.util.FxmlUtil;

/**
 * Generic controller class.
 */
public abstract class BaseController implements Controller {
	/**
	 * The list of all controllers.
	 */
	private static List<BaseController> mControllerRegistry = new ArrayList<>();

	/**
	 * Indicator if there is data pending to be saved.
	 */
	private boolean mIsDirty = false;

	/**
	 * The pane in which this element is shown.
	 */
	private int mPaneIndex = 0;

	public final int getPaneIndex() {
		return mPaneIndex;
	}

	public final void setPaneIndex(final int newPaneIndex) {
		mPaneIndex = newPaneIndex;
	}

	/**
	 * Flag indicating if this controller represents a subpage that may be closed.
	 */
	private boolean mIsCloseable = true;

	public final boolean isCloseable() {
		return mIsCloseable;
	}

	public final void setCloseable(final boolean isCloseable) {
		this.mIsCloseable = isCloseable;
	}

	/**
	 * Constructor of controllers. Adds the controller to the registry.
	 */
	public BaseController() {
		mControllerRegistry.add(this);
	}

	/**
	 * Add the controller to the registry, if not yet there.
	 */
	protected void addToRegistry() {
		if (!mControllerRegistry.contains(this)) {
			mControllerRegistry.add(this);
		}
	}

	/**
	 * Close a controller, removing it from the registry.
	 */
	// OVERRIDABLE
	public void close() {
		FxmlUtil.remove(this.getRoot());
		mControllerRegistry.remove(this);
	}

	/**
	 * Remove the controller from the registry.
	 */
	protected void removeFromRegistry() {
		mControllerRegistry.remove(this);
	}

	/**
	 * Refresh the controller on resize of the window.
	 */
	// OVERRIDABLE
	public void refreshOnResize() {

	}

	/**
	 * Get all controllers of a given type.
	 *
	 * @param <C>
	 *            the controller class.
	 * @param controllerClass
	 *            The type of controller.
	 * @return The list of controllers.
	 */
	@SuppressWarnings("unchecked")
	public static <C extends BaseController> List<C> getControllers(final Class<C> controllerClass) {
		List<C> result = new ArrayList<>();

		for (BaseController controller : mControllerRegistry) {
			if (controllerClass.isAssignableFrom(controller.getClass())) {
				result.add((C) controller);
			}
		}

		return result;
	}

	/**
	 * Get the controller of a given type.
	 *
	 * @param <C>
	 *            the controller class.
	 * @param controllerClass
	 *            The type of controller.
	 * @return The controller
	 * @throws TooManyControllersException
	 *             There is more than one such controller.
	 * @throws MissingControllerException
	 *             There is no such controller.
	 */
	public static <C extends BaseController> C getController(final Class<C> controllerClass)
			throws TooManyControllersException,
			MissingControllerException {
		List<C> controllers = getControllers(controllerClass);

		if (controllers.size() > 1) {
			throw new TooManyControllersException();
		}
		if (controllers.size() == 0) {
			throw new MissingControllerException();
		}
		return controllers.get(0);
	}

	/**
	 * Get information if the controller has data pending for save.
	 *
	 * @return true if the controller has data pending for save.
	 */
	// OVERRIDABLE
	public boolean isDirty() {
		return mIsDirty;
	}

	/**
	 * Indicate if the controller has data pending for save.
	 *
	 * @param dirty
	 *            value true indicates that there is data pending for save.
	 */
	protected final void setDirty(final boolean dirty) {
		mIsDirty = dirty;
	}

	/**
	 * Expected controller is missing.
	 */
	public static class MissingControllerException extends Exception {
		/**
		 * The serial version id.
		 */
		private static final long serialVersionUID = 1L;
	}

	/**
	 * There are two controllers of the same type, but there shouldn't.
	 */
	public static class TooManyControllersException extends Exception {
		/**
		 * The serial version id.
		 */
		private static final long serialVersionUID = 1L;
	}

}