001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: /*
043: * RowModel.java
044: *
045: * Created on January 28, 2004, 11:07 PM
046: */
047:
048: package org.netbeans.swing.outline;
049:
050: /** A model for the rows in an Outline. This is passed the object in
051: * column 0 of an Outline table (the tree column), and provides objects
052: * for the other columns - essentially a model for the data in the
053: * rows of an Outline.
054: * <p>
055: * Note that all column indexes passed to this interface are 0-based -
056: * that is, column 0 is the first column <strong>after</strong> the
057: * tree node column, so the object returned by <code>getValueFor(someObject, 0)</code>
058: * is the object that should appear in column <strong>1</strong> of the
059: * actual table.
060: * <p>
061: *
062: * @author Tim Boudreau
063: */
064: public interface RowModel {
065: /** Get the column count. Do not include the base (nodes) column
066: * of the Outline, only the number of columns in addition to it
067: * that should be displayed.
068: * @return the number of columns this model will contribute to the
069: * OutlineModel, not including the tree column */
070: public int getColumnCount();
071:
072: /** Get the value at a given column.
073: * @param node The node in column 0 of the Outline
074: * @param column The index of the column minus the nodes column
075: * @return the value that should be displayed in the specified column,
076: * given the node in the tree column */
077: public Object getValueFor(Object node, int column);
078:
079: /** Get the object class for the column. Analogous to
080: * <code>TableModel.getColumnClass(int column)</code>
081: * @param column an index into the columns represented by this model (0
082: * based - does not include the tree column of the OutlineModel)
083: * @return the class of object that will be displayed in the specified
084: * column */
085: public Class getColumnClass(int column);
086:
087: /** Determine if the cell in this column is editable for the passed
088: * node.
089: * @param node the object displayed in the tree column of the Outline
090: * @param column the column index into the columns defined by this
091: * RowModel */
092: public boolean isCellEditable(Object node, int column);
093:
094: /** Set the value of the object in this column. Typically this may
095: * call a setter on the node object in column 0. */
096: public void setValueFor(Object node, int column, Object value);
097:
098: /** Get a localized name of this column that can be displayed in
099: * the table header
100: * @param column the column a name is requested for
101: * @return a localized name for the column */
102: public String getColumnName(int column);
103: }
|