/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.model;
import java.util.EventObject;
/**
* <p><strong>DataModelEvent</strong> represents an event of interest to
* registered listeners that occurred on the specified {@link DataModel}.</p>
*/
public class DataModelEvent extends EventObject {
// ------------------------------------------------------------ Constructors
private static final long serialVersionUID = -1822980374964965366L;
/**
* <p>Construct an event object that is associated with the specified
* row index and associated data.</p>
*
* @param model The {@link DataModel} on which this event occurred
* @param index The zero relative row index for which this event occurred,
* or -1 for no specific row association
* @param data Representation of the data for the row specified by
* <code>index</code>, or <code>null</code> for no particular row data
*/
public DataModelEvent(DataModel model, int index, Object data) {
super(model);
this.index = index;
this.data = data;
}
// ------------------------------------------------------ Instance Variables
private Object data = null;
private int index = 0;
// -------------------------------------------------------------- Properties
/**
* <p>Return the {@link DataModel} that fired this event.</p>
*
* @return the {@link DataModel} that fired this event
*/
public DataModel getDataModel() {
return ((DataModel) getSource());
}
/**
* <p>Return the object representing the data for the specified row index,
* or <code>null</code> for no associated row data.</p>
*
* @return the object representing the data for the specified row index,
* or <code>null</code> for no associated row data
*/
public Object getRowData() {
return (this.data);
}
/**
* <p>Return the row index for this event, or -1 for no specific row.</p>
*
* @return the row index for this event, or -1 for no specific row
*/
public int getRowIndex() {
return (this.index);
}
}