SelectCheckboxMenu: Order of selected items not kept

[RedRobin84]

Greetings,

When using selectCheckboxMenu component (with attribute multiple="true"), after each item selection, the order of selected items in Collection resets exactly to order of the items in collection, thats used as available items to choose (in this case f:selectItems component)

E.g. use collection List 1,2,3,4, users chooses items in this order 4,3,2, but the result is stored as 2,3,4. I am situation, where I need exactly the order of items that was chosen by the user. Now I need to use workaround with ajax request event="change" and manually sort those elements in viewBean.

Could this be a new feature (new attribute keepOrder or something? Or is it a bug?

Thanks!

Environment

• PF Version: 8.0
• JSF + version: e.g. Mojarra 2.2.20 or MyFaces 2.3.9
• Affected browsers: e.g. Chrome, iOS, ALL

To Reproduce
Steps to reproduce the behavior:

1. User component selectCheckboxMenu
2. add atribute multiple="true"
3. Select few items and see its stored in different order than displayed

Expected behavior
Sequence of the elements user choose should be stored in order, thats displayed on screen.

[melloware]

Please provide an executable example using the PrimeFaces Test project.

It will help me debug the issue

[melloware]

Reproducer:
pf-8119.zip

The values are just submitted in the form in the order they are in the DOM currently.

[melloware]

cc @ltlBeBoy not sure if you want to look at this one too.

[ltlBeBoy]

@melloware Yes, I will take a look at.

[ltlBeBoy]

Maybe a hidden input with the selection order would do the job.
Because internally hidden checkboxes are used to submit the selected values. And the order of these checkboxes is according to the select item list.

[melloware]

Yep we need some sort of JS Array holding the order they were pushed into the list and then submit that array order to the backing bean.

[melloware]

OK changing the core component was too much of a nightmare and not worth it. So I added itemSelect event so now you can do this...

<p:ajax event="itemSelect" listener="#{checkboxView.onItemSelect}"/>
<p:ajax event="itemUnselect" listener="#{checkboxView.onItemUnselect}"/>

So now that you have an itemSelect and unselect you can track the order the items were clicked using AJAX.

    public void onItemSelect(SelectEvent event) {
        FacesMessage msg = new FacesMessage();
        msg.setSummary("Item selected: " + event.getObject().toString());
        msg.setSeverity(FacesMessage.SEVERITY_INFO);

        FacesContext.getCurrentInstance().addMessage(null, msg);
    }

    public void onItemUnselect(UnselectEvent event) {
        FacesMessage msg = new FacesMessage();
        msg.setSummary("Item unselected: " + event.getObject().toString());
        msg.setSeverity(FacesMessage.SEVERITY_INFO);

        FacesContext.getCurrentInstance().addMessage(null, msg);
    }