GenericTree.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.tree;
 
import java.util.Collection;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.ext.AfterCompose;
import org.zkoss.zul.Tree;
import org.zkoss.zul.Treechildren;
import org.zkoss.zul.Treeitem;
 
public abstract class GenericTree<V> extends Tree implements AfterCompose {
 
  private boolean selectFirst = true;
  private V internalValue;
//  private Collection<V> internalValues;
  protected boolean populated = false;
 
  @Override
  public void afterCompose() {
    populateList();
    populated = true;
    if(internalValue != null) {
      setObjectValue(internalValue);
      internalValue = null;
//    } else if (internalValues != null) {
//      setObjectValues(internalValues);
//      internalValues = null;
    } else {
      setObjectValue(null);
    }
  }
 
  public void clearItems() {
    getItems().clear();
    populated = false;
  }
 
  public void setObjectValue(V value) {
    if(!populated) {
      internalValue = value;
    }
    if(value == null && selectFirst && getItemCount() > 0) {
      setSelectedFirstItem();
    } else {
      for(Object item : getItems()) {
        if(item instanceof Treeitem) {
          if(equals((V) ((Treeitem) item).getValue(), (V) value)) {
            setSelectedItem((Treeitem) item);
          }
        }
      }
    }
  }
 
//  public void setObjectValues(Collection<V> collection) {
//    if(!populated) {
//      internalValues = collection;
//    }
//    setSelectedItems(new ValueTreeitemAdapter<V>(this, collection) {
//      @Override
//      protected boolean equals(V value, V obj) {
//        return GenericTree.this.equals(value, obj);
//      }
//    });
//  }
 
  public V getObjectValue() {
    if(!populated) {
      return internalValue;
    }
    Treeitem li = getSelectedItem();
    if(li != null && li.getValue() != null) {
      return (V) li.getValue();
    }
    return null;
  }
 
//  public Collection<V> getObjectValues() {
//    if(!populated) {
//      return internalValues;
//    }
//    return new TreeitemValueAdapter<V>(getSelectedItems(), true);
//  }
 
  public void selectItemByText(String text) {
    if(text != null && text.length() > 3) {
      for(Object item : getItems()) {
        if(item instanceof Treeitem) {
          String l = ((Treeitem) item).getLabel();
          if(l.toLowerCase().contains(text.toLowerCase())) {
            setSelectedItem((Treeitem) item);
            showItem((Treeitem) item);
            Events.postEvent(new Event(Events.ON_SELECT, GenericTree.this));
          }
        }
      }
    }
  }
 
  public void showItem(Treeitem item) {
    while(item != null) {
      item.setOpen(true);
      item = item.getParentItem();
    }
  }
 
  protected boolean equals(V value, V obj) {
    return (value == null && obj == null) ||
            (value != null && value.equals(obj));
  }
 
  protected void addTreeitem(Treeitem parent, Treeitem child) {
    if(parent.getTreechildren() == null) {
      parent.appendChild(new Treechildren());
    }
    parent.getTreechildren().appendChild(child);
  }
 
  protected abstract void populateList();
 
  private void setSelectedFirstItem() {
    for(Treeitem ti : (Collection<Treeitem>) getItems()) {
      if(ti.getValue() != null) {
        setSelectedItem(ti);
        break;
      }
    }
  }
 
}