CollectionGrid.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.grid;
 
import java.util.Collection;
import org.zkoss.zk.ui.ext.AfterCompose;
import org.zkoss.zul.Row;
import org.zkoss.zul.Rows;
 
public abstract class CollectionGrid<V> extends EditableGrid<V> implements AfterCompose {
 
  private Collection<V> collection;
  protected Row dependingRow;
 
  public CollectionGrid() {
    super();
  }
 
  public CollectionGrid(Collection<V> collection) {
    super();
    this.collection = collection;
  }
 
  public Collection<V> getCollection() {
    return collection;
  }
 
  public void setCollection(Collection<V> collection) {
    this.collection = collection;
  }
 
  public void updateCollection(Collection<V> collection) {
    clearRows();
    setCollection(collection);
    afterCompose();
  }
 
  public Row getDependingRow() {
    return dependingRow;
  }
 
  public void setDependingRow(Row dependingRow) {
    this.dependingRow = dependingRow;
  }
 
  @Override
  public void clearTable() {
    super.clearTable();
    if(collection != null) {
      collection.clear();
    }
  }
 
  @Override
  public void deleteSelectedRow(Row row) {
    super.deleteSelectedRow(row);
    processDependingRow();
  }
 
  @Override
  protected void cellChanged(EditableCell editableCell, Object value) {
    super.cellChanged(editableCell, value);
    if(editableCell.getColumn() instanceof EditableColumn) {
      ChangeValueCallback cmd = ((EditableColumn) editableCell.getColumn()).getOnCheckDuplicate();
      if(cmd != null) {
        V current = editableCell.getRow().getValue();
        for(V v : collection) {
          if(value != null && v != null && !v.equals(current) && cmd.check(value, v)) break;
        }
      }
    }
  }
 
  @Override
  public void afterCompose() {
    addTableRows();
    super.afterCompose();
  }
 
  @Override
  protected void rowChanged(Row row) {
    processDependingRow();
  }
 
  protected boolean filterValue(V v) {
    return true;
  }
 
  private void addTableRows() {
    if(getRows() == null) {
      appendChild(new Rows());
    }
    boolean emptyLine = false;
    if(collection != null) {
      for(V v : collection) {
        if(filterValue(v)) {
          Row row = new Row();
          getRows().appendChild(row);
          initiateRow(row, v);
          emptyLine = emptyLine ? true : !isValid(v);
        }
      }
    }
    if(isAllowInsertions() && !emptyLine) {
      Row row = new Row();
      getRows().appendChild(row);
      row.setSclass("invalid");
      initiateRow(row, null);
    }
  }
 
  private void processDependingRow() {
    if(dependingRow != null && dependingRow.getGrid() instanceof EditableGrid) {
      ((EditableGrid) dependingRow.getGrid()).rowChanged(dependingRow);
    }
  }
 
}