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: * OutlineTableModel.java
044: *
045: * Created on January 27, 2004, 6:53 PM
046: */
047:
048: package org.netbeans.swing.outline;
049:
050: import javax.swing.table.TableModel;
051: import javax.swing.tree.AbstractLayoutCache;
052: import javax.swing.tree.TreeModel;
053:
054: /** A model for an Outline ("tree-table"). Implements both
055: * TreeModel and TableModel (the default implementation, DefaultOutlineModel,
056: * wraps a supplied TreeModel and TableModel). It is vastly easier to
057: * use <code>DefaultOutlineModel</code> than to implement this interface
058: * directly.
059: *
060: * @author Tim Boudreau */
061: public interface OutlineModel extends TableModel, TreeModel {
062: /** Get the <code>TreePathSupport</code> object this model uses to manage
063: * information about expanded nodes. <code>TreePathSupport</code> implements
064: * logic for tracking expanded nodes, manages <code>TreeWillExpandListener</code>s,
065: * and is a repository for preserving expanded state information about nodes whose parents
066: * are currently collapsed. JTree implements very similar logic internally
067: * to itself.
068: * <p>
069: * <i>(PENDING) It is not yet determined if TreePathSupport will remain a
070: * public class.</i>
071: */
072: public TreePathSupport getTreePathSupport();
073:
074: /** Get the layout cache which is used to track the visual state of nodes.
075: * This is typically one of the standard JDK layout cache classes, such
076: * as <code>VariableHeightLayoutCache</code> or <code>
077: * FixedHeightLayoutCache</code>. */
078: public AbstractLayoutCache getLayout();
079:
080: /** Determine if the model is a large-model. Large model trees keep less
081: * internal state information, relying on the TreeModel more. Essentially
082: * they trade performance for scalability. An OutlineModel may be large
083: * model or small model; primarily this affects the type of layout cache
084: * used, just as it does with JTree. */
085: public boolean isLargeModel();
086:
087: /**
088: * This method allows you to set the name of the column representing the node.
089: * Added 4/19/2004 - David Botterill
090: * @param inName - the name to be given to the node column.
091: */
092: public void setNodeColumnName(String inName);
093:
094: /**
095: * Get the NodeRowModel interface so we can manage information about nodes as they related
096: * to rows.
097: * Added 4/19/2004 - David Botterill
098: */
099: public NodeRowModel getRowNodeModel();
100:
101: }
|