1 /*
2 * $Id: DataModelEvent.java,v 1.12 2007/04/27 22:00:09 ofung Exp $
3 */
4
5 /*
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
7 *
8 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41 package javax.faces.model;
42
43
44 import java.util.EventObject;
45
46
47 /**
48 * <p><strong>DataModelEvent</strong> represents an event of interest to
49 * registered listeners that occurred on the specified {@link DataModel}.</p>
50 */
51
52 public class DataModelEvent extends EventObject {
53
54
55 // ------------------------------------------------------------ Constructors
56
57
58 /**
59 * <p>Construct an event object that is associated with the specified
60 * row index and associated data.</p>
61 *
62 * @param model The {@link DataModel} on which this event occurred
63 * @param index The zero relative row index for which this event occurred,
64 * or -1 for no specific row association
65 * @param data Representation of the data for the row specified by
66 * <code>index</code>, or <code>null</code> for no particular row data
67 */
68 public DataModelEvent(DataModel model, int index, Object data) {
69
70 super(model);
71 this.index = index;
72 this.data = data;
73
74 }
75
76
77 // ------------------------------------------------------ Instance Variables
78
79
80 private Object data = null;
81
82
83 private int index = 0;
84
85
86 // -------------------------------------------------------------- Properties
87
88
89 /**
90 * <p>Return the {@link DataModel} that fired this event.</p>
91 */
92 public DataModel getDataModel() {
93
94 return ((DataModel) getSource());
95
96 }
97
98
99 /**
100 * <p>Return the object representing the data for the specified row index,
101 * or <code>null</code> for no associated row data.</p>
102 */
103 public Object getRowData() {
104
105 return (this.data);
106
107 }
108
109
110 /**
111 * <p>Return the row index for this event, or -1 for no specific row.</p>
112 */
113 public int getRowIndex() {
114
115 return (this.index);
116
117 }
118
119
120
121 }
Save This Page