CollectionListbox.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 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.Collection;
import org.turro.i18n.I_;
import org.turro.zkoss.label.LabelTypes;
import org.zkoss.zul.Listcell;
import org.zkoss.zul.Listitem;
import org.zkoss.zul.Vlayout;
 
public abstract class CollectionListbox<V> extends GenericListbox<V> {
 
  public static final String ITEM_SEPARATOR = "|||",
          ITEM_SEPARATOR_REGEX = "\\|\\|\\|",
          SUBITEM_SEPARATOR = "%%%",
          SUBITEM_SEPARATOR_REGEX = "\\%\\%\\%";
 
  private Collection<V> collection;
  private boolean allowNull, nullAtBottom;
  private String nullLabel = "None";
 
  public CollectionListbox() {
  }
 
  public CollectionListbox(Collection<V> collection) {
    this.collection = collection;
  }
 
  public void updateCollection() {
    clearItems();
    setCollection(collection);
    afterCompose();
  }
 
  public void updateCollection(Collection<V> collection) {
    clearItems();
    setCollection(collection);
    afterCompose();
  }
 
  public boolean isAllowNull() {
    return allowNull;
  }
 
  public void setAllowNull(boolean allowNull) {
    this.allowNull = allowNull;
  }
 
  public Collection<V> getCollection() {
    return collection;
  }
 
  public void setCollection(Collection<V> collection) {
    this.collection = collection;
  }
 
  public boolean isNullAtBottom() {
    return nullAtBottom;
  }
 
  public void setNullAtBottom(boolean nullAtBottom) {
    this.nullAtBottom = nullAtBottom;
  }
 
  public String getNullLabel() {
    return nullLabel;
  }
 
  public void setNullLabel(String nullLabel) {
    this.nullLabel = nullLabel;
  }
 
  @Override
  protected void populateList() {
    //setSizedByContent(true);
    clearItems();
    if(collection == null) return;
    if(allowNull && !nullAtBottom) {
      Listitem li = new Listitem("<" + I_.get(nullLabel) + ">", null);
      beforeAppend(li);
      appendChild(li);
    }
    int cells = 1;
    if(getListhead() != null && !getListhead().getChildren().isEmpty()) {
      cells = getListhead().getChildren().size();
    }
    for(V v : collection) {
      if(cells > 1) {
        String sa[] = convertToString(v).split(ITEM_SEPARATOR_REGEX);
        Listitem li = new Listitem();
        li.setValue(v);
        for(String s : sa) {
          String ssa[] = s.split(SUBITEM_SEPARATOR_REGEX);
          if(ssa.length > 1) {
            Listcell cell = new Listcell(ssa[0]);
            li.appendChild(cell);
            Vlayout vbox = new Vlayout();
            vbox.setStyle("padding:2px");
            for(int i = 1; i < ssa.length; i++) {
              vbox.appendChild(LabelTypes.getSoftLabel(ssa[i]));
            }
            cell.appendChild(vbox);
          } else {
            if(s != null && s.endsWith(SUBITEM_SEPARATOR)) {
              s = s.replaceAll(SUBITEM_SEPARATOR_REGEX, "");
            }
            li.appendChild(new Listcell(s));
          }
        }
        beforeAppend(li);
        appendChild(li);
      } else {
        Listitem li = new Listitem(convertToString(v), v);
        beforeAppend(li);
        appendChild(li);
      }
    }
    if(allowNull && nullAtBottom) {
      Listitem li = new Listitem("<" + I_.get(nullLabel) + ">", null);
      beforeAppend(li);
      appendChild(li);
    }
  }
 
  @Override
  protected boolean equals(V value, V obj) {
    String v1 = value == null ? null : convertToString(value);
    String v2 = obj == null ? null : convertToString(obj);
    return (v1 == null && v2 == null) ||
            (v1 != null && v1.equals(v2));
  }
 
  protected abstract String convertToString(V v);
  
  protected void beforeAppend(Listitem li) { /* do nothing */ }
 
}