MultiLabelBox.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.zkoss.input;
 
import java.util.Collection;
import org.turro.string.Strings;
import org.turro.command.Command;
import org.turro.zkoss.label.LabelEditable;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.ext.AfterCompose;
import org.zkoss.zul.Hbox;
 
public abstract class MultiLabelBox<E> extends Hbox implements AfterCompose, EventListener {
 
  private E entity;
  private boolean readOnly;
  
  public MultiLabelBox() {
    setSclass("z-valign-middle multiLabel");
    setAlign("center");
  }
 
  public E getEntity() {
    return entity;
  }
 
  public void setEntity(E entity) {
    this.entity = entity;
  }
 
  public boolean isReadOnly() {
    return readOnly;
  }
 
  public void setReadOnly(boolean readOnly) {
    this.readOnly = readOnly;
  }
 
  @Override
  public void afterCompose() {
    setVisible(checkVisible());
    getChildren().clear();
    LabelEditable le;
    if(getCollection() != null) {
      for(E label : getCollection()) {
        le = new LabelEditable(convertToString(label));
        le.setEditable(!readOnly && checkEditable());
        le.setEditorCols(12);
        le.setValues(getLabelChoices());
        appendChild(le);
        le.addEventListener(Events.ON_CHANGE, this);
      }
    }
    if(!readOnly && checkNew()) {
      le = new LabelEditable("", getNewImage());
      le.setEditorCols(12);
      le.setValues(getLabelChoices());
      appendChild(le);
      le.addEventListener(Events.ON_CHANGE, this);
    }
    for(Object obj : getChildren()) {
      if(obj instanceof AfterCompose) {
        ((AfterCompose) obj).afterCompose();
      }
    }
  }
 
  @Override
  public void onEvent(Event event) throws Exception {
    if(event.getData() instanceof LabelEditable) {
      LabelEditable le = (LabelEditable) event.getData();
      if(!Strings.isBlank(le.getLabel())) {
        if(!Strings.isBlank(le.getImage())) {
          addChoice(le.getLabel(), null);
          Events.postEvent(new Event(Events.ON_CHANGE, MultiLabelBox.this));
        } else {
          changeChoice(le.getOldLabel(), le.getLabel(), null);
          Events.postEvent(new Event(Events.ON_CHANGE, MultiLabelBox.this));
        }
      } else {
        if(!Strings.isBlank(le.getImage())) {
          // nothing, insertion cancelled
        } else {
          if(!readOnly && checkDelete()) {
            deleteChoice(le.getOldLabel(), null);
            Events.postEvent(new Event(Events.ON_CHANGE, MultiLabelBox.this));
          }
        }
      }
    }
    afterCompose();
  }
 
  protected abstract boolean checkVisible();
  protected abstract boolean checkNew();
  protected abstract boolean checkEditable();
  protected abstract boolean checkDelete();
  protected abstract String getNewImage();
  protected abstract Collection<E> getCollection();
  protected abstract String convertToString(E label);
  protected abstract Collection<String> getLabelChoices();
  protected abstract void addChoice(String choice, Command command);
  protected abstract void changeChoice(String oldChoice, String choice, Command command);
  protected abstract void deleteChoice(String oldChoice, Command command);
  
}