EntityComposer.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.jpa.composer;
 
import org.turro.elephant.util.Components;
import org.turro.elephant.util.Images;
import org.turro.elephant.util.Messages;
import org.turro.i18n.I_;
import org.turro.jpa.entity.DaoEntity;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.json.Jsons;
import org.turro.reflection.XMLSerializer;
import org.turro.reflection.stub.Stubs;
import org.turro.zul.frame.Framework;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Executions;
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.select.SelectorComposer;
import org.zkoss.zk.ui.select.annotation.Listen;
import org.zkoss.zk.ui.select.annotation.Wire;
import org.zkoss.zul.Tab;
import org.zkoss.zul.Tabpanel;
import org.zkoss.zul.Toolbarbutton;
 
public abstract class EntityComposer<E, ID> extends SelectorComposer<Component> {
 
  private String entityXML, entityJSON;
  protected E entity;
  protected DaoEntity wrapper;
 
  @Wire("#save")
  private Toolbarbutton save;
 
  @Wire("#delete")
  private Toolbarbutton delete;
 
  @Listen("onChange = *; onSelect = *; onCheck = *")
  public final void onChange(Event event) {
    if(!(event.getTarget() instanceof Tab)) {
      save.setDisabled(!(wrapper.canSave() && (hasChanged() || shouldBeSaved())) || !inSaveRole());
      doOnChange();
    }
  }
  
  @Listen("onClick = #save")
  public final void onSave() {
    doOnSave();
  }
 
  @Listen("onClick = #delete")
  public final void onDelete() {
    doOnDelete();
  }
 
  public Object getEntity() {
    return entity;
  }
 
  public Object getWrapper() {
    return wrapper;
  }
 
  @Override
  public void doBeforeComposeChildren(Component comp) throws Exception {
    entity = null;
    retrieveEntity();
    comp.setAttribute(getAttributeName(), entity);
    wrapper = getWrapperInstance(comp);
    comp.setAttribute("wrapper", wrapper);
    super.doBeforeComposeChildren(comp);
  }
 
  @Override
  public void doFinally() throws Exception {
    super.doFinally();
    save.setDisabled(!shouldBeSaved());
    save.setLabel(I_.get("Save"));
    save.setImage(Images.getImage("save"));
    delete.setDisabled(!wrapper.canDelete() || !inDeleteRole());
    delete.setLabel(I_.get("Delete"));
    delete.setImage(Images.getImage("edit-delete"));
  }
 
  @Override
  public void doAfterCompose(Component comp) throws Exception {
    super.doAfterCompose(comp);
    interceptOnClose();
  }
 
  protected abstract String getAttributeName();
  protected abstract E getEntityInstance(ID id);
  protected abstract DaoEntity getWrapperInstance(Component comp);
  protected abstract boolean inSaveRole();
  protected abstract boolean inDeleteRole();
  
  protected void doOnSave() {
    if(beforeSave()) {
      entity = (E) wrapper.save();
      Framework.getCurrent().closeSelected();
      afterSave();
    }
  }
  
  protected boolean beforeSave() {
    return !((IDaoEntity) entity).isEmpty();
  }
  
  protected void afterSave() {
    // do nothing
  }
 
  protected void doOnDelete() {
    if(beforeDelete()) {
      if(wrapper.delete()) {
        Framework.getCurrent().closeSelected();
        afterDelete();
      }
    }
  }
  
  protected boolean beforeDelete() {
    return true;
  }
 
  protected void afterDelete() {
    // do nothing
  }
 
  protected void doOnChange() {
    // do nothing
  }
  
  protected boolean shouldBeSaved() {
    return false;
  }
  
  protected boolean hasChanged() {
    return !Jsons.isEmpty(entityJSON) ? (!Jsons.equals(entityJSON, Stubs.json(entity))) :
            (entityXML == null || (!entityXML.equals(new XMLSerializer(entity).data())));
  }
 
  protected void retrieveEntity() {
    Framework frame = Framework.getCurrent();
    entity = (E) frame.getSelectedAttribute("tp_entity");
    if(entity == null) {
      if(Executions.getCurrent().getAttribute(getAttributeName() + "Generated") != null) {
        entity = (E) Executions.getCurrent().getAttribute(getAttributeName() + "Generated");
        Executions.getCurrent().removeAttribute(getAttributeName() + "Generated");
      } else {
        entity = (E) getEntityInstance((ID) frame.getDesktop().getAttribute(getAttributeName() + "Id"));
        frame.getDesktop().removeAttribute(getAttributeName() + "Id");
      }
      frame.setSelectedAttribute("tp_entity", entity);
    } else {
      entity = (E) getEntityInstance((ID) DaoEntity.getEntityId(entity));
    }
    entityXML = new XMLSerializer(entity).data();
    entityJSON = Stubs.json(entity);
  }
 
  protected boolean canClose() {
    return true;
  }
  
  private void interceptOnClose() {
    Tabpanel container = Components.from(getSelf().getPage()).parent(Tabpanel.class);
    if(container != null) {
      final Tab tab = container.getLinkedTab();
      tab.addEventListener(9000, Events.ON_CLOSE, new EventListener<Event>() {
        @Override
        public void onEvent(final Event event) throws Exception {
          if(!save.isDisabled()) {
            if(canClose()) {
              event.stopPropagation();
              Messages.question().add("Close without saving?").show(() -> {
                Framework.getCurrent().closeSelected();
              });
            }
          }
        }
      });
    }
  }
  
}