This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 171284 - Annotation to register Options dialog panels
Summary: Annotation to register Options dialog panels
Alias: None
Product: platform
Classification: Unclassified
Component: Options&Settings (show other bugs)
Version: 6.x
Hardware: All All
: P3 blocker (vote)
Assignee: Jesse Glick
Depends on: 172324 172844 178331 181885
  Show dependency tree
Reported: 2009-09-01 19:46 UTC by Jesse Glick
Modified: 2010-09-17 16:30 UTC (History)
5 users (show)

See Also:
Exception Reporter:

Start of proposed patch, incl. API changes and example usages (21.95 KB, patch)
2009-09-02 01:17 UTC, Jesse Glick
Details | Diff
Failed experiment (1.88 KB, patch)
2009-09-02 15:40 UTC, Jesse Glick
Details | Diff
Progress: renamed @SubRegistration, new id & location attrs, usage in php.project, two @Deprecation's, new LayerBuilder util method (34.79 KB, patch)
2009-09-02 17:40 UTC, Jesse Glick
Details | Diff
Attempt at processor test (37.73 KB, patch)
2009-09-03 00:12 UTC, Jesse Glick
Details | Diff
Now have @ContainerRegistration, used successfully in php.project (41.05 KB, patch)
2009-09-03 00:17 UTC, Jesse Glick
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2009-09-01 19:46:52 UTC
There should be a way to register Options dialog panels (incl. subpanels) declaratively using annotations.
Comment 1 Jesse Glick 2009-09-01 22:12:01 UTC
Will not support either OptionsCategory.createCategory with advancedOptionsFolder or
OptionsPanelController.createAdvanced until I get an answer to my question in issue #109538. Anyway there are only two
known usages of these two combined - Editor & PHP (and potentially a third in CND), so an annotation would not be very
Comment 2 Jesse Glick 2009-09-02 01:17:32 UTC
Created attachment 86946 [details]
Start of proposed patch, incl. API changes and example usages
Comment 3 Jesse Glick 2009-09-02 01:18:53 UTC
Please review.
Comment 4 Jiri Skrivanek 2009-09-02 10:38:51 UTC
JS01: Add @SubLevelRegistration with String topLevel(). Then @AdvancedRegistration is a shortcut for
@OptionsPanelController.SubLevelRegistration(topLevel = "Advanced",displayName = "#displayName").
Comment 5 Jesse Glick 2009-09-02 15:31:38 UTC
To JS01 - having a single @OPC.Registration with a category="..." attr (which could be a new constant ADVANCED_CATEGORY,
some other value such as "org-...-php-Whatever", or omitted for a top-level registration) would certainly be attractive
and simple to understand. But would it work identically? There are completely separate code paths for Advanced subpanels
as opposed to "regular" panels - is this only a historical accident that can now be ignored? I presume iconBase is
meaningful iff category is omitted?

