Fix bug #756 and improve function sorting a bit

[dportnoy15]

Avoid hiding property accessors under some groupings, sort functions by their display name instead of their Java name, and sort functions alphabetically under each return type

[dportnoy15]

I also looked a lot into how sorting is done for each of the different groupings, and would like to discuss it to see whether any of it is worth changing

[dabeshouse]

I also looked a lot into how sorting is done for each of the different groupings, and would like to discuss it to see whether any of it is worth changing

Having arbitrary ordering within groups is a little unpleasant. They could be secondarily alpha ordered.

Joints ordered by hierarchy would be nice to have, but that may be too much of a pain.

[dportnoy15]

Here's what I found about the sorting order for functions (specifically when selecting the Scene, i.e. "this"):

Sort Alphabetically:

• obviously, sorted alphabetically, although I changed it to use display name instead of java name for the sort

Sort Ny Return Type:

• it currently sorts the return types themselves using a hard-coded order, with java types first, followed the Tweedle (?) types, such as SThing, etc. (see StoryApiConfigurationManager.TypeComparator)
  • This probably makes sense, but we could change it if we want, esp. since users who don't know Java might be confused about the sort
• I made it sort alphabetically (using the display name) within return types

Sort By Category:

• the sort order for categories is:
  1. the Scene's editable functions
     • methods are listed first, followed by field getters and setters, see UserMethodsSubComposite.getMethods()
     • getSubCompositesByCategory just returns the UserMethodsSubComposite instance, without calling getMethods() itself
     • We could call getMethods() directly and create a new SubComposite, if we want to change this sort order
  2. a hard-coded list of categories, whose order is defined by categoryFunctionSubComposites and categoryOrAlphabeticalFunctionSubComposites in StoryApiConfigurationManager
     • The per-category order is defined (mostly) by a hard-coded list of function names in the class constructors for the classes associated with these categories, e.g. AtmosphereFunctionsComposite
     • Looks like Joint functions (the only composite in categoryOrAlphabeticalFunctionSubComposites) are alpha sorted
  3. "other" methods, which are alpha sorted by getName(). would be easy to also change to use display name

THere's also probably parallel logic for sorting procedures, but I didn't look at that

[dabeshouse]

Thanks for the detailed descriptions.

I think aim for using display name alpha ordering within all groupings in both functions and procedures, and address the code review suggestions.

No need for other reorderings, either for pedagogical reasons, or what we might think is clarifying.