PagingGrid.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.io.ByteArrayOutputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.Strings;
import org.turro.command.Command;
import org.turro.command.Context;
import org.turro.elephant.context.ElephantContext;
import org.turro.i18n.I_;
import org.turro.zkoss.dialog.InputDialog;
import org.turro.zkoss.dialog.InputField;
import org.zkoss.exporter.pdf.PdfExporter;
import org.zkoss.util.media.AMedia;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.HtmlBasedComponent;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zul.*;
 
public class PagingGrid extends Grid {
 
  private int maxResults = 30;
  private String pagingMold = "default", refineValue = null;
  private String varColumns;
  private boolean defaultBehavior = true;
 
  public void setColumns(int columns) {
    setSpan(true);
    Columns cols = new Columns();
    for(int i = 0; i < columns; i++) {
      Column col = new Column();
      col.setHflex("min");
      cols.appendChild(col);
    }
    appendChild(cols);
  }
 
  public void setColumns(String hflexs) {
    setSpan(true);
    String hfs[] = hflexs.split(",");
    Columns cols = new Columns();
    for(int i = 0; i < hfs.length; i++) {
      Column col = new Column();
      if(hfs[i].startsWith("right-")) {
        col.setAlign("right");
        col.setHflex(hfs[i].substring(6));
      } else {
        col.setHflex(hfs[i]);
      }
      cols.appendChild(col);
    }
    appendChild(cols);
  }
 
  public void refine() {
    InputDialog.getInput(
            getPage(),
            I_.get("Refine search"),
            new InputField[] {
              new InputField("Text", refineValue, null, 0)
            }, new Command() {
      @Override
      public Object execute(Context context) {
        InputField[] fields = (InputField[]) context.get("fields");
        if(fields.length > 0) {
          for(InputField f : fields) {
            if("Text".equals(f.getLabel())) {
              setRefineValue((String) f.getValue());
            }
          }
        }
        return null;
      }
    });
  }
 
  public boolean isDefaultBehavior() {
    return defaultBehavior;
  }
 
  public void setDefaultBehavior(boolean defaultBehavior) {
    this.defaultBehavior = defaultBehavior;
  }
 
  public String getRefineValue() {
    return refineValue;
  }
 
  public void setRefineValue(String value) {
    this.refineValue = value;
    renderAll();
    doRefine();
  }
 
  public int getMaxResults() {
    return maxResults;
  }
 
  public void setMaxResults(int maxResults) {
    this.maxResults = maxResults;
  }
 
  public String getPagingMold() {
    return pagingMold;
  }
 
  public void setPagingMold(String pagingMold) {
    this.pagingMold = pagingMold;
  }
 
  public int getRowCount() {
    return getRows().getChildren().size();
  }
 
  public void setRowCount(int rows) {
    if(defaultBehavior) {
      setVflex(true);
      if(rows > maxResults) {
        setMold("paging");
        //setPageSize((int) (maxResults * 0.80));
        setAutopaging(true);
        setPagingPosition("bottom");
        getPagingChild().setMold(pagingMold);
      } else {
        setMold("default");
        setAutopaging(false);
      }
    } else {
      setMold("paging");
      setPageSize((int) (maxResults * 0.80));
      setPagingPosition("both");
      getPagingChild().setMold(pagingMold);
    }
  }
 
  public void setHeadersVisible(boolean value) {
    getColumns(true).setVisible(value);
  }
 
  public boolean isHeadersVisible() {
    return getColumns().isVisible();
  }
 
  public String getVarColumns() {
    return varColumns;
  }
 
  public void setVarColumns(String varColumns) {
    this.varColumns = varColumns;
  }
 
  public Collection<String> getVarColumnsList(String defaultCols) {
    return varColumns == null ?
      (defaultCols == null ? new ArrayList<String>() :
        Arrays.asList(defaultCols.split("\\s*\\,\\s*"))) :
      Arrays.asList(varColumns.split("\\s*\\,\\s*"));
  }
 
