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: package org.netbeans.modules.xml.xam.ui.column;
043:
044: /**
045: * A ColumnView contains one or more Column instances, and manages their
046: * display in terms of providing a scrollable view.
047: *
048: * @author Nathan Fiedler
049: */
050: public interface ColumnView {
051:
052: /**
053: * Appends the given column to the end of the column list.
054: *
055: * @param column Column to be added to view.
056: */
057: void appendColumn(Column column);
058:
059: /**
060: * Appends the array of columns to the end of the column list.
061: * Any scrolling will be done once, making the last column visible.
062: *
063: * @param columns array of columns to be added to view.
064: */
065: void appendColumns(Column[] columns);
066:
067: /**
068: * Remove all of the columns from the view.
069: */
070: void clearColumns();
071:
072: /**
073: * Returns the number of columns contained in this view.
074: *
075: * @return column count.
076: */
077: int getColumnCount();
078:
079: /**
080: * Get the index into the list for the given column.
081: *
082: * @param column Column to locate in view.
083: * @return index of the column, or -1 if not found.
084: */
085: int getColumnIndex(Column column);
086:
087: /**
088: * Retrieves the first column in the view.
089: *
090: * @return first Column, or null if no columns exist.
091: */
092: Column getFirstColumn();
093:
094: /**
095: * Retrieves the column following the one given.
096: *
097: * @param column Column for which to find sibling.
098: * @return next Column, or null if none.
099: */
100: Column getNextColumn(Column column);
101:
102: /**
103: * Removes the columns after the one given.
104: *
105: * @param column Column that will be the new right-most column.
106: */
107: void removeColumnsAfter(Column column);
108:
109: /**
110: * Scrolls the viewport to make the specified column visible. If the
111: * synchronous parameter is false, this method will return before the
112: * viewport has finished scrolling. If the synchronous parameter is
113: * true, this method will scroll the viewport on the event thread
114: * (if the invoking thread is not the event thread, this method will
115: * block on the event thread until the scrolling is complete).
116: *
117: * @param column Column to make visible.
118: * @param synchronous true to scroll now, on event thread, false to
119: * scroll some time later, on event thread.
120: */
121: void scrollToColumn(Column column, boolean synchronous);
122: }
|