AccessibleTableModelChange.java

/*
 * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.accessibility;

/**
 * The {@code AccessibleTableModelChange} interface describes a change to the
 * table model. The attributes of the model change can be obtained by the
 * following methods:
 * <ul>
 *   <li>{@code public int getType();}
 *   <li>{@code public int getFirstRow();}
 *   <li>{@code public int getLastRow();}
 *   <li>{@code public int getFirstColumn();}
 *   <li>{@code public int getLastColumn();}
 * </ul>
 * The model change type returned by getType() will be one of:
 * <ul>
 *   <li>{@code INSERT} - one or more rows and/or columns have been inserted
 *   <li>{@code UPDATE} - some of the table data has changed
 *   <li>{@code DELETE} - one or more rows and/or columns have been deleted
 * </ul>
 * The affected area of the table can be determined by the other four methods
 * which specify ranges of rows and columns
 *
 * @author Lynn Monsanto
 * @see Accessible
 * @see Accessible#getAccessibleContext
 * @see AccessibleContext
 * @see AccessibleContext#getAccessibleTable
 * @since 1.3
 */
public interface AccessibleTableModelChange {

    /**
     * Identifies the insertion of new rows and/or columns.
     */
    public static final int INSERT =  1;

    /**
     * Identifies a change to existing data.
     */
    public static final int UPDATE =  0;

    /**
     * Identifies the deletion of rows and/or columns.
     */
    public static final int DELETE = -1;

    /**
     * Returns the type of event.
     *
     * @return the type of event
     * @see #INSERT
     * @see #UPDATE
     * @see #DELETE
     */
    public int getType();

    /**
     * Returns the first row that changed.
     *
     * @return the first row that changed
     */
    public int getFirstRow();

    /**
     * Returns the last row that changed.
     *
     * @return the last row that changed
     */
    public int getLastRow();

    /**
     * Returns the first column that changed.
     *
     * @return the first column that changed
     */
    public int getFirstColumn();

    /**
     * Returns the last column that changed.
     *
     * @return the last column that changed
     */
    public int getLastColumn();
}