DualSelectorListbox.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2012 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.zkoss.input;
 
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.IdSpace;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.select.Selectors;
import org.zkoss.zk.ui.select.annotation.Listen;
import org.zkoss.zk.ui.select.annotation.Wire;
import org.zkoss.zul.Div;
import org.zkoss.zul.ListModelList;
import org.zkoss.zul.Listbox;
import org.zkoss.zul.Listitem;
import org.zkoss.zul.ListitemRenderer;
import org.zkoss.zul.ext.Selectable;
 
public abstract class DualSelectorListbox<T> extends Div implements IdSpace, ListitemRenderer<T> {
 
  @Wire
  private Listbox candidateLb;
  @Wire
  private Listbox chosenLb;
  
  private ListModelList<T> optionsModel;
  private ListModelList<T> selectedModel;
 
  public DualSelectorListbox() {
    Executions.createComponents("/WEB-INF/_zul/bs/comps/dualSelector/dualSelectorListbox.zul", this, null);
    Selectors.wireComponents(this, this, false);
    Selectors.wireEventListeners(this, this);
    chosenLb.setModel(selectedModel = new ListModelList<T>());
    if(chosenLb.getModel() instanceof Selectable) {
      ((Selectable) chosenLb.getModel()).setMultiple(true);
    }
    candidateLb.setItemRenderer(this);
    chosenLb.setItemRenderer(this);
  }
 
  @Listen("onClick = #chooseBtn")
  public void chooseItem() {
    Events.postEvent(new ChooseEvent(this, chooseOne()));
  }
 
  @Listen("onClick = #removeBtn")
  public void unchooseItem() {
    Events.postEvent(new ChooseEvent(this, unchooseOne()));
  }
 
  @Listen("onClick = #chooseAllBtn")
  public void chooseAllItem() {
    for (int i = 0, j = optionsModel.getSize(); i < j; i++) {
      selectedModel.add(optionsModel.getElementAt(i));
    }
    optionsModel.clear();
  }
 
  @Listen("onClick = #removeAllBtn")
  public void unchooseAll() {
    for (int i = 0, j = selectedModel.getSize(); i < j; i++) {
      optionsModel.add(selectedModel.getElementAt(i));
    }
    selectedModel.clear();
  }
 
  @Listen("onClick = #topBtn")
  public void top() {
    int i = 0;
    Iterator<T> iterator = new LinkedHashSet<T>(selectedModel.getSelection()).iterator();
    while (iterator.hasNext()) {
      T selectedItem = iterator.next();
      selectedModel.remove(selectedItem);
      selectedModel.add(i++, selectedItem);
      selectedModel.addToSelection(selectedItem);
    }
    Events.postEvent(new ChooseEvent(this, null));
  }
 
  @Listen("onClick = #upBtn")
  public void up() {
    Set<T> selected = selectedModel.getSelection();
    if (selected.isEmpty()) {
      return;
    }
    int index = selectedModel.indexOf(selected.iterator().next());
    if (index == 0 || index < 0) {
      return;
    }    
    ArrayList<T> clone = (ArrayList<T>) new ArrayList<T>(selected).clone();
    selectedModel.removeAll(selected);
    selectedModel.addAll(--index, clone);
    for(T selectedItem : clone) {
      selectedModel.addToSelection(selectedItem);
    }
    Events.postEvent(new ChooseEvent(this, null));
  }
 
  @Listen("onClick = #downBtn")
  public void down() {
    Set<T> selected = selectedModel.getSelection();
    if (selected.isEmpty()) {
      return;
    }
    int index = selectedModel.indexOf(selected.iterator().next());
    if (index == selectedModel.size() - selected.size() || index < 0) {
      return;
    }
    ArrayList<T> clone = (ArrayList<T>) new ArrayList<T>(selected).clone();
    selectedModel.removeAll(selected);
    selectedModel.addAll(++index, clone);
    for(T selectedItem : clone) {
      selectedModel.addToSelection(selectedItem);
    }
    Events.postEvent(new ChooseEvent(this, null));
  }
 
  @Listen("onClick = #bottomBtn")
  public void bottom() {
    Iterator<T> iterator = new LinkedHashSet<T>(selectedModel.getSelection()).iterator();
    while (iterator.hasNext()) {
      T selectedItem = iterator.next();
      selectedModel.remove(selectedItem);
      selectedModel.add(selectedItem);
      selectedModel.addToSelection(selectedItem);
    }
    Events.postEvent(new ChooseEvent(this, null));
  }
 
  public void setModel(List<T> candidate) {
    candidateLb.setModel(this.optionsModel = new ListModelList<T>(candidate));
    selectedModel.clear();
    if(candidateLb.getModel() instanceof Selectable) {
      ((Selectable) candidateLb.getModel()).setMultiple(true);
    }
  }
 
  public List<T> getChosenDataList() {
    return new ArrayList<T>(selectedModel);
  }
 
  private Set<T> chooseOne() {
    Set<T> set = optionsModel.getSelection();
    selectedModel.addAll(set);
    optionsModel.removeAll(set);
    return set;
  }
 
  private Set<T> unchooseOne() {
    Set<T> set = selectedModel.getSelection();
    optionsModel.addAll(set);
    selectedModel.removeAll(set);
    return set;
  }
 
  @Override
  public void render(Listitem item, T data, int index) throws Exception {
    doRender(item, data, index);
  }
 
  protected abstract void doRender(Listitem item, T data, int index);
 
  // Customized Event
  public class ChooseEvent extends Event {
    public ChooseEvent(Component target, Set<T> data) {
      super("onChoose", target, data);
    }
  }
}