001: /*
002: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
003: * Copyright (C) 2002-2005 NextApp, Inc.
004: *
005: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
006: *
007: * The contents of this file are subject to the Mozilla Public License Version
008: * 1.1 (the "License"); you may not use this file except in compliance with
009: * the License. You may obtain a copy of the License at
010: * http://www.mozilla.org/MPL/
011: *
012: * Software distributed under the License is distributed on an "AS IS" basis,
013: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014: * for the specific language governing rights and limitations under the
015: * License.
016: *
017: * Alternatively, the contents of this file may be used under the terms of
018: * either the GNU General Public License Version 2 or later (the "GPL"), or
019: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
020: * in which case the provisions of the GPL or the LGPL are applicable instead
021: * of those above. If you wish to allow use of your version of this file only
022: * under the terms of either the GPL or the LGPL, and not to allow others to
023: * use your version of this file under the terms of the MPL, indicate your
024: * decision by deleting the provisions above and replace them with the notice
025: * and other provisions required by the GPL or the LGPL. If you do not delete
026: * the provisions above, a recipient may use your version of this file under
027: * the terms of any one of the MPL, the GPL or the LGPL.
028: */
029:
030: package nextapp.echo2.app.event;
031:
032: import java.util.EventObject;
033: import nextapp.echo2.app.table.TableModel;
034:
035: /**
036: * An event describing a change to a <code>TableModel</code>.
037: */
038: public class TableModelEvent extends EventObject {
039:
040: /**
041: * A value for <code>column</code> parameters indicating that all columns
042: * of the table were affected by the change.
043: */
044: public static final int ALL_COLUMNS = -2;
045:
046: /**
047: * A value row-describing parameters/properties, (i.e., <code>row</code>,
048: * <code>firstRow</code>, and <code>lastRow</code>)
049: * indicating the table header was affected.
050: */
051: public static final int HEADER_ROW = -1;
052:
053: /**
054: * An event type indicating one or more table rows were deleted.
055: */
056: public static final int DELETE = 1;
057:
058: /**
059: * An event type indicating one or more table rows were inserted.
060: */
061: public static final int INSERT = 2;
062:
063: /**
064: * An event type indicating one or more table rows were updated.
065: */
066: public static final int UPDATE = 3;
067:
068: /**
069: * An event type indicating the table structure was modified.
070: */
071: public static final int STRUCTURE_CHANGED = 4;
072:
073: private int firstRow;
074: private int lastRow;
075: private int column;
076: private int type;
077:
078: /**
079: * Creates a <code>TableModelEvent</code> describing a change to any or
080: * all rows of a table.
081: *
082: * @param source the changed <code>TableModel</code>
083: */
084: public TableModelEvent(TableModel source) {
085: this (source, ALL_COLUMNS, 0, Integer.MAX_VALUE, UPDATE);
086: }
087:
088: /**
089: * Creates a <code>TableModel</code>Event indicating a change to any or
090: * all columns of a single table row.
091: *
092: * @param source the changed <code>TableModel</code>
093: * @param row the index of the affected row
094: */
095: public TableModelEvent(TableModel source, int row) {
096: this (source, ALL_COLUMNS, row, row, UPDATE);
097: }
098:
099: /**
100: * Creates a <code>TableModel</code>Event indicating a change to any or
101: * all columns of an interval of table rows.
102: *
103: * @param source the changed <code>TableModel</code>
104: * @param firstRow the first table row affected by the update
105: * @param lastRow the last table row affected by the update
106: */
107: public TableModelEvent(TableModel source, int firstRow, int lastRow) {
108: this (source, ALL_COLUMNS, firstRow, lastRow, UPDATE);
109: }
110:
111: /**
112: * Creates a <code>TableModelEvent</code> indicating a change to a
113: * particular column of a single table row or an interval of table rows.
114: *
115: * @param source the changed <code>TableModel</code>
116: * @param column the column that was affected by the update
117: * @param firstRow the first table row affected by the update
118: * @param lastRow the last table row affected by the update
119: */
120: public TableModelEvent(TableModel source, int column, int firstRow,
121: int lastRow) {
122: this (source, column, firstRow, lastRow, UPDATE);
123: }
124:
125: /**
126: * Primary constructor for creating <code>TableModelEvent</code>s.
127: * All other constructors are for convenience and must invoke this
128: * constructor.
129: *
130: * @param source the changed <code>TableModel</code>
131: * @param column the column that was affected by the update,
132: * or <code>ALL_COLUMNS</code> if all columns were affected.
133: * @param firstRow the first table row affected by the update
134: * @param lastRow the last table row affected by the update
135: * @param type The type of change that occurred, one of the following
136: * values:
137: * <ul>
138: * <li>STRUCTURE_CHANGED - indicates the table's structure
139: * changed.</li>
140: * <li>DELETE - indicates one or more rows were deleted.</li>
141: * <li>INSERT - indicates one or more rows were inserted.</li>
142: * <li>UPDATE - indicates one or more rows were updated.</li>
143: * </ul>
144: */
145: public TableModelEvent(TableModel source, int column, int firstRow,
146: int lastRow, int type) {
147: super (source);
148:
149: this .firstRow = firstRow;
150: this .lastRow = lastRow;
151: this .column = column;
152: this .type = type;
153: }
154:
155: /**
156: * Returns the column that was affected by the update.
157: *
158: * @return the column that was affected by the update.
159: */
160: public int getColumn() {
161: return column;
162: }
163:
164: /**
165: * Returns the first row that was affected by the update.
166: *
167: * @return the first row that was affected by the update
168: */
169: public int getFirstRow() {
170: return firstRow;
171: }
172:
173: /**
174: * Returns the last row that was affected by the update.
175: *
176: * @return the last row that was affected by the update
177: */
178: public int getLastRow() {
179: return lastRow;
180: }
181:
182: /**
183: * Returns the type of update that occurred.
184: *
185: * @return the type of update that occurred, one of the following values:
186: * <ul>
187: * <li>STRUCTURE_CHANGED - indicates the table's structure
188: * changed.</li>
189: * <li>DELETE - indicates one or more rows were deleted.</li>
190: * <li>INSERT - indicates one or more rows were inserted.</li>
191: * <li>UPDATE - indicates one or more rows were updated.</li>
192: * </ul>
193: */
194: public int getType() {
195: return type;
196: }
197: }
|