replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / ui / treeStructure / treetable / TreeTableModel.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.ui.treeStructure.treetable;
17
18 import javax.swing.*;
19 import javax.swing.tree.TreeModel;
20
21 /**
22  * TreeTableModel is the model used by a JTreeTable. It extends TreeModel
23  * to add methods for getting inforamtion about the set of columns each
24  * node in the TreeTableModel may have. Each column, like a column in
25  * a TableModel, has a name and a type associated with it. Each node in
26  * the TreeTableModel can return a value for each of the columns and
27  * set that value if isCellEditable() returns true.
28  *
29  * @author Philip Milne
30  * @author Scott Violet
31  */
32 public interface TreeTableModel extends TreeModel {
33   /**
34    * Returns the number ofs availible column.
35    */
36   int getColumnCount();
37
38   /**
39    * Returns the name for column number {@code column}.
40    */
41   String getColumnName(int column);
42
43   /**
44    * Returns the type for column number {@code column}.
45    */
46   Class getColumnClass(int column);
47
48   /**
49    * Returns the value to be displayed for node {@code node},
50    * at column number {@code column}.
51    */
52   Object getValueAt(Object node, int column);
53
54   /**
55    * Indicates whether the value for node {@code node},
56    * at column number {@code column} is editable.
57    */
58   boolean isCellEditable(Object node, int column);
59
60   /**
61    * Sets the value for node {@code node},
62    * at column number {@code column}.
63    */
64   void setValueAt(Object aValue, Object node, int column);
65
66   void setTree(JTree tree);
67 }