HierarchyGrid.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.hierarchy;
 
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.TreeMap;
import org.turro.zkoss.grid.PagingGrid;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zul.Hlayout;
import org.zkoss.zul.Row;
import org.zkoss.zul.Rows;
import org.zkoss.zul.Space;
import org.zkoss.zul.Toolbarbutton;
 
public abstract class HierarchyGrid extends PagingGrid {
  
  private Collection<Hierarchical> items;
  private Map<Hierarchical, Boolean> breakdown;
  private int showBreakdownLevel;
 
  public void setCollection(Collection<Hierarchical> items, int showBreakdownLevel) {
    this.showBreakdownLevel = showBreakdownLevel;
    this.items = items;
    addRows();
  }
  
  protected void addRows() {
    Rows rows = getRows(true);
    rows.getChildren().clear();
    
    breakdown = new TreeMap<Hierarchical, Boolean>();
    
    for(Hierarchical value : items) {
      processValue(value);
    }
 
    refreshRows();
    
    setRowCount(rows.getChildren().size());
  }
 
  private void processValue(Hierarchical value) {
    Row row = new Row();
    row.setValue(value);
    
    getRows().appendChild(row);
    
    breakdown.put(value, showBreakdownLevel <= 0 || getLevel(value) < showBreakdownLevel);
    
    if(value.children() != null) {
      for(Iterator it = value.children().iterator(); it.hasNext();) {
        Object obj = it.next();
        if(obj instanceof Collection) {
          for(Object o : (Collection) obj) {
            processValue((Hierarchical) o);
          }
        } else {
          processValue((Hierarchical) obj);
        }
      }
    }
 
  }
 
  protected void refreshRows() {
    for(Object row : getRows().getChildren()) {
      if(row instanceof Row) {
        if(((Row) row).getValue() instanceof Hierarchical) {
          ((Row) row).setVisible(isVisible((Hierarchical) ((Row) row).getValue()));
          ((Row) row).getChildren().clear();
          refreshValue((Row) row, (Hierarchical) ((Row) row).getValue());
        }
      }
    }
  }  
 
  protected Hlayout getNameLayout(final Hierarchical value) {
    Hlayout hbox = new Hlayout();
    Space s = new Space();
    s.setWidth(getLevel(value) * 15 + "px");
    hbox.appendChild(s);
 
    if(value.children() != null && !value.children().isEmpty()) {
      Toolbarbutton bd = new Toolbarbutton();
      bd.setImage(getBreakdownImage(value));
      bd.addEventListener(Events.ON_CLICK, new EventListener() {
        @Override
        public void onEvent(Event event) throws Exception {
          changeBreakdownState(value);
          refreshRows();
        }
      });
      hbox.appendChild(bd);
    }
    
    return hbox;
  }
 
  protected abstract void refreshValue(Row row, Hierarchical value);
  
  protected String getBreakdownImage(Hierarchical value) {
    if(isShowBreakdown(value)) {
      return "/_zul/images/breakdown-open.png";
    } else {
      return "/_zul/images/breakdown-closed.png";      
    }
  }
  
  protected void changeBreakdownState(Hierarchical value) {
    breakdown.put(value, !isShowBreakdown(value));
  }
  
  protected boolean isShowBreakdown(Hierarchical value) {
    return breakdown.get(value);
  }
  
  protected boolean isVisible(Hierarchical value) {
    Hierarchical tmp = (Hierarchical) value.parent();
    while(tmp != null) {
      if(!isShowBreakdown(tmp)) {
        return false;
      }
      tmp = (Hierarchical) tmp.parent();
    }
    return true;
  }
 
  private int getLevel(Hierarchical value) {
    int count = 0;
    while((value = (Hierarchical) value.parent()) != null) {
      count++;
    }
    return count;
  }
  
}