/*
* Ext GWT - Ext for GWT
* Copyright(c) 2007, 2008, Ext JS, LLC.
* licensing@extjs.com
*
* http://extjs.com/license
*/
package com.extjs.gxt.ui.client.widget.form;
import java.util.Date;
import com.extjs.gxt.ui.client.Events;
import com.extjs.gxt.ui.client.GXT;
import com.extjs.gxt.ui.client.event.ComponentEvent;
import com.extjs.gxt.ui.client.event.FieldEvent;
import com.extjs.gxt.ui.client.event.Listener;
import com.extjs.gxt.ui.client.util.BaseEventPreview;
import com.extjs.gxt.ui.client.util.DateWrapper;
import com.extjs.gxt.ui.client.util.Format;
import com.extjs.gxt.ui.client.util.KeyNav;
import com.extjs.gxt.ui.client.util.Rectangle;
import com.extjs.gxt.ui.client.widget.DatePicker;
import com.extjs.gxt.ui.client.widget.menu.DateMenu;
import com.google.gwt.i18n.client.DateTimeFormat;
import com.google.gwt.user.client.Element;
/**
* Provides a date input field with a {@link DatePicker} dropdown and automatic
* date validation.
*/
public class DateField extends TriggerField<Date> {
/**
* DateField error messages.
*/
public class DateFieldMessages extends TextFieldMessages {
private String minText;
private String maxText;
private String invalidText;
/**
* Returns the invalid text.
*
* @return the invalid text
*/
public String getInvalidText() {
return invalidText;
}
/**
* Returns the max error text.
*
* @return the error text
*/
public String getMaxText() {
return maxText;
}
/**
* Returns the min error text.
*
* @return the error text
*/
public String getMinText() {
return minText;
}
/**
* "The error text to display when the date in the field is invalid " +
* "(defaults to '{value} is not a valid date - it must be in the format
* {format}')."
*
* @param invalidText the invalid text
*/
public void setInvalidText(String invalidText) {
this.invalidText = invalidText;
}
/**
* Sets the error text to display when the date in the cell is after
* maxValue (defaults to 'The date in this field must be before {
* {@link #setMaxValue}').
*
* @param maxText the max error text
*/
public void setMaxText(String maxText) {
this.maxText = maxText;
}
/**
* The error text to display when the date in the cell is before minValue
* (defaults to 'The date in this field must be after {@link #setMinValue}
* ').
*
* @param minText the min text
*/
public void setMinText(String minText) {
this.minText = minText;
}
}
private Date minValue;
private Date maxValue;
private DateMenu menu;
private BaseEventPreview focusPreview;
private boolean formatValue;
/**
* Creates a new date field.
*/
public DateField() {
autoValidate = false;
propertyEditor = new DateTimePropertyEditor();
messages = new DateFieldMessages();
setTriggerStyle("x-form-date-trigger");
}
/**
* Returns the field's date picker.
*
* @return the date picker
*/
public DatePicker getDatePicker() {
if (menu == null) {
menu = new DateMenu();
menu.addListener(Events.Select, new Listener<ComponentEvent>() {
public void handleEvent(ComponentEvent ce) {
focusValue = getValue();
setValue(menu.getDate());
menu.hide();
el().blur();
}
});
menu.addListener(Events.Hide, new Listener<ComponentEvent>() {
public void handleEvent(ComponentEvent be) {
focus();
}
});
}
return menu.getDatePicker();
}
/**
* Returns the field's max value.
*
* @return the max value
*/
public Date getMaxValue() {
return maxValue;
}
@Override
public DateFieldMessages getMessages() {
return (DateFieldMessages) messages;
}
/**
* Returns the field's min value.
*
* @return the min value
*/
public Date getMinValue() {
return minValue;
}
@Override
public DateTimePropertyEditor getPropertyEditor() {
return (DateTimePropertyEditor) propertyEditor;
}
/**
* Returns true if formatting is enabled.
*
* @return the format value state
*/
public boolean isFormatValue() {
return formatValue;
}
/**
* True to format the user entered value using the field's property editor
* after passing validation (defaults to false). Format value should not be
* enabled when auto validating.
*
* @param formatValue true to format the user value
*/
public void setFormatValue(boolean formatValue) {
this.formatValue = formatValue;
}
/**
* Sets the field's max value.
*
* @param maxValue the max value
*/
public void setMaxValue(Date maxValue) {
if (maxValue != null) {
maxValue = new DateWrapper(maxValue).clearTime().asDate();
}
this.maxValue = maxValue;
}
/**
* The maximum date allowed.
*
* @param minValue the max value
*/
public void setMinValue(Date minValue) {
if (minValue != null) {
minValue = new DateWrapper(minValue).clearTime().asDate();
}
this.minValue = minValue;
}
@Override
public void setRawValue(String value) {
super.setRawValue(value);
}
protected void expand() {
DatePicker picker = getDatePicker();
Object v = getValue();
Date d = null;
if (v instanceof Date) {
d = (Date) v;
} else {
d = new Date();
}
picker.setValue(d, true);
picker.setMinDate(minValue);
picker.setMaxDate(maxValue);
menu.show(wrap.dom, "tl-bl?");
menu.focus();
}
@Override
protected void onBlur(final ComponentEvent ce) {
Rectangle rec = trigger.getBounds();
if (rec.contains(BaseEventPreview.getLastClientX(), BaseEventPreview.getLastClientY())) {
ce.stopEvent();
return;
}
if (menu != null && menu.isVisible()) {
return;
}
hasFocus = false;
doBlur(ce);
}
protected void onDown(FieldEvent fe) {
fe.cancelBubble();
if (menu == null || !menu.isAttached()) {
expand();
}
}
@Override
protected void onFocus(ComponentEvent ce) {
super.onFocus(ce);
focusPreview.add();
}
@Override
protected void onKeyPress(FieldEvent fe) {
super.onKeyPress(fe);
int code = fe.event.getKeyCode();
if (code == 8 || code == 9) {
if (menu != null && menu.isAttached()) {
menu.hide();
}
}
}
@Override
protected void onRender(Element target, int index) {
super.onRender(target, index);
focusPreview = new BaseEventPreview();
new KeyNav<FieldEvent>(this) {
public void onDown(FieldEvent fe) {
DateField.this.onDown(fe);
}
};
}
@Override
protected void onTriggerClick(ComponentEvent ce) {
super.onTriggerClick(ce);
if (disabled || isReadOnly()) {
return;
}
expand();
getInputEl().focus();
}
@Override
@SuppressWarnings("deprecation")
protected boolean validateValue(String value) {
if (!super.validateValue(value)) {
return false;
}
if (value.length() < 1) { // if it's blank and textfield didn't flag it then
// it's valid
return true;
}
DateTimeFormat format = getPropertyEditor().getFormat();
Date date = null;
try {
date = getPropertyEditor().convertStringValue(value);
} catch (Exception e) {
}
if (date == null) {
String error = null;
if (getMessages().getInvalidText() != null) {
error = Format.substitute(getMessages().getInvalidText(), 0);
} else {
error = GXT.MESSAGES.dateField_invalidText(value, format.getPattern().toUpperCase());
}
markInvalid(error);
return false;
}
if (minValue != null && date.before(minValue)) {
String error = null;
if (getMessages().getMinText() != null) {
error = Format.substitute(getMessages().getMinText(), format.format(minValue));
} else {
error = GXT.MESSAGES.dateField_minText(format.format(minValue));
}
markInvalid(error);
return false;
}
if (maxValue != null && date.after(maxValue)) {
String error = null;
if (getMessages().getMaxText() != null) {
error = Format.substitute(getMessages().getMaxText(), format.format(maxValue));
} else {
error = GXT.MESSAGES.dateField_maxText(format.format(maxValue));
}
markInvalid(error);
return false;
}
if (formatValue && getPropertyEditor().getFormat() != null) {
setRawValue(getPropertyEditor().getFormat().format(date));
}
return true;
}
private void doBlur(ComponentEvent ce) {
if (menu != null && menu.isVisible()) {
menu.hide();
}
super.onBlur(ce);
focusPreview.remove();
}
}