Line 0
Link Here
|
|
|
1 |
/* |
2 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
3 |
* |
4 |
* Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved. |
5 |
* |
6 |
* Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
7 |
* Other names may be trademarks of their respective owners. |
8 |
* |
9 |
* The contents of this file are subject to the terms of either the GNU |
10 |
* General Public License Version 2 only ("GPL") or the Common |
11 |
* Development and Distribution License("CDDL") (collectively, the |
12 |
* "License"). You may not use this file except in compliance with the |
13 |
* License. You can obtain a copy of the License at |
14 |
* http://www.netbeans.org/cddl-gplv2.html |
15 |
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the |
16 |
* specific language governing permissions and limitations under the |
17 |
* License. When distributing the software, include this License Header |
18 |
* Notice in each file and include the License file at |
19 |
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this |
20 |
* particular file as subject to the "Classpath" exception as provided |
21 |
* by Oracle in the GPL Version 2 section of the License file that |
22 |
* accompanied this code. If applicable, add the following below the |
23 |
* License Header, with the fields enclosed by brackets [] replaced by |
24 |
* your own identifying information: |
25 |
* "Portions Copyrighted [year] [name of copyright owner]" |
26 |
* |
27 |
* If you wish your version of this file to be governed by only the CDDL |
28 |
* or only the GPL Version 2, indicate your decision by adding |
29 |
* "[Contributor] elects to include this software in this distribution |
30 |
* under the [CDDL or GPL Version 2] license." If you do not indicate a |
31 |
* single choice of license, a recipient has the option to distribute |
32 |
* your version of this file under either the CDDL, the GPL Version 2 or |
33 |
* to extend the choice of license to its licensees as provided above. |
34 |
* However, if you add GPL Version 2 code and therefore, elected the GPL |
35 |
* Version 2 license, then the option applies only if the new code is |
36 |
* made subject to such option by the copyright holder. |
37 |
* |
38 |
* Contributor(s): |
39 |
*/ |
40 |
|
41 |
package org.openide.windows; |
42 |
|
43 |
/** |
44 |
* Selects mode which a TopComponent should initially dock into. |
45 |
* If a TopComponent being opened is not docked into any Mode, the system selects |
46 |
* the last-used editor-kind Mode, or the default editor mode if no editor was used. |
47 |
* Plugin implementors can hint the Window System to use more appropriate |
48 |
* mode than the default to open the TopComppnent. |
49 |
* <p/> |
50 |
* If none of the registered {@code ModeSelector}s return a valid Mode, the TopComponent |
51 |
* will open in the mode selected by the default algorithm. Implementation of WindowManager |
52 |
* may ignore the hint, for example if it conflicts with persisted settings or user choices. |
53 |
* <p/> |
54 |
* Implementations of {@code ModeSelector} must be registered in the default Lookup. |
55 |
* @since 6.77 |
56 |
*/ |
57 |
public interface ModeSelector { |
58 |
/** |
59 |
* Choose a suitable Mode to open the TopComponent in. The implementation |
60 |
* should return an existing Mode which the TopComponent will dock into. The |
61 |
* automatically selected Mode will be passed in {@code preselectedMode}. |
62 |
* The implementation can accept the default or ignore the request and return |
63 |
* {@code null}. |
64 |
* |
65 |
* @param tc the {@link TopComponent} to be opened. |
66 |
* @param preselectedMode the default mode for opening |
67 |
* @return a more suitable Mode, or {@code null} to use the preselected one. |
68 |
*/ |
69 |
public Mode selectModeForOpen(TopComponent tc, Mode preselectedMode); |
70 |
} |