The projects implements HTML and JSP clients of the Common Palette. The content and functionality is described in the J2EE Palette Item UI Specification.
Question (arch-overall): Describe the overall architecture. Answer:
The API provides support for developing palette items for HTML and JSP editors plugable into the Common Palette.
The palette item is described in the item definition file. It has .j2ee_palette_item extension and current
implementation uses custom data loader to create custom data object from it. The definition contains information
needed by Common Palette to show it (name, description and icons) and optional information about default body.
There is also possibility to place the instance reference of the custom insertable into the definition.
Each insertable must implement the J2EEPaletteItemInsertable interface.
The architecture now also contains drop target implementation (via TransferHandler) and it will be replaced by
the implementation in the cloneable editor. Thus DnD part of the architecture will be clarified after
this replacement.
Insertion begins when user single-/double- clicks the item button in the palette or drops the dragged palette
above the editor.
The Common Palette framework passes the Lookup instance to the code handling item insertion.
This Lookup instance is asked for the insertable class (J2EEPaletteItemInsertable) and the call is propagated
to the data object - J2EEPaletteItemDataObject.getCookie().
The instance returned from the data object is either the the custom insertable delivered by the item or null.
In the latter case, the default insertable implementation is used.
Then J2EEPaletteItemInsertable.insert(targetComponent, customizeIfPossible) is called on the instance.
The second boolean parameter is supposed to be used for a decision whether to run an customization or not.
It is set to true when SHIFT modifier is pressed during the mouse operations.
About 2 weeks remain.
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented? Answer:There will be some unit tests. Better item definition validation should be also introduced.
Question (arch-where): Where one can find sources for your module? Answer:OpenAPIs, ProjectAPI and Common Palette API.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on? Answer:None
Question (dep-platform): On which platforms does your module run? Does it run in the same way on each? Answer:No platform dependencies.
Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)? Answer:XXX no answer for dep-jre
Question (dep-jrejdk): Do you require the JDK or is the JRE enough? Answer:XXX no answer for dep-jrejdk
XXX no answer for deploy-jar
Question (deploy-nbm): Can you deploy an NBM via the Update Center? Answer:XXX no answer for deploy-nbm
Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere? Answer:XXX no answer for deploy-shared
Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public? Answer:Only API packages are made public.
Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one? Answer:XXX no answer for deploy-dependencies
I18n will be done during implementation.
Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow? Answer:No
Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version? Answer:XXX no answer for compat-version
java.io.File
directly?
Answer:
XXX no answer for resources-file
Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components? Answer:XXX no answer for resources-layer
Question (resources-read): Does your module read any resources from layers? For what purpose? Answer:XXX no answer for resources-read
Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers? Answer:XXX no answer for resources-mask
org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
J2EEPaletteItemDataObject overrides method DataObject.getCookie(Class) so that J2EEPaletteItemInsertable instance is returned when for J2EEPaletteItemInsertable.class is given as the parameter.
Question (lookup-register): Do you register anything into lookup for other code to find? Answer:XXX no answer for lookup-register
Question (lookup-remove): Do you remove entries of other modules from lookup? Answer:XXX no answer for lookup-remove
System.getProperty
) property?
Answer:
XXX no answer for exec-property
Question (exec-component): Is execution of your code influenced by any (string) property of any of your components? Answer:XXX no answer for exec-component
Question (exec-ant-tasks): Do you define or register any ant tasks that other can use? Answer:XXX no answer for exec-ant-tasks
Question (exec-classloader): Does your code create its own class loader(s)? Answer:XXX no answer for exec-classloader
Question (exec-reflection): Does your code use Java Reflection to execute other code? Answer:XXX no answer for exec-reflection
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection? Answer:XXX no answer for exec-privateaccess
Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code? Answer:XXX no answer for exec-process
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof
,
work with java.lang.Class
, etc.)?
Answer:
XXX no answer for exec-introspection
Question (exec-threading): What threading models, if any, does your module adhere to? Answer:XXX no answer for exec-threading
Question (security-policy): Does your functionality require modifications to the standard policy file? Answer:XXX no answer for security-policy
Question (security-grant): Does your code grant additional rights to some other code? Answer:XXX no answer for security-grant
XXX no answer for format-types
Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop? Answer:XXX no answer for format-dnd
Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods onjava.awt.datatransfer.Transferable
?
Answer:
XXX no answer for format-clipboard
XXX no answer for perf-startup
Question (perf-exit): Does your module run any code on exit? Answer:XXX no answer for perf-exit
Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales? Answer:There is an open question necessity of using own DataLoader (J2EEPaletteItemDataLoader). Personally, I did not observed any performance regressions. Perhaps it should be later reimplemented with use of own node model implemented with help of the Filter Nodes.
Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle? Answer:No
Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc. Answer:XXX no answer for perf-mem
Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)? Answer:XXX no answer for perf-wakeup
Question (perf-progress): Does your module execute any long-running tasks? Answer:XXX no answer for perf-progress
Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas? Answer:XXX no answer for perf-huge_dialogs
Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic? Answer:XXX no answer for perf-menus
Question (perf-spi): How the performance of the plugged in code will be enforced? Answer:Just Javadoc recommendations.