001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2023 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.gui; 021 022import javax.swing.event.EventListenerList; 023import javax.swing.event.TreeModelEvent; 024import javax.swing.event.TreeModelListener; 025import javax.swing.tree.TreeModel; 026import javax.swing.tree.TreePath; 027 028import com.puppycrawl.tools.checkstyle.api.DetailAST; 029import com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode; 030 031/** 032 * The model that backs the parse tree in the GUI. 033 * 034 */ 035public class ParseTreeTableModel implements TreeModel { 036 037 /** Presentation model. */ 038 private final ParseTreeTablePresentation pModel; 039 040 /** 041 * A list of event listeners for the tree model. 042 */ 043 private final EventListenerList listenerList = new EventListenerList(); 044 045 /** 046 * Initialise pModel. 047 * 048 * @param parseTree DetailAST parse tree. 049 */ 050 public ParseTreeTableModel(DetailAST parseTree) { 051 pModel = new ParseTreeTablePresentation(parseTree); 052 setParseTree(parseTree); 053 } 054 055 /** 056 * Sets parse tree. 057 * 058 * @param parseTree DetailAST parse tree. 059 */ 060 protected final void setParseTree(DetailAST parseTree) { 061 pModel.setRoot(parseTree); 062 final Object[] path = {pModel.getRoot()}; 063 // no need to setup remaining info, as the call results in a 064 // table structure changed event anyway - we just pass nulls 065 fireTreeStructureChanged(this, path, null, (Object[]) null); 066 } 067 068 /** 069 * Set parse mode. 070 * 071 * @param mode ParseMode enum 072 */ 073 protected void setParseMode(ParseMode mode) { 074 pModel.setParseMode(mode); 075 } 076 077 /** 078 * Returns number of available column. 079 * 080 * @return the number of available column. 081 */ 082 public int getColumnCount() { 083 return pModel.getColumnCount(); 084 } 085 086 /** 087 * Returns column name of specified column number. 088 * 089 * @param column the column number 090 * @return the name for column number {@code column}. 091 */ 092 public String getColumnName(int column) { 093 return pModel.getColumnName(column); 094 } 095 096 /** 097 * Returns type of specified column number. 098 * 099 * @param column the column number 100 * @return the type for column number {@code column}. 101 */ 102 // -@cs[ForbidWildcardAsReturnType] We need to satisfy javax.swing.table.AbstractTableModel 103 // public Class<?> getColumnClass(int columnIndex) {...} 104 public Class<?> getColumnClass(int column) { 105 return pModel.getColumnClass(column); 106 } 107 108 /** 109 * Returns the value to be displayed for node at column number. 110 * 111 * @param node the node 112 * @param column the column number 113 * @return the value to be displayed for node {@code node}, 114 * at column number {@code column}. 115 */ 116 public Object getValueAt(Object node, int column) { 117 return pModel.getValueAt(node, column); 118 } 119 120 @Override 121 public Object getChild(Object parent, int index) { 122 return pModel.getChild(parent, index); 123 } 124 125 @Override 126 public int getChildCount(Object parent) { 127 return pModel.getChildCount(parent); 128 } 129 130 @Override 131 public void valueForPathChanged(TreePath path, Object newValue) { 132 // No Code, as tree is read-only 133 } 134 135 @Override 136 public Object getRoot() { 137 return pModel.getRoot(); 138 } 139 140 @Override 141 public boolean isLeaf(Object node) { 142 return pModel.isLeaf(node); 143 } 144 145 // This is not called in the JTree's default mode: use a naive implementation. 146 @Override 147 public int getIndexOfChild(Object parent, Object child) { 148 return pModel.getIndexOfChild(parent, child); 149 } 150 151 @Override 152 public void addTreeModelListener(TreeModelListener listener) { 153 listenerList.add(TreeModelListener.class, listener); 154 } 155 156 @Override 157 public void removeTreeModelListener(TreeModelListener listener) { 158 listenerList.remove(TreeModelListener.class, listener); 159 } 160 161 /** 162 * Notify all listeners that have registered interest in 163 * 'tree structure changed' event. The event instance 164 * is lazily created using the parameters passed into 165 * the fire method. 166 * 167 * @param source The Object responsible for generating the event. 168 * @param path An array of Object identifying the path to the parent of the modified items. 169 * @param childIndices An array of int that specifies the index values of the removed items. 170 * @param children An array of Object containing the inserted, removed, or changed objects. 171 * @see EventListenerList 172 */ 173 private void fireTreeStructureChanged(Object source, Object[] path, 174 int[] childIndices, 175 Object... children) { 176 // Guaranteed to return a non-null array 177 final Object[] listeners = listenerList.getListenerList(); 178 TreeModelEvent event = null; 179 // Process the listeners last to first, notifying 180 // those that are interested in this event 181 for (int i = listeners.length - 2; i >= 0; i -= 2) { 182 if (listeners[i] == TreeModelListener.class) { 183 // Lazily create the event: 184 if (event == null) { 185 event = new TreeModelEvent(source, path, 186 childIndices, children); 187 } 188 ((TreeModelListener) listeners[i + 1]).treeStructureChanged(event); 189 } 190 } 191 } 192 193 /** 194 * Indicates whether the value for node {@code node}, 195 * at column number {@code column} is editable. 196 * 197 * @param column the column number 198 * @return true if editable 199 */ 200 public boolean isCellEditable(int column) { 201 return pModel.isCellEditable(column); 202 } 203 204}