While reading the diffs I have found that the
documentation is not absolutelly up-to-date.
1. please use <api> tag for description of all
properties in arch-propertysheet.xml (for example
radioButtonTrashhold is missing).
2. I have seen a lot of properties tested (and
thanks for that), but not documented. For example,
I wonder what is "postSetAction" as I could not
find its documentation anywhere.
"postSetAction" is an enhancement I put in specifically so the form
editor could stop using EnhancedPropertyEditor. They use it so they
can listen to the combo box and open the editor on an event method,
only if the *user* sets the property value. Otherwise they might
set the editor position just because something programmatically set
the value of the property.
So, now, if your property provides an implementation of Action via
getValue("postSetAction"), that code will be run if and only if the
user explicitly sets the property value.
It is an open question whether "postSetAction" should remain
undocumented (but tested) as a friend contract, or should be made
public. I'm guessing it can do no harm as long as we document it as
not necessarily permanently supported.
Will attach a revised diff.
Jarda, I'm not exactly sure where and how I should be using API tags
in this doc. Can you advise?
Created attachment 12443 [details]
Revised diff of api & arch docs
Marking this issue as fixed - if you still feel the docs aren't
sufficient, reopen. And do advise where and how to use the <api> tag
- we could probably just do this together on Monday.
Info about using the API tags can be found here:
if you edit the XML in NetBeans you will get code completion.
postSetAction can be friend contract. Just document that in the
Closing per our agreement - Jarda, we'll do the API tags thing when
I get to the office.
Please use javax.swing.UIManager group.
Also are you sure you really want friend category:
It means that there are component's that are really using this
properties, you know about them and you will notify them if you change
the contract. Stuff like netbeans.ps.combohack or
netbeans.reusable.strictthreads looks like private impl. detail while
flat could be deprecated. Please rething and review that as well.