org.mihalis.opal/src/main/java/org/mihalis/opal/preferenceWindow/PWRowGroup.java

/*******************************************************************************
 * Copyright (c) 2011 Laurent CARON
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Laurent CARON (laurent.caron at gmail dot com) - Initial implementation and API
 *******************************************************************************/
package org.mihalis.opal.preferenceWindow;

import org.mihalis.opal.preferenceWindow.enabler.Enabler;

/**
 * Abstract class for both row and groups.
 */
public abstract class PWRowGroup extends PWContainer {

	/** The number of columns. */
	protected int numberOfColumns;
	
	/** The parent number of colums. */
	protected int parentNumberOfColums;
	
	/** The parent. */
	protected PWContainer parent;
	
	/** The enabler. */
	protected Enabler enabler;

	/**
	 * Check if the parent is compatible with the object.
	 *
	 * @param parent parent to check
	 * @throws UnsupportedOperationException if the parent is not compatible
	 *             with the object
	 */
	protected abstract void checkParent(PWContainer parent);

	/**
	 * Enables or disables all elements stored in this group or row.
	 */
	public abstract void enableOrDisable();

	/**
	 * Add a column to the current element.
	 *
	 * @param number number of column to add
	 */
	public void addColumn(final int number) {
		this.numberOfColumns += number;
	}

	/**
	 * Gets the number of colums.
	 *
	 * @return the number of columns of this group or row
	 */
	public int getNumberOfColums() {
		return this.numberOfColumns;
	}

	/**
	 * Sets the enabler.
	 *
	 * @param enabler the enabler to set
	 * @return the PW row group
	 */
	public PWRowGroup setEnabler(final Enabler enabler) {
		this.enabler = enabler;
		this.enabler.injectRowGroup(this);
		return this;
	}

	/**
	 * Sets the parent.
	 *
	 * @param parent the parent to set
	 */
	public void setParent(final PWContainer parent) {
		checkParent(parent);
		this.parent = parent;
	}

	/**
	 * Sets the parent number of columns.
	 *
	 * @param numberOfColumns the number of columns of the parent
	 */
	public void setParentNumberOfColumns(final int numberOfColumns) {
		this.parentNumberOfColums = numberOfColumns;
	}

}