RowMapper.java revision 10444:f08705540498 
1/*
2 * Copyright (c) 1997, 1998, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.swing.tree;
27
28import javax.swing.tree.TreePath;
29
30/**
31 * Defines the requirements for an object that translates paths in
32 * the tree into display rows.
33 *
34 * @author Scott Violet
35 */
36public interface RowMapper
37{
38    /**
39     * Returns the rows that the TreePath instances in <code>path</code>
40     * are being displayed at. The receiver should return an array of
41     * the same length as that passed in, and if one of the TreePaths
42     * in <code>path</code> is not valid its entry in the array should
43     * be set to -1.
44     *
45     * @param path  array of TreePath to parse
46     * @return      the rows that the TreePath instances in {@code path} are
47     *              being displayed at
48     */
49    int[] getRowsForPaths(TreePath[] path);
50}
51