← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to xml/xamui/src/org/netbeans/modules/xml/xam/ui/column/ColumnView.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
xml/xamui/src/org/netbeans/modules/xml/xam/ui/column/ColumnView.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.modules.xml.xam.ui.column;
 
43
 
 
44
/**
 
45
 * A ColumnView contains one or more Column instances, and manages their
 
46
 * display in terms of providing a scrollable view.
 
47
 *
 
48
 * @author  Nathan Fiedler
 
49
 */
 
50
public interface ColumnView {
 
51
 
 
52
    /**
 
53
     * Appends the given column to the end of the column list.
 
54
     *
 
55
     * @param  column  Column to be added to view.
 
56
     */
 
57
    void appendColumn(Column column);
 
58
 
 
59
    /**
 
60
     * Appends the array of columns to the end of the column list.
 
61
     * Any scrolling will be done once, making the last column visible.
 
62
     *
 
63
     * @param  columns  array of columns to be added to view.
 
64
     */
 
65
    void appendColumns(Column[] columns);
 
66
 
 
67
    /**
 
68
     * Remove all of the columns from the view.
 
69
     */
 
70
    void clearColumns();
 
71
 
 
72
    /**
 
73
     * Returns the number of columns contained in this view.
 
74
     *
 
75
     * @return  column count.
 
76
     */
 
77
    int getColumnCount();
 
78
 
 
79
    /**
 
80
     * Get the index into the list for the given column.
 
81
     *
 
82
     * @param  column  Column to locate in view.
 
83
     * @return  index of the column, or -1 if not found.
 
84
     */
 
85
    int getColumnIndex(Column column);
 
86
 
 
87
    /**
 
88
     * Retrieves the first column in the view.
 
89
     *
 
90
     * @return  first Column, or null if no columns exist.
 
91
     */
 
92
    Column getFirstColumn();
 
93
 
 
94
    /**
 
95
     * Retrieves the column following the one given.
 
96
     *
 
97
     * @param  column  Column for which to find sibling.
 
98
     * @return  next Column, or null if none.
 
99
     */
 
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
}