-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathUIDetails.java
More file actions
127 lines (106 loc) · 4.18 KB
/
UIDetails.java
File metadata and controls
127 lines (106 loc) · 4.18 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
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2016 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* 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;
/**
* An interface defining details useful for generating relevant user interface
* elements.
*
* @author Curtis Rueden
*/
public interface UIDetails extends BasicDetails, Prioritized {
/**
* The default, application-level menu root.
*
* @see #getMenuRoot()
*/
String APPLICATION_MENU_ROOT = "app";
/**
* Gets an appropriate title for the object, for use in a user interface. The
* result is prioritized as follows:
* <ol>
* <li>Item label</li>
* <li>Menu path's leaf entry name</li>
* <li>Item name</li>
* <li>Item's class name, without package prefix</li>
* </ol>
*/
String getTitle();
/** Gets the path to the object's suggested position in the menu structure. */
MenuPath getMenuPath();
/** Gets the name of the menu structure to which the object belongs. */
String getMenuRoot();
/** Gets the resource path to an icon representing the object. */
String getIconPath();
/**
* Gets whether the object can be selected (e.g., checking and unchecking its
* menu item) in the user interface.
*/
boolean isSelectable();
/**
* Gets the name of the selection group to which the object belongs. Only one
* object in a particular selection group can be selected at a time.
*/
String getSelectionGroup();
/**
* Gets whether the object is selected (e.g., its menu item is checked) in the
* user interface.
*/
boolean isSelected();
/** Gets whether the object should be enabled in the user interface. */
boolean isEnabled();
/** Gets whether the object should be visible in the user interface. */
boolean isVisible();
/** Sets the path to the object's suggested position in the menu structure. */
void setMenuPath(MenuPath menuPath);
/** Sets the name of the menu structure to which the object belongs. */
void setMenuRoot(String menuRoot);
/** Sets the resource path to an icon representing the object. */
void setIconPath(String iconPath);
/** Sets whether the object should be enabled in the user interface. */
void setEnabled(boolean enabled);
/** Sets whether the object should be visible in the user interface. */
void setVisible(boolean visible);
/**
* Sets whether the object can be selected (e.g., checking and unchecking its
* menu item) in the user interface.
*/
void setSelectable(boolean selectable);
/**
* Sets the name of the selection group to which the object belongs. Only one
* object in a particular selection group can be selected at a time.
*/
void setSelectionGroup(String selectionGroup);
/**
* Sets whether the object is selected (e.g., its menu item is checked) in the
* user interface.
*/
void setSelected(boolean selected);
}