33
33
34
34
import java .util .List ;
35
35
36
+ import org .scijava .display .event .DisplayCreatedEvent ;
37
+ import org .scijava .display .event .DisplayDeletedEvent ;
36
38
import org .scijava .event .EventService ;
37
39
import org .scijava .object .ObjectService ;
38
40
import org .scijava .plugin .PluginInfo ;
@@ -114,7 +116,13 @@ <DT extends Display<?>> List<PluginInfo<DT>> getDisplayPluginsOfType(
114
116
boolean isUniqueName (String name );
115
117
116
118
/**
117
- * Creates a display for the given object.
119
+ * Creates a display for the given object, publishing a
120
+ * {@link DisplayCreatedEvent} to notify interested parties. In particular:
121
+ * <ul>
122
+ * <li>Visible UIs will respond to this event by showing the display.</li>
123
+ * <li>The {@link ObjectService} will add the new display to its index, until
124
+ * a corresponding {@link DisplayDeletedEvent} is later published.</li>
125
+ * </ul>
118
126
*
119
127
* @param o The object for which a display should be created. The object is
120
128
* then added to the display.
@@ -129,7 +137,13 @@ <DT extends Display<?>> List<PluginInfo<DT>> getDisplayPluginsOfType(
129
137
Display <?> createDisplay (Object o );
130
138
131
139
/**
132
- * Creates a display for the given object.
140
+ * Creates a display for the given object, publishing a
141
+ * {@link DisplayCreatedEvent} to notify interested parties. In particular:
142
+ * <ul>
143
+ * <li>Visible UIs will respond to this event by showing the display.</li>
144
+ * <li>The {@link ObjectService} will add the new display to its index, until
145
+ * a corresponding {@link DisplayDeletedEvent} is later published.</li>
146
+ * </ul>
133
147
*
134
148
* @param name The name to be assigned to the display.
135
149
* @param o The object for which a display should be created. The object is
0 commit comments