org.carewebframework.ui.zk.DateTimebox.java Source code

Introduction

Here is the source code for org.carewebframework.ui.zk.DateTimebox.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. 
 * If a copy of the MPL was not distributed with this file, You can obtain one at 
 * http://mozilla.org/MPL/2.0/.
 * 
 * This Source Code Form is also subject to the terms of the Health-Related Additional
 * Disclaimer of Warranty and Limitation of Liability available at
 * http://www.carewebframework.org/licensing/disclaimer.
 */
package org.carewebframework.ui.zk;

import java.util.Date;

import org.apache.commons.lang.time.DateUtils;

import org.carewebframework.common.DateUtil;

import org.zkoss.util.resource.Labels;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.IdSpace;
import org.zkoss.zk.ui.WrongValueException;
import org.zkoss.zk.ui.event.OpenEvent;
import org.zkoss.zk.ui.metainfo.PageDefinition;
import org.zkoss.zul.Bandbox;
import org.zkoss.zul.Bandpopup;
import org.zkoss.zul.Datebox;
import org.zkoss.zul.Label;
import org.zkoss.zul.Timebox;
import org.zkoss.zul.mesg.MZul;

/**
 * Presents a date/time input element.
 */
public class DateTimebox extends Bandbox implements IdSpace {

    private static final long serialVersionUID = 1L;

    private Datebox datebox;

    private Timebox timebox;

    private Label error;

    private boolean requireTime;

    private boolean ok;

    private final String requireTimeError = Labels.getLabel("cwf.datetime.error.no.time");

    /**
     * Creates all required child components.
     * 
     * @throws Exception Unspecified exception.
     */
    public void onCreate() throws Exception {
        Bandpopup bp = new Bandpopup();
        appendChild(bp);
        PageDefinition def = ZKUtil.loadCachedPageDefinition(Constants.RESOURCE_PREFIX + "dateTimebox.zul");
        Executions.createComponents(def, bp, null);
        ZKUtil.wireController(this);
        datebox.setFormat("dd-MMM-yyyy");
        timebox.setFormat("HH:mm");
    }

    public void setRequireTime(boolean requireTime) {
        this.requireTime = requireTime;
    }

    public boolean getRequireTime() {
        return requireTime;
    }

    public void setDate(Date date) {
        validate(date);
        setRawValue(date);
    }

    @Override
    public void validate(Object value) {
        super.validate(value);

        if (requireTime && !DateUtil.hasTime((Date) value)) {
            throw showCustomError(new WrongValueException(this, requireTimeError));
        }
    }

    public Date getDate() {
        return (Date) getRawValue();
    }

    private void showError(String message) {
        error.setValue(message);
        ok = message == null;
    }

    private boolean validate() {
        ok = true;

        if (requireTime && timebox.getValue() == null) {
            showError(requireTimeError);
        }

        return ok;
    }

    public void onOpen(OpenEvent event) {
        update(event.isOpen());
    }

    private void update(boolean open) {
        if (open) {
            datebox.setConstraint(getConstraint());
            Date date = getDate();
            updateDatebox(date);
            updateTimebox(DateUtil.hasTime(date) ? date : null);
            showError(null);
        } else if (ok) {
            Date date = ZKDateUtil.getTime(datebox, timebox);
            date = timebox.getValue() != null ? DateUtils.setMilliseconds(date, 1) : date;
            setDate(date);
        }
    }

    public void onClick$btnOK() {
        if (validate()) {
            close();
        }
    }

    public void onClick$btnCancel() {
        ok = false;
        close();
    }

    @Override
    public void close() {
        super.close();
        update(false);
    }

    private Date now() {
        return new Date();
    }

    private void updateDatebox(Date value) {
        datebox.setValue(DateUtil.stripTime(value));
    }

    private void updateTimebox(Date value) {
        timebox.setValue(value);
    }

    public void onClick$btnToday() {
        updateDatebox(now());
        updateTimebox(null);
    }

    public void onClick$btnNow() {
        Date now = now();
        updateDatebox(now);
        updateTimebox(now);
    }

    public void onClick$btnClear() {
        updateTimebox(null);
    }

    @Override
    protected Object marshall(Object value) {
        return value instanceof Date ? coerceToString(value) : super.marshall(value);
    }

    @Override
    protected Object unmarshall(Object value) {
        return value instanceof String ? coerceFromString((String) value) : super.unmarshall(value);
    }

    @Override
    protected Object coerceFromString(String value) throws WrongValueException {
        if (value == null) {
            return null;
        }

        Date date = DateUtil.parseDate(value);

        if (date == null) {
            throw showCustomError(
                    new WrongValueException(this, MZul.DATE_REQUIRED, new Object[] { value, datebox.getFormat() }));
        }

        return date;
    }

    @Override
    protected String coerceToString(Object value) {
        return DateUtil.formatDate((Date) value);
    }
}