Section 9. Sort elements in a package tree
This help article describes the use of eaUtils sorting features on a package tree to sort elements contained in each selected package by alias, stereotype, tagged value, name or object id (note: the package tree sorting feature was introduced in version 1.11).
This feature runs from a package selected from the Project Browser. Once launched, it displays the package tree for the selected package, where sub packages must be selected so their elements' order is updated accordingly. If the selected package doesn't contain any sub package, the standard sorting dialog window is displayed.
Enable the Package Tree in eaUtils settings
By default the Package Tree setting is disabled i.e. eaUtils sorting features can be run on a selected package or element.
To use the package tree sorting feature, eaUtils settings must be modified: open the Sort By tab, and enable "Process the package tree" option as shown below.
eaUtils package tree sorting
Having the package tree setting enabled, this feature can be used via a right click on the main package > Extensions > eaUtils > [Browser] Sort elements.
eaUtils addin opens the following dialog window (unless the package doesn't contain any child package), prompting to select the packages to process within the current tree, i.e. the package and its sub packages:
Below is a summary of the available actions or information:
- Sorting option: select between Alias, Name, Stereotype, and Tagged Value
- Status: set to Ready unless the elements sorting is running, in which case the status is set to Busy.
- eaUtils settings: a summary of the sorting settings values is displayed. A button is available to open eaUtils Settings if needed.
- Select all/none: enable or disable all packages within the displayed tree.
- Tree: packages within the tree are displayed and can be individually enabled or disabled. Any locked package is greyed out and followed by (Locked), see below.
- Note: Root nodes are always disabled and marked as locked as they never contain elements to sort.
- Sort elements in the selected packages by...: run the elements sorting within each selected package.
- Cancel: close this window.
If none of the packages has been selected, the following error message is displayed.
Once sorting option is defined (e.g. Alias), and the package selection is complete, click on the Sort elements button and confirm the prompt window.
Whilst eaUtils sorting by feature is running, the progress is updated as packages are processed.
Once completed, all selected packages are marked as DONE, and a confirmation dialog is displayed (clicking OK closes all windows).