Repository navigation
Expand file tree
/
Copy pathUserInterface.java
More file actions
237 lines (211 loc) · 8.25 KB
/
Copy pathUserInterface.java
File metadata and controls
237 lines (211 loc) · 8.25 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.ui;
import java.io.File;
import java.io.FileFilter;
import java.util.Arrays;
import java.util.List;
import org.scijava.Disposable;
import org.scijava.display.Display;
import org.scijava.plugin.Plugin;
import org.scijava.plugin.RichPlugin;
import org.scijava.ui.console.ConsolePane;
import org.scijava.ui.viewer.DisplayWindow;
import org.scijava.widget.FileWidget;
import org.scijava.widget.WidgetStyle;
/**
* An end-user SciJava application user interface.
* <p>
* UIs discoverable at runtime must implement this interface and be annotated
* with @{@link Plugin} with attribute {@link Plugin#type()} =
* {@link UserInterface}.class. While it possible to create a UI merely by
* implementing this interface, it is encouraged to instead extend
* {@link AbstractUserInterface}, for convenience.
* </p>
*
* @author Curtis Rueden
* @see Plugin
* @see UIService
*/
public interface UserInterface extends RichPlugin, Disposable {
/**
* Shows the UI.
* <p>
* Note that the actual UI components are created lazily when this method is
* called, rather then upon the UI's initial construction.
* </p>
*/
void show();
/** Whether this UI is visible onscreen. */
boolean isVisible();
/** Shows the object onscreen using an appropriate UI widget. */
default void show(final Object o) {
show(null, o);
}
/**
* Shows the object onscreen using an appropriate UI widget.
*
* @param name The name to use when displaying the object.
* @param o The object to be displayed.
*/
void show(String name, Object o);
/** Shows the display onscreen using an appropriate UI widget. */
void show(Display<?> display);
/**
* Gets the desktop, for use with multi-document interfaces (MDI), or null if
* not applicable.
*/
default Desktop getDesktop() {
return null;
}
/** Gets the main SciJava application frame, or null if not applicable. */
default ApplicationFrame getApplicationFrame() {
return null;
}
/** Gets the main SciJava toolbar, or null if not applicable. */
default ToolBar getToolBar() {
return null;
}
/** Gets the main SciJava status bar, or null if not applicable. */
default StatusBar getStatusBar() {
return null;
}
/** Gets the main SciJava console pane, or null if not applicable. */
default ConsolePane<?> getConsolePane() {
return null;
}
/**
* Gets the system clipboard associated with this UI, or null if not
* applicable.
*/
default SystemClipboard getSystemClipboard() {
return null;
}
/**
* Creates a new display window housing the given display, or null if not
* applicable.
*/
DisplayWindow createDisplayWindow(Display<?> display);
/**
* Creates a dialog prompter.
*
* @param message The message in the dialog itself.
* @param title The title of the dialog.
* @param messageType The type of message. This typically is rendered as an
* icon next to the message. For example,
* {@link DialogPrompt.MessageType#WARNING_MESSAGE} typically appears
* as an exclamation point.
* @param optionType The choices available when dismissing the dialog. These
* choices are typically rendered as buttons for the user to click.
* @return The newly created DialogPrompt object, or null if not applicable.
*/
DialogPrompt dialogPrompt(String message, String title,
DialogPrompt.MessageType messageType, DialogPrompt.OptionType optionType);
/**
* Prompts the user to choose a file.
*
* @param file The initial value displayed in the file chooser prompt.
* @param style The style of chooser to use:
* <ul>
* <li>{@link FileWidget#OPEN_STYLE}</li>
* <li>{@link FileWidget#SAVE_STYLE}</li>
* <li>{@link FileWidget#DIRECTORY_STYLE}</li>
* </ul>
* @return The {@link File} chosen by the user, or null if prompt is not
* available
*/
default File chooseFile(final File file, final String style) {
final String title;
// style can be a string with multiple comma-separated keywords
if (style == null) title = "Choose a file";
else if (WidgetStyle.isStyle(style, FileWidget.DIRECTORY_STYLE)) title = "Choose a directory";
else if (WidgetStyle.isStyle(style, FileWidget.FILE_AND_DIRECTORY_STYLE)) title = "Choose a file or directory";
else if (WidgetStyle.isStyle(style, FileWidget.OPEN_STYLE)) title = "Open";
else if (WidgetStyle.isStyle(style, FileWidget.SAVE_STYLE)) title = "Save";
else title = "Choose a file";
return chooseFile(title, file, style);
}
/**
* Prompts the user to choose a file.
*
* @param title Title to use in the file chooser dialog.
* @param file The initial value displayed in the file chooser prompt.
* @param style The style of chooser to use:
* <ul>
* <li>{@link FileWidget#OPEN_STYLE}</li>
* <li>{@link FileWidget#SAVE_STYLE}</li>
* <li>{@link FileWidget#DIRECTORY_STYLE}</li>
* <li>{@link FileWidget#FILE_AND_DIRECTORY_STYLE}</li>
* </ul>
* @return The {@link File} chosen by the user, or null if prompt is not
* available
*/
default File chooseFile(String title, File file, String style) {
throw new UnsupportedOperationException();
}
/**
* Prompts the user to choose a list of files.
*
* @param parent Parent folder for file selection
* @param files The initial value displayed in the file chooser prompt.
* @param filter A filter allowing to restrict file choice.
* @param style File selection style (files, directories, or both) and optional filters
* @return The selected {@link File}s chosen by the user, or null if the
* user cancels the prompt.
*/
default File[] chooseFiles(File parent, File[] files, FileFilter filter, String style) {
throw new UnsupportedOperationException();
}
/**
* Prompts the user to choose a list of files.
*
* @param parent Parent folder for file selection
* @param fileList The initial value displayed in the file chooser prompt.
* @param filter A filter allowing to restrict file choice.
* @param style File selection style (files, directories, or both) and optional filters
* @return The selected {@link File}s chosen by the user, or null if the
* user cancels the prompt.
*/
default List<File> chooseFiles(File parent, List<File> fileList, FileFilter filter, String style) {
final File[] initialFiles = fileList.toArray(new File[fileList.size()]);
final File[] chosenFiles = chooseFiles(parent, initialFiles, filter, style);
return chosenFiles == null ? null : Arrays.asList(chosenFiles);
}
/**
* Displays a popup context menu for the given display at the specified
* position.
*/
void showContextMenu(String menuRoot, Display<?> display, int x, int y);
/** Persists the application frame's current location. */
void saveLocation();
/** Restores the application frame's current location. */
void restoreLocation();
/** Returns true if this UI requires the EDT. */
boolean requiresEDT();
}