org.fife.ui.modifiabletable.ModifiableTableChangeEvent Maven / Gradle / Ivy

/*
 * 07/29/2005
 *
 * ModifiableTableChangeEvent.java - The event fired when a ModifiableTable
 * changes.
 * Copyright (C) 2005 Robert Futrell
 * http://fifesoft.com/rtext
 * Licensed under a modified BSD license.
 * See the included license file for details.
 */
package org.fife.ui.modifiabletable;

import java.util.EventObject;


/**
 * An event representing the addition, removal or modification of a row in a
 * ModifiableTable.
 *
 * @author Robert Futrell
 * @version 1.0
 */
public class ModifiableTableChangeEvent extends EventObject {

	private static final long serialVersionUID = 1L;

	private static final int MIN_CHANGE	= 0;
	public static final int ADDED			= 0;
	public static final int MODIFIED		= 1;
	public static final int REMOVED		= 2;
	private static final int MAX_CHANGE	= 2;

	private int change;
	private int row;


	/**
	 * Constructor.
	 *
	 * @param source The table that changed.
	 * @param change One of ADDED, MODIFIED or
	 *        REMOVED.
	 * @param row The row that was added, modified or removed.
	 */
	public ModifiableTableChangeEvent(ModifiableTable source, int change,
								int row) {
		super(source);
		if (changeMAX_CHANGE)
			throw new IllegalArgumentException("Invalid change: " + change);
		this.change = change;
		this.row = row;
	}


	/**
	 * Returns the change that occurred.
	 *
	 * @return One of ADDED, MODIFIED or
	 *         REMOVED.
	 */
	public int getChange() {
		return change;
	}


	/**
	 * Returns the modifiable table that has changed.
	 *
	 * @return The modifiable table.
	 */
	public ModifiableTable getModifiableTable() {
		return (ModifiableTable)getSource();
	}


	/**
	 * Returns the row that was added, removed or modified.
	 *
	 * @return The row number.
	 */
	public int getRow() {
		return row;
	}


}