GenericCombobox.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 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.lang.reflect.ParameterizedType;
import java.util.LinkedList;
import org.turro.reflection.Reflections;
import org.turro.util.CompareUtil;
import org.zkoss.zul.Combobox;
import org.zkoss.zul.Comboitem;
import org.zkoss.zul.ComboitemRenderer;
import org.zkoss.zul.Constraint;
 
public abstract class GenericCombobox<V> extends Combobox implements ComboitemRenderer<Object> {
 
  private boolean allowNotInModelValues = true;
  private V currentValue;
 
  public GenericCombobox() {
    initComponent();
  }
 
  public V getObjectValue() {
    Class<V> genericClass = (Class<V>) ((ParameterizedType) getClass()
            .getGenericSuperclass()).getActualTypeArguments()[0];
    V value = null;
    if(Reflections.of(genericClass).canCast(String.class) && allowNotInModelValues) {
      // if String allow new values
      value = (V) getText();
    }
    Comboitem ci = getSelectedItem();
    if(ci != null) {
      value = ci.getValue();
    }
    if(value == null && allowNotInModelValues && currentValue != null) {
      if(getText().equals(getTextFromObject(currentValue))) {
        value = currentValue;
      }
    }
    return value;
  }
 
  public void setObjectValue(V value) {
    Constraint c = getConstraint();
    setConstraint((Constraint) null);
    currentValue = value;
    if(!selectObjectItem(value)) {
      setText(value != null ? getTextFromObject(value) : null);
    }
    setConstraint(c);
  }
 
  public boolean isAllowNotInModelValues() {
    return allowNotInModelValues;
  }
 
  public void setAllowNotInModelValues(boolean allowNotInModelValues) {
    this.allowNotInModelValues = allowNotInModelValues;
  }
 
  public void refreshModel() {
    Constraint c = getConstraint();
    setConstraint((Constraint) null);
    createModel();
    setConstraint(c);
  }
 
  private void createModel() {
    GenericComboModel ccm = new GenericComboModel(new Object[0]) {
      @Override
      public void populateList(String value, LinkedList list, int nRows) {
        GenericCombobox.this.populateList(value, list, nRows);
      }
    };
    setModel(ccm);
  }
 
  public abstract void populateList(String value, LinkedList list, int nRows);
  public abstract String getTextFromObject(V value);
 
  private void initComponent() {
    setItemRenderer(this);
    createModel();
  }
  
  private boolean selectObjectItem(V value) {
    if(value != null) {
      String str = getTextFromObject(value);
      for(Comboitem item : getItems()) {
        if(CompareUtil.compare(str, getTextFromObject(item.getValue())) == 0) {
          setSelectedItem(item);
          return true;
        }
      }
    }
    return false;
  }
  
  /* Related entity (zul attribute) */
  
  private Object relatedEntity;
 
  public Object getRelatedEntity() {
    return relatedEntity;
  }
 
  public void setRelatedEntity(Object relatedEntity) {
    this.relatedEntity = relatedEntity;
  }
  
  /* ComboitemRenderer */
  
  @Override
  public void render(Comboitem item, Object data, int index) throws Exception {
    item.setLabel(getTextFromObject((V) data));
    item.setValue(data);
  }
 
}