Please excuse my ignorance, it just seems that the Options SPI has a lot of different ways of doing nearly the same
thing and it is not clear what may be obsolete.
Comment 6 Jesse Glick 2009-09-02 15:40:03 UTC
Created attachment 86975 [details]
Failed experiment
Comment 7 Jesse Glick 2009-09-02 15:41:36 UTC
JS01 cont'd - the last-attached patch does not work. "Tasks" is displayed as a top-level button with no icon, not in the
Miscellaneous panel.
Comment 8 Jesse Glick 2009-09-02 16:13:40 UTC
I think I see what you meant. core-main #197bb79bce9d shows AdvancedOption.createSubCategory working for PHP subpanels.
Comment 9 Jesse Glick 2009-09-02 17:40:29 UTC
Created attachment 86992 [details]
Progress: renamed @SubRegistration, new id & location attrs, usage in php.project, two @Deprecation's, new LayerBuilder util method
Comment 10 Jaroslav Tulach 2009-09-02 18:13:27 UTC
Nice cleanup. Y01 A test for the processor would be nice.
Comment 11 Jesse Glick 2009-09-03 00:12:04 UTC
Created attachment 87013 [details]
Attempt at processor test
Comment 12 Jesse Glick 2009-09-03 00:14:36 UTC
Y01 - I tried rewriting the test to use the annotation-produced registrations. No luck so far (various errors I don't
really understand). The existing test uses old styles of registration and it is not trivial to update it to understand
panels created by factory methods. Maybe someone with better knowledge of the module's internals would be able to do it.
Comment 13 Jesse Glick 2009-09-03 00:17:57 UTC
Created attachment 87014 [details]
Now have @ContainerRegistration, used successfully in php.project
Comment 14 Jaroslav Tulach 2009-09-03 07:04:55 UTC
Re. Y01: I do not recommend to change (and thus destroy) the existing test. It shall still test what it used to, as 
that remains valid use of the API. I thought you will create new test (possibly based on the copy of previous) to 
cover the new stuff with annotations. I would verify that @registration really registers something (which can be 
created and looks sane) and also that processor correctly detects inconsistencies in annotations (for example 
keywordCategory specified but no keywords yields an error).
Comment 15 Jaroslav Tulach 2009-09-03 07:14:01 UTC
Y02 Really tentative. You seem to enjoy improving the option system quite a lot. When you are at it, you could also 
look at issue 166871. You have the knowledge of option categories, me and Pavel Flaška can provide info about the rest 
(probably elsewhere, not in this issue). It would be good to have another person with experience with the static 
analysis and dynamic verification. If you are interested, let us know. Otherwise ignore this offer.
Comment 16 Quality Engineering 2009-09-03 08:43:57 UTC
Integrated into 'main-golden', will be available in build *200909021401* on (upload may still be in progress)
User: Jesse Glick <>
Log: Lazy-load capability for option panels.
Currently seems to help only for those advanced subpanels using AdvancedOption.createSubCategory.
Many advanced subpanels currently have an explicit OptionsPanelController impl, though that is their fault (cf. #171284).
Does not work yet for main panels; principal problem seems to be eager merging of OPC.lookup's into mainLookup.
Comment 17 Jiri Skrivanek 2009-09-03 09:42:10 UTC
Re. desc6: I must admit there are duplicates in code. Possibly all in options.advanced have a counterpart in new
"tabbed" infrastructure (e.g. AdvancedPanelController vs. TabbedController). But in options.advanced there might be some
fixes which are not in "tabbed". If options.advanced is removed, then it must be carefully checked that everything works
as before. There are not enough tests to rely just on them.
Comment 18 Jesse Glick 2009-09-03 16:05:52 UTC
Y01 - OK. The existing test continues to pass, as I am not changing anything that was there before. Can make another
attempt to write a test checking the runtime behavior of anno-registered panels, though it does not appear
straightforward to find these from the API side. Testing negative aspects of the processor is of course straightforward,
though there is not a lot to test since it is nearly a 1-1 translation from the annotations.

desc6 discussion - I was certainly not proposing to remove/deprecate options.advanced myself, though someone more
knowledgeable could attempt it. Despite the obvious similarities there are various subtle differences. For example,
Advanced subpanels are organized alphabetically, not by SFS position. Anyway it seems so far that the current set of
three annotations suffices to cover the use cases with no visible change in functionality (still TBD whether the CND
top-level panel can be rewritten to follow the normal pattern).
Comment 19 Quality Engineering 2009-09-03 18:11:26 UTC
Integrated into 'main-golden', will be available in build *200909030951* on (upload may still be in progress)
User: Jesse Glick <>
Log: Can use AdvancedOption.createSubCategory rather than extending AdvancedOption.
(Hinted at in #171284.)
Comment 20 Vladimir Voskresensky 2009-09-07 11:33:20 UTC
I'm fine to change CND's approach (introduced in days when only Advanced tab had registration mechanism). Let me now
where to look at for the "right" impl. 
Or if you can provide patch => I can test it.
Comment 21 Jesse Glick 2009-09-09 19:57:42 UTC
Simplified CND options in core-main #27e35ca9221f. No apparent use of OptionsDisplayer. Displays correctly, OK stores
correctly, Help shows right page.
Comment 22 Quality Engineering 2009-09-11 21:44:26 UTC
Integrated into 'main-golden', will be available in build *200909111401* on (upload may still be in progress)
User: Jesse Glick <>
Log: Modernizing Options subpanel for CND. (Mentioned in #171284.)
Comment 23 Jesse Glick 2009-09-15 03:05:05 UTC
core-main #f8f73cf077bc
Comment 24 Quality Engineering 2009-09-18 22:27:19 UTC
Integrated into 'main-golden', will be available in build *200909181401* on (upload may still be in progress)
User: Jesse Glick <>
Log: Issue #171284: register Options dialog panels declaratively.
Using new annotations in some representative modules.