001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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 * @author Lars K├╝hne
035 */
036public class ParseTreeTableModel implements TreeModel {
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     * @param parseTree DetailAST parse tree.
048     */
049    public ParseTreeTableModel(DetailAST parseTree) {
050        pModel = new ParseTreeTablePresentation(parseTree);
051        setParseTree(parseTree);
052    }
053
054    /**
055     * Sets parse tree.
056     * @param parseTree DetailAST parse tree.
057     */
058    protected final void setParseTree(DetailAST parseTree) {
059        pModel.setParseTree(parseTree);
060        final Object[] path = {pModel.getRoot()};
061        // no need to setup remaining info, as the call results in a
062        // table structure changed event anyway - we just pass nulls
063        fireTreeStructureChanged(this, path, null, (Object[]) null);
064    }
065
066    /**
067     * Set parse mode.
068     * @param mode ParseMode enum
069     */
070    protected void setParseMode(ParseMode mode) {
071        pModel.setParseMode(mode);
072    }
073
074    /**
075     * Returns number of available column.
076     * @return the number of available column.
077     */
078    public int getColumnCount() {
079        return pModel.getColumnCount();
080    }
081
082    /**
083     * Returns column name of specified column number.
084     * @param column the column number
085     * @return the name for column number {@code column}.
086     */
087    public String getColumnName(int column) {
088        return pModel.getColumnName(column);
089    }
090
091    /**
092     * Returns type of specified column number.
093     * @param column the column number
094     * @return the type for column number {@code column}.
095     */
096    // -@cs[ForbidWildcardAsReturnType] We need to satisfy javax.swing.table.AbstractTableModel
097    // public Class<?> getColumnClass(int columnIndex) {...}
098    public Class<?> getColumnClass(int column) {
099        return pModel.getColumnClass(column);
100    }
101
102    /**
103     * Returns the value to be displayed for node at column number.
104     * @param node the node
105     * @param column the column number
106     * @return the value to be displayed for node {@code node},
107     *     at column number {@code column}.
108     */
109    public Object getValueAt(Object node, int column) {
110        return pModel.getValueAt(node, column);
111    }
112
113    @Override
114    public Object getChild(Object parent, int index) {
115        return pModel.getChild(parent, index);
116    }
117
118    @Override
119    public int getChildCount(Object parent) {
120        return pModel.getChildCount(parent);
121    }
122
123    @Override
124    public void valueForPathChanged(TreePath path, Object newValue) {
125        // No Code, as tree is read-only
126    }
127
128    @Override
129    public Object getRoot() {
130        return pModel.getRoot();
131    }
132
133    @Override
134    public boolean isLeaf(Object node) {
135        return pModel.isLeaf(node);
136    }
137
138    // This is not called in the JTree's default mode: use a naive implementation.
139    @Override
140    public int getIndexOfChild(Object parent, Object child) {
141        return pModel.getIndexOfChild(parent, child);
142    }
143
144    @Override
145    public void addTreeModelListener(TreeModelListener listener) {
146        listenerList.add(TreeModelListener.class, listener);
147    }
148
149    @Override
150    public void removeTreeModelListener(TreeModelListener listener) {
151        listenerList.remove(TreeModelListener.class, listener);
152    }
153
154    /**
155     * Notify all listeners that have registered interest for
156     * 'tree structure changed' event.  The event instance
157     * is lazily created using the parameters passed into
158     * the fire method.
159     * @param source The Object responsible for generating the event.
160     * @param path An array of Object identifying the path to the parent of the modified items.
161     * @param childIndices An array of int that specifies the index values of the removed items.
162     * @param children An array of Object containing the inserted, removed, or changed objects.
163     * @see EventListenerList
164     */
165    private void fireTreeStructureChanged(Object source, Object[] path,
166                                  int[] childIndices,
167                                  Object... children) {
168        // Guaranteed to return a non-null array
169        final Object[] listeners = listenerList.getListenerList();
170        TreeModelEvent event = null;
171        // Process the listeners last to first, notifying
172        // those that are interested in this event
173        for (int i = listeners.length - 2; i >= 0; i -= 2) {
174            if (listeners[i] == TreeModelListener.class) {
175                // Lazily create the event:
176                if (event == null) {
177                    event = new TreeModelEvent(source, path,
178                        childIndices, children);
179                }
180                ((TreeModelListener) listeners[i + 1]).treeStructureChanged(event);
181            }
182        }
183    }
184
185    /**
186     * Indicates whether the the value for node {@code node},
187     * at column number {@code column} is editable.
188     *
189     * @param column the column number
190     * @return true if editable
191     */
192    public boolean isCellEditable(int column) {
193        return pModel.isCellEditable(column);
194    }
195}