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

« back to all changes in this revision

Viewing changes to core/windows/src/org/netbeans/core/windows/model/ModeModel.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:
 
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-2006 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.core.windows.model;
 
43
 
 
44
 
 
45
import org.openide.windows.TopComponent;
 
46
 
 
47
import java.awt.*;
 
48
import java.util.List;
 
49
import java.util.Map;
 
50
 
 
51
import org.netbeans.core.windows.ModeImpl;
 
52
import org.netbeans.core.windows.SplitConstraint;
 
53
import org.openide.windows.TopComponent;
 
54
 
 
55
 
 
56
/**
 
57
 *
 
58
 * @author  Peter Zavadsky
 
59
 */
 
60
interface ModeModel {
 
61
 
 
62
    // Mutators
 
63
    /** Sets state. */
 
64
    public void setState(int state);
 
65
    /** Sets bounds. */
 
66
    public void setBounds(Rectangle bounds);
 
67
    /** */
 
68
    public void setBoundsSeparatedHelp(Rectangle bounds);
 
69
    /** Sets frame state. */
 
70
    public void setFrameState(int frameState);
 
71
    /** Sets selected TopComponent. */
 
72
    public void setSelectedTopComponent(TopComponent selected);
 
73
    /** Set top component that was selected before switching to/from maximized mode */
 
74
    public void setPreviousSelectedTopComponentID(String prevSelectedId);
 
75
    /** Adds opened TopComponent. */
 
76
    public void addOpenedTopComponent(TopComponent tc);
 
77
    /** Inserts opened TopComponent. */
 
78
    public void insertOpenedTopComponent(TopComponent tc, int index);
 
79
    /** Adds closed TopComponent. */
 
80
    public void addClosedTopComponent(TopComponent tc);
 
81
    // XXX
 
82
    public void addUnloadedTopComponent(String tcID);
 
83
    // XXX
 
84
    public void setUnloadedSelectedTopComponent(String tcID);
 
85
    /** Set top component that was selected before switching to/from maximized mode */
 
86
    public void setUnloadedPreviousSelectedTopComponent(String tcID);
 
87
    /** Removes TopComponent from mode. */
 
88
    public void removeTopComponent(TopComponent tc, TopComponent recentTc);
 
89
    // XXX
 
90
    public void removeClosedTopComponentID(String tcID);
 
91
    
 
92
    // Info about previous top component context, used by sliding kind of modes
 
93
    
 
94
    /** Sets information of previous mode top component was in. */
 
95
    public void setTopComponentPreviousMode(String tcID, ModeImpl mode, int prevIndex);
 
96
    /** Sets information of previous constraints of mode top component was in. */
 
97
    public void setTopComponentPreviousConstraints(String tcID, SplitConstraint[] constraints);
 
98
 
 
99
    // Accessors
 
100
    /** Gets programatic name of mode. */
 
101
    public String getName();
 
102
    /** Gets bounds. */
 
103
    public Rectangle getBounds();
 
104
    /** */
 
105
    public Rectangle getBoundsSeparatedHelp();
 
106
    /** Gets state. */
 
107
    public int getState();
 
108
    /** Gets kind. */
 
109
    public int getKind();
 
110
    /** Gets frame state. */
 
111
    public int getFrameState();
 
112
    /** Gets whether it is permanent. */
 
113
    public boolean isPermanent();
 
114
    /** */
 
115
    public boolean isEmpty();
 
116
    /** */
 
117
    public boolean containsTopComponent(TopComponent tc);
 
118
    /** Gets selected TopComponent. */
 
119
    public TopComponent getSelectedTopComponent();
 
120
    /** Gets the ID of top component that was selected before switching to/from maximized mode */
 
121
    public String getPreviousSelectedTopComponentID();
 
122
    /** Gets list of top components in mode. */
 
123
    public List<TopComponent> getTopComponents();
 
124
    /** Gets list of top components in mode. */
 
125
    public List<TopComponent> getOpenedTopComponents();
 
126
    // XXX
 
127
    public List<String> getOpenedTopComponentsIDs();
 
128
    public List<String> getClosedTopComponentsIDs();
 
129
    public List<String> getTopComponentsIDs();    
 
130
    
 
131
    // Info about previous top component context, used by sliding kind of modes
 
132
    
 
133
    public ModeImpl getTopComponentPreviousMode(String tcID);
 
134
    /** Gets the tab index of the top component in its previous mode */
 
135
    public int getTopComponentPreviousIndex(String tcID);
 
136
    
 
137
    public SplitConstraint[] getTopComponentPreviousConstraints(String tcID);
 
138
    
 
139
    /** Gets position of opened top component in this mode */
 
140
    public int getOpenedTopComponentTabPosition (TopComponent tc);
 
141
}
 
142