/*
* This file is part of LibrePlan
*
* Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e
* Desenvolvemento Tecnolóxico de Galicia
* Copyright (C) 2010-2011 Igalia, S.L.
*
* 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.libreplan.web.labels;
import static org.libreplan.web.I18nHelper._;
import java.util.ConcurrentModificationException;
import java.util.Iterator;
import java.util.List;
import org.libreplan.business.common.exceptions.ValidationException;
import org.libreplan.business.labels.entities.Label;
import org.libreplan.business.labels.entities.LabelType;
import org.libreplan.web.common.BaseCRUDController;
import org.libreplan.web.common.Level;
import org.libreplan.web.common.Util;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.WrongValueException;
import org.zkoss.zk.ui.event.CheckEvent;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.InputEvent;
import org.zkoss.zkplus.spring.SpringUtil;
import org.zkoss.zul.Button;
import org.zkoss.zul.Column;
import org.zkoss.zul.Constraint;
import org.zkoss.zul.Grid;
import org.zkoss.zul.Hbox;
import org.zkoss.zul.Row;
import org.zkoss.zul.Textbox;
import org.zkoss.zul.Rows;
import org.zkoss.zul.ext.Sortable;
/**
* CRUD Controller for {@link LabelType}.
*
* @author Diego Pino Garcia <dpino@igalia.com>
* @author Manuel Rego Casasnovas <rego@igalia.com>
*/
public class LabelTypeCRUDController extends BaseCRUDController<LabelType> {
private ILabelTypeModel labelTypeModel;
private Grid gridLabelTypes;
private Grid gridLabels;
private Textbox newLabelTextbox;
public LabelTypeCRUDController() {
labelTypeModel = (ILabelTypeModel) SpringUtil.getBean("labelTypeModel");
}
@Override
public void doAfterCompose(Component comp) throws Exception {
super.doAfterCompose(comp);
initializeLabelsGrid();
initializeLabelTypesGrid();
newLabelTextbox = (Textbox) editWindow.getFellowIfAny("newLabelTextbox");
}
private void initializeLabelsGrid() {
gridLabels = (Grid) editWindow.getFellowIfAny("gridLabels");
// Renders grid and enables delete button if label is new
gridLabels.addEventListener("onInitRender", new EventListener() {
@Override
public void onEvent(Event event) {
gridLabels.renderAll();
final Rows rows = gridLabels.getRows();
for (Iterator i = rows.getChildren().iterator(); i.hasNext();) {
final Row row = (Row) i.next();
final Label label = row.getValue();
Button btnDelete = (Button) row.getChildren().get(2);
if ( !canRemoveLabel(label) ) {
btnDelete.setDisabled(true);
btnDelete.setImage("/common/img/ico_borrar_out.png");
btnDelete.setHoverImage("/common/img/ico_borrar_out.png");
btnDelete.setTooltiptext("");
}
}
}
private boolean canRemoveLabel(Label label) {
if ( label.isNewObject() ){
return true;
}
return label.getOrderElements().isEmpty();
}
});
}
private void initializeLabelTypesGrid() {
gridLabelTypes = (Grid) listWindow.getFellowIfAny("labelTypes");
gridLabelTypes.addEventListener("onInitRender", new EventListener() {
@Override
public void onEvent(Event event) {
gridLabelTypes.renderAll();
final Rows rows = gridLabelTypes.getRows();
for (Iterator i = rows.getChildren().iterator(); i.hasNext();) {
final Row row = (Row) i.next();
final LabelType labelType = row.getValue();
Hbox hbox = (Hbox) row.getChildren().get(2);
Button btnDelete = (Button) hbox.getChildren().get(1);
if ( !canRemoveLabelType(labelType) ) {
btnDelete.setDisabled(true);
btnDelete.setImage("/common/img/ico_borrar_out.png");
btnDelete.setHoverImage("/common/img/ico_borrar_out.png");
btnDelete.setTooltiptext("");
}
}
}
private boolean canRemoveLabelType(LabelType labelType) {
boolean canRemove = true;
if ( labelType.isNewObject() ) {
return canRemove;
}
// If at least one of its labels is being used by and orderElement, cannot remove labelType
for (Label each: labelType.getLabels()) {
if ( !each.getOrderElements().isEmpty() ) {
canRemove = false;
break;
}
}
return canRemove;
}
});
}
/**
* Return all {@link LabelType}.
* @return {@link List<LabelType>}
*/
public List<LabelType> getLabelTypes() {
return labelTypeModel.getLabelTypes();
}
/**
* Return current {@link LabelType}.
* @return {@link LabelType}
*/
public LabelType getLabelType() {
return labelTypeModel.getLabelType();
}
public List<Label> getLabels() {
return labelTypeModel.getLabels();
}
@Override
public void save() {
labelTypeModel.confirmSave();
}
/**
* Validates all {@link Textbox} in the form.
*/
private void validate() {
validate((Textbox) editWindow.getFellowIfAny("label_type_name"));
for (Row row : getRows()) {
validate(row);
}
}
@SuppressWarnings("unchecked")
private void validate(Row row) {
for (final Component comp : row.getChildren()) {
if ( comp instanceof Textbox ) {
validate((Textbox) comp);
}
}
}
@SuppressWarnings("unchecked")
private List<Row> getRows() {
return gridLabels.getRows().getChildren();
}
/**
* Validates {@link Textbox} checking {@link Constraint}.
* @param comp
*/
private void validate(Textbox comp) {
if ( comp != null && comp.getConstraint() != null && !comp.isDisabled() ) {
final Constraint constraint = comp.getConstraint();
constraint.validate(comp, comp.getValue());
}
}
public void createLabel() {
try{
validateNewLabel();
validate();
labelTypeModel.addLabel(newLabelTextbox.getValue());
Util.reloadBindings(gridLabels);
// After adding a new row, model might be disordered, so we force it to sort again respecting previous settings
forceSortGridLabels();
newLabelTextbox.setValue("");
} catch (ValidationException e) {
messagesForUser.showInvalidValues(e);
}
}
private String validateNewLabel() throws ValidationException {
String name = newLabelTextbox.getValue();
labelTypeModel.validateNameNotEmpty(name);
labelTypeModel.thereIsOtherWithSameNameAndType(name);
return name;
}
/**
* Sorts {@link Grid} model by first column, respecting sort order.
*
* FIXME:
* This is a temporary solution, there should be a better/smarter way
* of preserving order in the Grid every time a new element is added to its model.
*/
private void forceSortGridLabels() {
Column column = (Column) gridLabels.getColumns().getFirstChild();
Sortable model = (Sortable) gridLabels.getModel();
if ( "ascending".equals(column.getSortDirection()) ) {
model.sort(column.getSortAscending(), true);
}
if ( "descending".equals(column.getSortDirection()) ) {
model.sort(column.getSortDescending(), false);
}
}
public void onChangeLabelName(Event e) {
InputEvent ie = (InputEvent) e;
if ( !labelTypeModel.labelNameIsUnique(ie.getValue()) ) {
throw new WrongValueException(e.getTarget(), _("{0} already exists", ie.getValue()));
}
}
/**
* Pop up confirm remove dialog.
* @param label
*/
public void confirmDeleteLabel(Label label) {
labelTypeModel.confirmDeleteLabel(label);
Util.reloadBindings(gridLabels);
}
public void onCheckGenerateCode(Event e) {
CheckEvent ce = (CheckEvent) e;
if ( ce.isChecked() ) {
try {
labelTypeModel.setCodeAutogenerated(ce.isChecked());
} catch (ConcurrentModificationException err) {
messagesForUser.showMessage(Level.ERROR, err.getMessage());
}
}
Util.reloadBindings(editWindow);
}
@Override
protected String getEntityType() {
return _("Label Type");
}
@Override
protected String getPluralEntityType() {
return _("Label Types");
}
@Override
protected void initCreate() {
labelTypeModel.initCreate();
}
@Override
protected void initEdit(LabelType labelType) {
labelTypeModel.initEdit(labelType);
}
@Override
protected LabelType getEntityBeingEdited() {
return labelTypeModel.getLabelType();
}
@Override
protected void delete(LabelType labelType) {
labelTypeModel.confirmDelete(labelType);
}
@Override
protected void beforeSaving() throws ValidationException {
validate();
labelTypeModel.generateCodes();
Util.reloadBindings(editWindow);
}
}