org.primefaces.extensions.component.timepicker.TimePicker 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 Project for Maven.
/*
* Copyright 2011-2015 PrimeFaces Extensions
*
* 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.
*
* $Id$
*/
package org.primefaces.extensions.component.timepicker;
import org.apache.commons.lang3.LocaleUtils;
import org.primefaces.component.api.Widget;
import org.primefaces.extensions.event.BeforeShowEvent;
import org.primefaces.extensions.event.CloseEvent;
import org.primefaces.extensions.event.TimeSelectEvent;
import org.primefaces.util.ArrayUtils;
import org.primefaces.util.Constants;
import org.primefaces.util.HTML;
import javax.faces.application.ResourceDependencies;
import javax.faces.application.ResourceDependency;
import javax.faces.component.UINamingContainer;
import javax.faces.component.html.HtmlInputText;
import javax.faces.context.FacesContext;
import javax.faces.event.AjaxBehaviorEvent;
import javax.faces.event.FacesEvent;
import javax.faces.event.PhaseId;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import org.primefaces.util.ComponentUtils;
/**
* TimePicker component.
*
* @author Oleg Varaksin / last modified by $Author$
* @version $Revision$
* @since 0.3
*/
@ResourceDependencies({
@ResourceDependency(library = "primefaces", name = "primefaces.css"),
@ResourceDependency(library = "primefaces", name = "jquery/jquery.js"),
@ResourceDependency(library = "primefaces", name = "primefaces.js"),
@ResourceDependency(library = "primefaces-extensions", name = "primefaces-extensions.js"),
@ResourceDependency(library = "primefaces-extensions", name = "timepicker/timepicker.css"),
@ResourceDependency(library = "primefaces-extensions", name = "timepicker/timepicker.js")
})
public class TimePicker extends HtmlInputText implements Widget {
public static final String COMPONENT_TYPE = "org.primefaces.extensions.component.TimePicker";
public static final String COMPONENT_FAMILY = "org.primefaces.extensions.component";
private static final String DEFAULT_RENDERER = "org.primefaces.extensions.component.TimePickerRenderer";
private static final String OPTIMIZED_PACKAGE = "org.primefaces.extensions.component.";
public static final String CONTAINER_CLASS = "pe-timepicker ui-widget ui-corner-all";
public static final String INPUT_CLASS = "ui-inputfield pe-timepicker-input ui-state-default ui-corner-all";
public static final String UP_BUTTON_CLASS =
"pe-timepicker-button pe-timepicker-up ui-corner-tr ui-button ui-widget ui-state-default ui-button-text-only";
public static final String DOWN_BUTTON_CLASS =
"pe-timepicker-button pe-timepicker-down ui-corner-br ui-button ui-widget ui-state-default ui-button-text-only";
public static final String UP_ICON_CLASS = "ui-icon ui-icon-triangle-1-n";
public static final String DOWN_ICON_CLASS = "ui-icon ui-icon-triangle-1-s";
public static final String BUTTON_TRIGGER_CLASS =
"pe-timepicker-trigger ui-button ui-widget ui-state-default ui-corner-all ui-button-icon-only";
public static final String BUTTON_TRIGGER_ICON_CLASS = "ui-button-icon-left ui-icon ui-icon-clock";
public static final String BUTTON_TRIGGER_TEXT_CLASS = "ui-button-text";
public static final String[] INPUT_TEXT_ATTRS =
ArrayUtils.concat(new String[] {
"accesskey", "alt", "autocomplete", "dir", "lang", "maxlength", "size", "tabindex", "title"
}, HTML.COMMON_EVENTS, HTML.CHANGE_SELECT_EVENTS, HTML.BLUR_FOCUS_EVENTS);
public static final String TIME_MESSAGE_KEY = "javax.faces.converter.DateTimeConverter.TIME";
private Locale appropriateLocale;
private static final Collection EVENT_NAMES =
Collections.unmodifiableCollection(Arrays.asList("blur", "change", "valueChange", "click", "dblclick", "focus", "keydown",
"keypress", "keyup", "mousedown", "mousemove", "mouseout", "mouseover",
"mouseup", "beforeShow", "timeSelect", "close"));
private Map customEvents = new HashMap();
/**
* PropertyKeys
*
* @author oleg / last modified by $Author$
* @version $Revision$
*/
protected enum PropertyKeys {
widgetVar,
timeSeparator,
showPeriod,
dialogPosition,
inputPosition,
mode /* 'popup', 'spinner', 'inline' */,
startHours,
endHours,
startMinutes,
endMinutes,
intervalMinutes,
rows,
showHours,
showMinutes,
showCloseButton,
showNowButton,
showDeselectButton,
onHourShow,
onMinuteShow,
showOn,
locale,
minHour,
minMinute,
maxHour,
maxMinute;
String toString;
PropertyKeys(final String toString) {
this.toString = toString;
}
PropertyKeys() {
}
@Override
public String toString() {
return ((this.toString != null) ? this.toString : super.toString());
}
}
public TimePicker() {
setRendererType(DEFAULT_RENDERER);
}
@Override
public String getFamily() {
return COMPONENT_FAMILY;
}
public String getWidgetVar() {
return (String) getStateHelper().eval(PropertyKeys.widgetVar, null);
}
public void setWidgetVar(final String widgetVar) {
getStateHelper().put(PropertyKeys.widgetVar, widgetVar);
}
public String getTimeSeparator() {
return (String) getStateHelper().eval(PropertyKeys.timeSeparator, ":");
}
public void setTimeSeparator(final String timeSeparator) {
getStateHelper().put(PropertyKeys.timeSeparator, timeSeparator);
}
public boolean isShowPeriod() {
return (Boolean) getStateHelper().eval(PropertyKeys.showPeriod, false);
}
public void setShowPeriod(final boolean showPeriod) {
getStateHelper().put(PropertyKeys.showPeriod, showPeriod);
}
public String getMode() {
return (String) getStateHelper().eval(PropertyKeys.mode, "spinner");
}
public void setMode(final String mode) {
getStateHelper().put(PropertyKeys.mode, mode);
}
public String getDialogPosition() {
return (String) getStateHelper().eval(PropertyKeys.dialogPosition, "left top");
}
public void setDialogPosition(final String dialogPosition) {
getStateHelper().put(PropertyKeys.dialogPosition, dialogPosition);
}
public String getInputPosition() {
return (String) getStateHelper().eval(PropertyKeys.inputPosition, "left bottom");
}
public void setInputPosition(final String inputPosition) {
getStateHelper().put(PropertyKeys.inputPosition, inputPosition);
}
public int getStartHours() {
return (Integer) getStateHelper().eval(PropertyKeys.startHours, 0);
}
public void setStartHours(final int startHours) {
getStateHelper().put(PropertyKeys.startHours, startHours);
}
public int getEndHours() {
return (Integer) getStateHelper().eval(PropertyKeys.endHours, 23);
}
public void setEndHours(final int endHours) {
getStateHelper().put(PropertyKeys.endHours, endHours);
}
public int getStartMinutes() {
return (Integer) getStateHelper().eval(PropertyKeys.startMinutes, 0);
}
public void setStartMinutes(final int startMinutes) {
getStateHelper().put(PropertyKeys.startMinutes, startMinutes);
}
public int getEndMinutes() {
return (Integer) getStateHelper().eval(PropertyKeys.endMinutes, 55);
}
public void setEndMinutes(final int endMinutes) {
getStateHelper().put(PropertyKeys.endMinutes, endMinutes);
}
public int getIntervalMinutes() {
return (Integer) getStateHelper().eval(PropertyKeys.intervalMinutes, 5);
}
public void setIntervalMinutes(final int intervalMinutes) {
getStateHelper().put(PropertyKeys.intervalMinutes, intervalMinutes);
}
public int getRows() {
return (Integer) getStateHelper().eval(PropertyKeys.rows, 4);
}
public void setRows(final int rows) {
getStateHelper().put(PropertyKeys.rows, rows);
}
public boolean isShowHours() {
return (Boolean) getStateHelper().eval(PropertyKeys.showHours, true);
}
public void setShowHours(final boolean showHours) {
getStateHelper().put(PropertyKeys.showHours, showHours);
}
public boolean isShowMinutes() {
return (Boolean) getStateHelper().eval(PropertyKeys.showMinutes, true);
}
public void setShowMinutes(final boolean showMinutes) {
getStateHelper().put(PropertyKeys.showMinutes, showMinutes);
}
public boolean isShowCloseButton() {
return (Boolean) getStateHelper().eval(PropertyKeys.showCloseButton, false);
}
public void setShowCloseButton(final boolean showCloseButton) {
getStateHelper().put(PropertyKeys.showCloseButton, showCloseButton);
}
public boolean isShowDeselectButton() {
return (Boolean) getStateHelper().eval(PropertyKeys.showDeselectButton, false);
}
public void setShowDeselectButton(final boolean showDeselectButton) {
getStateHelper().put(PropertyKeys.showDeselectButton, showDeselectButton);
}
public boolean isShowNowButton() {
return (Boolean) getStateHelper().eval(PropertyKeys.showNowButton, false);
}
public void setShowNowButton(final boolean showNowButton) {
getStateHelper().put(PropertyKeys.showNowButton, showNowButton);
}
public String getOnHourShow() {
return (String) getStateHelper().eval(PropertyKeys.onHourShow, null);
}
public void setOnHourShow(final String onHourShow) {
getStateHelper().put(PropertyKeys.onHourShow, onHourShow);
}
public String getOnMinuteShow() {
return (String) getStateHelper().eval(PropertyKeys.onMinuteShow, null);
}
public void setOnMinuteShow(final String onMinuteShow) {
getStateHelper().put(PropertyKeys.onMinuteShow, onMinuteShow);
}
public String getShowOn() {
return (String) getStateHelper().eval(PropertyKeys.showOn, "focus");
}
public void setShowOn(final String showOn) {
getStateHelper().put(PropertyKeys.showOn, showOn);
}
public Object getLocale() {
return getStateHelper().eval(PropertyKeys.locale, null);
}
public void setLocale(final Object locale) {
getStateHelper().put(PropertyKeys.locale, locale);
}
public Integer getMinHour() {
return (Integer) getStateHelper().eval(PropertyKeys.minHour, null);
}
public void setMinHour(final Integer minHour) {
getStateHelper().put(PropertyKeys.minHour, minHour);
}
public Integer getMinMinute() {
return (Integer) getStateHelper().eval(PropertyKeys.minMinute, null);
}
public void setMinMinute(final Integer minMinute) {
getStateHelper().put(PropertyKeys.minMinute, minMinute);
}
public Integer getMaxHour() {
return (Integer) getStateHelper().eval(PropertyKeys.maxHour, null);
}
public void setMaxHour(final Integer maxHour) {
getStateHelper().put(PropertyKeys.maxHour, maxHour);
}
public Integer getMaxMinute() {
return (Integer) getStateHelper().eval(PropertyKeys.maxMinute, null);
}
public void setMaxMinute(final Integer maxMinute) {
getStateHelper().put(PropertyKeys.maxMinute, maxMinute);
}
public Locale calculateLocale(final FacesContext fc) {
if (appropriateLocale == null) {
Object userLocale = getLocale();
if (userLocale != null) {
if (userLocale instanceof String) {
appropriateLocale = LocaleUtils.toLocale((String) userLocale);
} else if (userLocale instanceof java.util.Locale) {
appropriateLocale = (Locale) userLocale;
} else {
throw new IllegalArgumentException(userLocale.getClass() + " is not a valid locale for timepicker:"
+ this.getClientId(fc));
}
} else {
appropriateLocale = fc.getViewRoot().getLocale();
}
}
return appropriateLocale;
}
public boolean isInline() {
return getMode().equalsIgnoreCase("inline");
}
public boolean isSpinner() {
return getMode().equalsIgnoreCase("spinner");
}
@Override
public Collection getEventNames() {
return EVENT_NAMES;
}
@Override
public void queueEvent(final FacesEvent event) {
FacesContext fc = FacesContext.getCurrentInstance();
String eventName = fc.getExternalContext().getRequestParameterMap().get(Constants.RequestParams.PARTIAL_BEHAVIOR_EVENT_PARAM);
if (isSelfRequest(fc) && event instanceof AjaxBehaviorEvent) {
if ("timeSelect".equals(eventName)) {
customEvents.put("timeSelect", (AjaxBehaviorEvent) event);
return;
} else if ("beforeShow".equals(eventName)) {
BeforeShowEvent beforeShowEvent = new BeforeShowEvent(this, ((AjaxBehaviorEvent) event).getBehavior());
beforeShowEvent.setPhaseId(event.getPhaseId());
super.queueEvent(beforeShowEvent);
return;
} else if ("close".equals(eventName)) {
CloseEvent closeEvent = new CloseEvent(this, ((AjaxBehaviorEvent) event).getBehavior());
closeEvent.setPhaseId(event.getPhaseId());
super.queueEvent(closeEvent);
return;
}
}
super.queueEvent(event);
}
@Override
public void validate(final FacesContext fc) {
super.validate(fc);
if (isValid()) {
for (Iterator customEventIter = customEvents.keySet().iterator(); customEventIter.hasNext();) {
AjaxBehaviorEvent behaviorEvent = customEvents.get(customEventIter.next());
TimeSelectEvent timeSelectEvent = new TimeSelectEvent(this, behaviorEvent.getBehavior(), (Date) getValue());
if (behaviorEvent.getPhaseId().equals(PhaseId.APPLY_REQUEST_VALUES)) {
timeSelectEvent.setPhaseId(PhaseId.PROCESS_VALIDATIONS);
} else {
timeSelectEvent.setPhaseId(PhaseId.INVOKE_APPLICATION);
}
super.queueEvent(timeSelectEvent);
}
}
}
public String getTimePattern24() {
return "HH" + getTimeSeparator() + "mm";
}
public String getTimePattern12() {
return "hh" + getTimeSeparator() + "mm a";
}
private boolean isSelfRequest(final FacesContext fc) {
return this.getClientId(fc).equals(fc.getExternalContext().getRequestParameterMap().get(Constants.RequestParams.PARTIAL_SOURCE_PARAM));
}
public String resolveWidgetVar() {
return ComponentUtils.resolveWidgetVar(getFacesContext(), this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy