org.primefaces.extensions.component.timepicker.TimePickerRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces-extensions Show documentation
Show all versions of primefaces-extensions Show documentation
PrimeFaces Extensions components and utilities for PrimeFaces.
/*
* Copyright (c) 2011-2024 PrimeFaces Extensions
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.extensions.component.timepicker;
import java.io.IOException;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import javax.el.ValueExpression;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.convert.Converter;
import javax.faces.convert.ConverterException;
import org.primefaces.extensions.util.Attrs;
import org.primefaces.extensions.util.MessageFactory;
import org.primefaces.renderkit.InputRenderer;
import org.primefaces.util.Constants;
import org.primefaces.util.HTML;
import org.primefaces.util.LangUtils;
import org.primefaces.util.WidgetBuilder;
/**
* Renderer for the {@link TimePicker} component.
*
* @author Oleg Varaksin / last modified by Melloware
* @version $Revision$
* @since 0.3
*/
public class TimePickerRenderer extends InputRenderer {
private static final String BUTTON = "button";
@Override
public void decode(final FacesContext fc, final UIComponent component) {
final TimePicker timepicker = (TimePicker) component;
if (!shouldDecode(timepicker)) {
return;
}
final String param = timepicker.getClientId(fc) + "_input";
final String submittedValue = fc.getExternalContext().getRequestParameterMap().get(param);
if (submittedValue != null) {
timepicker.setSubmittedValue(submittedValue);
}
decodeBehaviors(fc, timepicker);
}
@Override
public void encodeEnd(final FacesContext fc, final UIComponent component) throws IOException {
final TimePicker timepicker = (TimePicker) component;
final String value = getValueAsString(fc, timepicker);
encodeMarkup(fc, timepicker, value);
encodeScript(fc, timepicker, value);
}
@Override
public Object getConvertedValue(final FacesContext fc, final UIComponent component, final Object submittedValue) {
final String value = (String) submittedValue;
if (LangUtils.isBlank(value)) {
return null;
}
final TimePicker timepicker = (TimePicker) component;
final Converter converter = timepicker.getConverter();
// first ask the converter
if (converter != null) {
return converter.getAsObject(fc, timepicker, value);
}
// use built-in conversion
try {
final Class type = resolveDateType(fc, timepicker);
if (type == LocalTime.class) {
final DateTimeFormatter formatter = getDateTimeFormatter(timepicker);
return LocalTime.parse(value, formatter);
}
else {
final SimpleDateFormat formatter = getSimpleDateFormat(timepicker);
return formatter.parse(value);
}
}
catch (final ParseException e) {
throw new ConverterException(
MessageFactory.getMessage(timepicker.calculateLocale(),
TimePicker.TIME_MESSAGE_KEY,
value,
getDateTimeFormatter(timepicker).format(LocalDateTime.now()),
MessageFactory.getLabel(fc, component)),
e);
}
catch (final Exception e) {
throw new ConverterException(e.getMessage(), e);
}
}
protected void encodeMarkup(final FacesContext fc, final TimePicker timepicker, final String value)
throws IOException {
final ResponseWriter writer = fc.getResponseWriter();
final String clientId = timepicker.getClientId(fc);
final String inputId = clientId + "_input";
writer.startElement("span", timepicker);
writer.writeAttribute("id", clientId, null);
String containerClass = TimePicker.CONTAINER_CLASS;
if (timepicker.isSpinner()) {
containerClass += " ui-spinner";
}
if (timepicker.isShowOnButton()) {
containerClass += " ui-inputgroup";
}
writer.writeAttribute(Attrs.CLASS, containerClass, null);
if (timepicker.isInline()) {
// inline container
writer.startElement("div", null);
writer.writeAttribute("id", clientId + "_inline", null);
writer.endElement("div");
}
writer.startElement("input", null);
writer.writeAttribute("id", inputId, null);
writer.writeAttribute("name", inputId, null);
writer.writeAttribute("type", timepicker.isInline() ? "hidden" : "text", null);
if (timepicker.getSize() > 0) {
writer.writeAttribute("size", timepicker.getSize(), null);
}
writer.writeAttribute("autocomplete", "off", null);
if (timepicker.isReadonlyInput()) {
writer.writeAttribute("readonly", "readonly", null);
}
if (LangUtils.isNotBlank(value)) {
writer.writeAttribute("value", value, null);
}
if (!timepicker.isInline()) {
final String styleClass = getStyleClassBuilder(fc)
.add(TimePicker.INPUT_CLASS)
.add(timepicker.getStyleClass())
.add(timepicker.isSpinner(), "ui-spinner-input")
.add(timepicker.isShowOnButton(), "ui-inputtext")
.add(!timepicker.isValid(), "ui-state-error")
.build();
writer.writeAttribute(Attrs.CLASS, styleClass, null);
if (timepicker.getStyle() != null) {
writer.writeAttribute(Attrs.STYLE, timepicker.getStyle(), null);
}
}
renderAccessibilityAttributes(fc, timepicker);
renderPassThruAttributes(fc, timepicker, HTML.INPUT_TEXT_ATTRS_WITHOUT_EVENTS);
renderDomEvents(fc, timepicker, HTML.INPUT_TEXT_EVENTS);
renderValidationMetadata(fc, timepicker);
writer.endElement("input");
if (timepicker.isSpinner()) {
final boolean disabled = timepicker.isDisabled() || timepicker.isReadonly();
encodeSpinnerButton(fc, TimePicker.UP_BUTTON_CLASS, TimePicker.UP_ICON_CLASS, disabled);
encodeSpinnerButton(fc, TimePicker.DOWN_BUTTON_CLASS, TimePicker.DOWN_ICON_CLASS, disabled);
}
if (timepicker.isShowOnButton()) {
writer.startElement(BUTTON, null);
writer.writeAttribute(Attrs.CLASS, TimePicker.BUTTON_TRIGGER_CLASS, null);
writer.writeAttribute("type", BUTTON, null);
writer.writeAttribute("role", BUTTON, null);
writer.startElement("span", null);
writer.writeAttribute(Attrs.CLASS, TimePicker.BUTTON_TRIGGER_ICON_CLASS, null);
writer.endElement("span");
writer.startElement("span", null);
writer.writeAttribute(Attrs.CLASS, TimePicker.BUTTON_TRIGGER_TEXT_CLASS, null);
writer.write("ui-button");
writer.endElement("span");
writer.endElement(BUTTON);
}
writer.endElement("span");
}
protected void encodeScript(final FacesContext fc, final TimePicker timepicker, final String value)
throws IOException {
final String clientId = timepicker.getClientId(fc);
final WidgetBuilder wb = getWidgetBuilder(fc);
wb.init("ExtTimePicker", timepicker);
wb.attr("timeSeparator", timepicker.getTimeSeparator());
wb.attr("myPosition", timepicker.getDialogPosition());
wb.attr("atPosition", timepicker.getInputPosition());
wb.attr("showPeriod", timepicker.isShowPeriod());
wb.attr("showPeriodLabels", timepicker.isShowPeriod());
wb.attr("modeInline", timepicker.isInline());
wb.attr("modeSpinner", timepicker.isSpinner());
wb.nativeAttr("hours", "{starts:" + timepicker.getStartHours() + ",ends:" + timepicker.getEndHours() + "}");
wb.nativeAttr("minutes", "{starts:" + timepicker.getStartMinutes() + ",ends:" + timepicker.getEndMinutes()
+ ",interval:" + timepicker.getIntervalMinutes() + "}");
wb.attr("rows", timepicker.getRows());
wb.attr("showHours", timepicker.isShowHours());
wb.attr("showMinutes", timepicker.isShowMinutes());
wb.attr("showCloseButton", timepicker.isShowCloseButton());
wb.attr("showNowButton", timepicker.isShowNowButton());
wb.attr("showDeselectButton", timepicker.isShowDeselectButton());
if (timepicker.getOnHourShow() != null) {
wb.nativeAttr("onHourShow", timepicker.getOnHourShow());
}
if (timepicker.getOnMinuteShow() != null) {
wb.nativeAttr("onMinuteShow", timepicker.getOnMinuteShow());
}
if (timepicker.isShowOnButton()) {
wb.attr("showOn", timepicker.getShowOn());
wb.selectorAttr(BUTTON, "#" + clientId + " .pe-timepicker-trigger");
}
wb.attr("locale", timepicker.calculateLocale().toString());
wb.attr("disabled", timepicker.isDisabled() || timepicker.isReadonly());
if (LangUtils.isBlank(value)) {
wb.attr("defaultTime", Constants.EMPTY_STRING);
}
else if (timepicker.isInline()) {
wb.attr("defaultTime", value);
}
if (timepicker.getMinHour() != null || timepicker.getMinMinute() != null) {
wb.nativeAttr("minTime", "{hour:" + timepicker.getMinHour()
+ ",minute:" + timepicker.getMinMinute() + "}");
}
if (timepicker.getMaxHour() != null || timepicker.getMaxMinute() != null) {
wb.nativeAttr("maxTime", "{hour:" + timepicker.getMaxHour()
+ ",minute:" + timepicker.getMaxMinute() + "}");
}
encodeClientBehaviors(fc, timepicker);
wb.finish();
}
protected void encodeSpinnerButton(final FacesContext fc, String styleClass, final String iconClass,
final boolean disabled)
throws IOException {
final ResponseWriter writer = fc.getResponseWriter();
styleClass = disabled ? styleClass + " ui-state-disabled" : styleClass;
writer.startElement("a", null);
writer.writeAttribute(Attrs.CLASS, styleClass, null);
writer.startElement("span", null);
writer.writeAttribute(Attrs.CLASS, "ui-button-text", null);
writer.startElement("span", null);
writer.writeAttribute(Attrs.CLASS, iconClass, null);
writer.endElement("span");
writer.endElement("span");
writer.endElement("a");
}
protected String getValueAsString(final FacesContext fc, final TimePicker timepicker) {
final Object submittedValue = timepicker.getSubmittedValue();
if (submittedValue != null) {
return submittedValue.toString();
}
final Object value = timepicker.getValue();
if (value == null) {
return null;
}
else {
if (timepicker.getConverter() != null) {
// convert via registered converter
return timepicker.getConverter().getAsString(fc, timepicker, value);
}
else {
// use built-in converter
if (value instanceof LocalTime) {
final DateTimeFormatter formatter = getDateTimeFormatter(timepicker);
return formatter.format((LocalTime) value);
}
else {
final SimpleDateFormat formatter = getSimpleDateFormat(timepicker);
return formatter.format(value);
}
}
}
}
protected String getPattern(final TimePicker timepicker) {
if (!timepicker.isShowMinutes()) {
return timepicker.getTimePatternWithoutMinutes();
}
else if (!timepicker.isShowHours()) {
return timepicker.getTimePatternWithoutHours();
}
else if (timepicker.isShowPeriod()) {
return timepicker.getTimePattern12();
}
else {
return timepicker.getTimePattern24();
}
}
protected DateTimeFormatter getDateTimeFormatter(final TimePicker timepicker) {
return DateTimeFormatter.ofPattern(getPattern(timepicker), timepicker.calculateLocale());
}
protected SimpleDateFormat getSimpleDateFormat(final TimePicker timepicker) {
return new SimpleDateFormat(getPattern(timepicker), timepicker.calculateLocale());
}
protected Class resolveDateType(final FacesContext context, final TimePicker timePicker) {
final ValueExpression ve = timePicker.getValueExpression("value");
if (ve == null) {
return null;
}
Class type = ve.getType(context.getELContext());
// If type could not be determined via value-expression try it this way. (Very unlikely, this happens in real world.)
if (type == null) {
type = LocalTime.class;
}
return type;
}
}