org.fujion.component.Timebox Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fujion-core Show documentation
There is a newer version: 3.1.0
/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2008 - 2017 Regenstrief Institute, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * #L%
 */
package org.fujion.component;

import java.util.Date;

import org.apache.commons.lang.time.FastDateFormat;
import org.fujion.annotation.Component;
import org.fujion.annotation.Component.PropertyGetter;
import org.fujion.annotation.Component.PropertySetter;
import org.fujion.common.DateUtil;

/**
 * An input box for entering a time value.
 */
@Component(tag = "timebox", widgetClass = "Timebox", parentTag = "*", description = "An input box for entering a time value.")
public class Timebox extends BaseInputboxComponent {

    private static final FastDateFormat serializer = FastDateFormat.getInstance("HH:mm:ss");

    private FastDateFormat formatter = FastDateFormat.getTimeInstance(FastDateFormat.SHORT);

    private String format;

    @Override
    protected Date _toValue(String value) {
        return DateUtil.parseDate("01-Jan-1900 " + value);
    }

    @Override
    protected String _toString(Date value) {
        return formatter.format(value);
    }

    @Override
    protected String _toClient(Date value) {
        return serializer.format(value);
    }

    /**
     * Returns the format for displaying the time.
     *
     * @return Format for displaying the time.
     * @see java.text.SimpleDateFormat
     */
    @PropertyGetter(value = "format", description = "Format for displaying the time.")
    public String getFormat() {
        return format;
    }

    /**
     * Sets the format for displaying the time.
     *
     * @param format Format for displaying the time.
     * @see java.text.SimpleDateFormat
     */
    @PropertySetter(value = "format", defaultValue = "HH:mm:ss", description = "Format for displaying the time.")
    public void setFormat(String format) {
        if (!areEqual(format = trimify(format), this.format)) {
            this.format = format;
            formatter = format == null ? FastDateFormat.getTimeInstance(FastDateFormat.SHORT)
                    : FastDateFormat.getInstance(format);
        }
    }

}