  public void addDetailColumn() {
    addDetailColumn(null);
  }
 
  public void addDetailColumn(HtmlBasedComponent caption) {
    Column c = new Column();
    c.setWidth("40px");
    if(caption != null) {
      c.appendChild(caption);
    }
    getColumns(true).appendChild(c);
  }
 
  public void openDetails() {
    for(Component row : getRows().getChildren()) {
      Detail d = ((Row)row).getDetailChild();
      if(d != null) {
        d.setOpen(true);
        Events.postEvent(new Event(Events.ON_OPEN, d));
      }
    }
  }
  
  public boolean isEmpty() {
    return getRows() == null || getRows().getChildren() == null;
  }
  
  public void clearColumns() {
    getColumns(true).getChildren().clear();
  }
  
  public void clearRows() {
    getRows(true).getChildren().clear();
  }
  
  public void clearEmptyGroups() {
    Rows rows = getRows();
    if(rows != null) {
      Iterator<Component> it = (Iterator<Component>) rows.getChildren().iterator();
      while(it.hasNext()) {
        Row row = (Row) it.next();
        if(row instanceof Group) {
          Group group = (Group) row;
          if(group.getItemCount() == 0) {
            it.remove();
          }
        }
      }
    }
  }
 
  public Columns getColumns(boolean create) {
    Columns cols = super.getColumns();
    if(create && cols == null) {
      cols = new Columns();
      cols.setSizable(true);
      appendChild(cols);
    }
    return cols;
  }
 
  public Rows getRows(boolean create) {
    Rows rows = getRows();
    if(create && rows == null) {
      rows = new Rows();
      appendChild(rows);
    }
    return rows;
  }
 
  @Deprecated
  public Foot getFoot(boolean create) {
    Foot foot = getFoot();
    if(create && foot == null) {
      foot = new Foot();
      appendChild(foot);
    }
    return foot;
  }
  
  public Foot createFoot() {
    Foot foot = getFoot();
    if(foot != null) {
      foot.detach();
    }
    foot = new Foot();
    appendChild(foot);
    return foot;
  }
  
  public void exportToPdf() {
    try {
      ByteArrayOutputStream out = new ByteArrayOutputStream();
      PdfExporter exporter = new PdfExporter();
      exporter.export(this, out);
      AMedia amedia = new AMedia("GridReport.pdf", "pdf", "application/pdf", out.toByteArray());
      Filedownload.save(amedia);
      out.close();
    } catch (Exception ex) {
      Logger.getLogger(PagingGrid.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  private void doRefine() {
    Rows rows = getRows();
    if(rows != null) {
      for(Component row : rows.getChildren()) {
        if(!(row instanceof Group)) {
          if(Strings.isBlank(refineValue)) {
            row.setVisible(true);
          } else {
            boolean show = false;
            show = processChildren(row, show);
            row.setVisible(show);
          }
        }
      }
      for(Component row : rows.getChildren()) {
        if(row instanceof Group) {
          Group group = (Group) row;
          group.setVisible(group.getVisibleItemCount() > 0);
        }
      }
    }
  }
 
  private boolean processChildren(Component comp, boolean show) {
    for (Component c : (Collection<Component>) comp.getChildren()) {
      if (c instanceof Label) {
        Label l = (Label) c;
        if (Strings.findsIgnoreCase(l.getValue(), refineValue)) {
          show = true;
        }
      } else if (c instanceof Toolbarbutton) {
        Toolbarbutton l = (Toolbarbutton) c;
        if (Strings.findsIgnoreCase(l.getLabel(), refineValue)) {
          show = true;
        }
      } else if (c instanceof A) {
        A a = (A) c;
        if (Strings.findsIgnoreCase(a.getLabel(), refineValue)) {
          show = true;
        }
      } else {
        show = processChildren(c, show);
      }
      if(show) break;
    }
    return show;
  }
 
}