CollectionCheckbox.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 java.util.HashSet;
import java.util.List;
import org.turro.zkoss.layout.VboxH;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.ext.AfterCompose;
import org.zkoss.zul.Checkbox;
 
public abstract class CollectionCheckbox<V> extends VboxH implements AfterCompose {
 
  private Collection<V> internalValues;
  protected boolean populated = false;
  private Collection<V> collection;
 
  public CollectionCheckbox() {
    super(0);
  }
 
  public CollectionCheckbox(Collection<V> collection) {
    super(0);
    this.collection = collection;
  }
 
  public void updateCollection() {
    clear();
    setCollection(collection);
    afterCompose();
  }
 
  public void updateCollection(Collection<V> collection) {
    clear();
    setCollection(collection);
    afterCompose();
  }
 
  public Collection<V> getCollection() {
    return collection;
  }
 
  public void setCollection(Collection<V> collection) {
    this.collection = collection;
  }
 
  protected void populateList() {
    //setSizedByContent(true);
    clear();
    if(collection == null) return;
    for(V v : collection) {
      Checkbox cb = new Checkbox(convertToString(v));
      cb.setAttribute("obj", v);
      addComponent(cb);
      cb.addEventListener(Events.ON_CHECK, new EventListener() {
        @Override
        public void onEvent(Event event) throws Exception {
          Events.postEvent(new Event(Events.ON_CHECK, CollectionCheckbox.this));
        }
      });
    }
  }
 
  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);
 
  public void setObjectValues(Collection<V> collection) {
    if(!populated) {
      internalValues = collection;
    }
    for(Component c : (List<Component>) getRealChildren()) {
      if(c instanceof Checkbox) {
        Checkbox cb = (Checkbox) c;
        cb.setChecked(false);
        for(V v : collection) {
          if(cb.getLabel().equals(convertToString(v))) {
            cb.setChecked(true);
            break;
          }
        }
      }
    }
  }
 
  public Collection<V> getObjectValues() {
    if(!populated) {
      return internalValues;
    }
    HashSet<V> set = new HashSet<V>();
    for(Component c : (List<Component>) getRealChildren()) {
      if(c instanceof Checkbox) {
        Checkbox cb = (Checkbox) c;
        if(cb.isChecked()) {
          set.add((V) cb.getAttribute("obj"));
        }
      }
    }
    return set;
  }
 
  @Override
  public void afterCompose() {
    if(!populated) {
      populateList();
      populated = true;
      if (internalValues != null) {
        setObjectValues(internalValues);
        internalValues = null;
      }
    }
  }
 
  @Override
  public void clear() {
    super.clear();
    populated = false;
  }
 
}