blob: 1588d0f5cd2f24a92905b2b681376fe2e310a985 [file] [log] [blame]
/*
* Copyright (C) 2010 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "third_party/blink/renderer/core/html/forms/multiple_fields_temporal_input_type_view.h"
#include "third_party/blink/renderer/core/css/style_change_reason.h"
#include "third_party/blink/renderer/core/css_value_keywords.h"
#include "third_party/blink/renderer/core/dom/document.h"
#include "third_party/blink/renderer/core/dom/events/scoped_event_queue.h"
#include "third_party/blink/renderer/core/dom/shadow_root.h"
#include "third_party/blink/renderer/core/events/keyboard_event.h"
#include "third_party/blink/renderer/core/events/mouse_event.h"
#include "third_party/blink/renderer/core/html/forms/base_temporal_input_type.h"
#include "third_party/blink/renderer/core/html/forms/date_time_fields_state.h"
#include "third_party/blink/renderer/core/html/forms/form_controller.h"
#include "third_party/blink/renderer/core/html/forms/html_data_list_element.h"
#include "third_party/blink/renderer/core/html/forms/html_input_element.h"
#include "third_party/blink/renderer/core/html/forms/html_option_element.h"
#include "third_party/blink/renderer/core/html/shadow/shadow_element_names.h"
#include "third_party/blink/renderer/core/layout/layout_theme.h"
#include "third_party/blink/renderer/core/page/focus_controller.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/core/style/computed_style.h"
#include "third_party/blink/renderer/platform/date_components.h"
#include "third_party/blink/renderer/platform/text/date_time_format.h"
#include "third_party/blink/renderer/platform/text/platform_locale.h"
#include "third_party/blink/renderer/platform/wtf/date_math.h"
namespace blink {
class DateTimeFormatValidator : public DateTimeFormat::TokenHandler {
public:
DateTimeFormatValidator()
: has_year_(false),
has_month_(false),
has_week_(false),
has_day_(false),
has_ampm_(false),
has_hour_(false),
has_minute_(false),
has_second_(false) {}
void VisitField(DateTimeFormat::FieldType, int) final;
void VisitLiteral(const String&) final {}
bool ValidateFormat(const String& format, const BaseTemporalInputType&);
private:
bool has_year_;
bool has_month_;
bool has_week_;
bool has_day_;
bool has_ampm_;
bool has_hour_;
bool has_minute_;
bool has_second_;
};
void DateTimeFormatValidator::VisitField(DateTimeFormat::FieldType field_type,
int) {
switch (field_type) {
case DateTimeFormat::kFieldTypeYear:
has_year_ = true;
break;
case DateTimeFormat::kFieldTypeMonth: // Fallthrough.
case DateTimeFormat::kFieldTypeMonthStandAlone:
has_month_ = true;
break;
case DateTimeFormat::kFieldTypeWeekOfYear:
has_week_ = true;
break;
case DateTimeFormat::kFieldTypeDayOfMonth:
has_day_ = true;
break;
case DateTimeFormat::kFieldTypePeriod:
has_ampm_ = true;
break;
case DateTimeFormat::kFieldTypeHour11: // Fallthrough.
case DateTimeFormat::kFieldTypeHour12:
has_hour_ = true;
break;
case DateTimeFormat::kFieldTypeHour23: // Fallthrough.
case DateTimeFormat::kFieldTypeHour24:
has_hour_ = true;
has_ampm_ = true;
break;
case DateTimeFormat::kFieldTypeMinute:
has_minute_ = true;
break;
case DateTimeFormat::kFieldTypeSecond:
has_second_ = true;
break;
default:
break;
}
}
bool DateTimeFormatValidator::ValidateFormat(
const String& format,
const BaseTemporalInputType& input_type) {
if (!DateTimeFormat::Parse(format, *this))
return false;
return input_type.IsValidFormat(has_year_, has_month_, has_week_, has_day_,
has_ampm_, has_hour_, has_minute_,
has_second_);
}
DateTimeEditElement*
MultipleFieldsTemporalInputTypeView::GetDateTimeEditElement() const {
return ToDateTimeEditElementOrDie(
GetElement().UserAgentShadowRoot()->getElementById(
shadow_element_names::DateTimeEdit()));
}
SpinButtonElement* MultipleFieldsTemporalInputTypeView::GetSpinButtonElement()
const {
return ToSpinButtonElementOrDie(
GetElement().UserAgentShadowRoot()->getElementById(
shadow_element_names::SpinButton()));
}
ClearButtonElement* MultipleFieldsTemporalInputTypeView::GetClearButtonElement()
const {
return ToClearButtonElementOrDie(
GetElement().UserAgentShadowRoot()->getElementById(
shadow_element_names::ClearButton()));
}
PickerIndicatorElement*
MultipleFieldsTemporalInputTypeView::GetPickerIndicatorElement() const {
return ToPickerIndicatorElementOrDie(
GetElement().UserAgentShadowRoot()->getElementById(
shadow_element_names::PickerIndicator()));
}
inline bool MultipleFieldsTemporalInputTypeView::ContainsFocusedShadowElement()
const {
return GetElement().UserAgentShadowRoot()->contains(
GetElement().GetDocument().FocusedElement());
}
void MultipleFieldsTemporalInputTypeView::DidBlurFromControl(
WebFocusType focus_type) {
// We don't need to call blur(). This function is called when control
// lost focus.
if (ContainsFocusedShadowElement())
return;
EventQueueScope scope;
// Remove focus ring by CSS "focus" pseudo class.
GetElement().SetFocused(false, focus_type);
if (SpinButtonElement* spin_button = GetSpinButtonElement())
spin_button->ReleaseCapture();
}
void MultipleFieldsTemporalInputTypeView::DidFocusOnControl(
WebFocusType focus_type) {
// We don't need to call focus(). This function is called when control
// got focus.
if (!ContainsFocusedShadowElement())
return;
// Add focus ring by CSS "focus" pseudo class.
// FIXME: Setting the focus flag to non-focused element is too tricky.
GetElement().SetFocused(true, focus_type);
}
void MultipleFieldsTemporalInputTypeView::EditControlValueChanged() {
String old_value = GetElement().value();
String new_value =
input_type_->SanitizeValue(GetDateTimeEditElement()->Value());
// Even if oldValue is null and newValue is "", we should assume they are
// same.
if ((old_value.IsEmpty() && new_value.IsEmpty()) || old_value == new_value) {
GetElement().SetNeedsValidityCheck();
} else {
GetElement().SetNonAttributeValueByUserEdit(new_value);
GetElement().SetNeedsStyleRecalc(kSubtreeStyleChange,
StyleChangeReasonForTracing::Create(
style_change_reason::kControlValue));
GetElement().DispatchInputEvent();
}
GetElement().NotifyFormStateChanged();
GetElement().UpdateClearButtonVisibility();
}
String MultipleFieldsTemporalInputTypeView::FormatDateTimeFieldsState(
const DateTimeFieldsState& state) const {
return input_type_->FormatDateTimeFieldsState(state);
}
bool MultipleFieldsTemporalInputTypeView::HasCustomFocusLogic() const {
return false;
}
bool MultipleFieldsTemporalInputTypeView::IsEditControlOwnerDisabled() const {
return GetElement().IsDisabledFormControl();
}
bool MultipleFieldsTemporalInputTypeView::IsEditControlOwnerReadOnly() const {
return GetElement().IsReadOnly();
}
void MultipleFieldsTemporalInputTypeView::FocusAndSelectSpinButtonOwner() {
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->FocusIfNoFocus();
}
bool MultipleFieldsTemporalInputTypeView::
ShouldSpinButtonRespondToMouseEvents() {
return !GetElement().IsDisabledOrReadOnly();
}
bool MultipleFieldsTemporalInputTypeView::
ShouldSpinButtonRespondToWheelEvents() {
if (!ShouldSpinButtonRespondToMouseEvents())
return false;
if (DateTimeEditElement* edit = GetDateTimeEditElement())
return edit->HasFocusedField();
return false;
}
void MultipleFieldsTemporalInputTypeView::SpinButtonStepDown() {
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->StepDown();
}
void MultipleFieldsTemporalInputTypeView::SpinButtonStepUp() {
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->StepUp();
}
void MultipleFieldsTemporalInputTypeView::SpinButtonDidReleaseMouseCapture(
SpinButtonElement::EventDispatch event_dispatch) {
if (event_dispatch == SpinButtonElement::kEventDispatchAllowed)
GetElement().DispatchFormControlChangeEvent();
}
bool MultipleFieldsTemporalInputTypeView::
IsPickerIndicatorOwnerDisabledOrReadOnly() const {
return GetElement().IsDisabledOrReadOnly();
}
void MultipleFieldsTemporalInputTypeView::PickerIndicatorChooseValue(
const String& value) {
if (GetElement().IsValidValue(value)) {
GetElement().setValue(value, kDispatchInputAndChangeEvent);
return;
}
DateTimeEditElement* edit = GetDateTimeEditElement();
if (!edit)
return;
EventQueueScope scope;
DateComponents date;
unsigned end;
if (date.ParseDate(value, 0, end) && end == value.length())
edit->SetOnlyYearMonthDay(date);
GetElement().DispatchFormControlChangeEvent();
}
void MultipleFieldsTemporalInputTypeView::PickerIndicatorChooseValue(
double value) {
DCHECK(std::isfinite(value) || std::isnan(value));
if (std::isnan(value))
GetElement().setValue(g_empty_string, kDispatchInputAndChangeEvent);
else
GetElement().setValueAsNumber(value, ASSERT_NO_EXCEPTION,
kDispatchInputAndChangeEvent);
}
Element& MultipleFieldsTemporalInputTypeView::PickerOwnerElement() const {
return GetElement();
}
bool MultipleFieldsTemporalInputTypeView::SetupDateTimeChooserParameters(
DateTimeChooserParameters& parameters) {
return GetElement().SetupDateTimeChooserParameters(parameters);
}
MultipleFieldsTemporalInputTypeView::MultipleFieldsTemporalInputTypeView(
HTMLInputElement& element,
BaseTemporalInputType& input_type)
: InputTypeView(element),
input_type_(input_type),
is_destroying_shadow_subtree_(false),
picker_indicator_is_visible_(false),
picker_indicator_is_always_visible_(false) {}
MultipleFieldsTemporalInputTypeView*
MultipleFieldsTemporalInputTypeView::Create(HTMLInputElement& element,
BaseTemporalInputType& input_type) {
return MakeGarbageCollected<MultipleFieldsTemporalInputTypeView>(element,
input_type);
}
MultipleFieldsTemporalInputTypeView::~MultipleFieldsTemporalInputTypeView() =
default;
void MultipleFieldsTemporalInputTypeView::Trace(Visitor* visitor) {
visitor->Trace(input_type_);
InputTypeView::Trace(visitor);
}
void MultipleFieldsTemporalInputTypeView::Blur() {
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->BlurByOwner();
}
scoped_refptr<ComputedStyle>
MultipleFieldsTemporalInputTypeView::CustomStyleForLayoutObject(
scoped_refptr<ComputedStyle> original_style) {
EDisplay original_display = original_style->Display();
EDisplay new_display = original_display;
if (original_display == EDisplay::kInline ||
original_display == EDisplay::kInlineBlock)
new_display = EDisplay::kInlineFlex;
else if (original_display == EDisplay::kBlock)
new_display = EDisplay::kFlex;
TextDirection content_direction = ComputedTextDirection();
if (original_style->Direction() == content_direction &&
original_display == new_display)
return original_style;
scoped_refptr<ComputedStyle> style = ComputedStyle::Clone(*original_style);
style->SetDirection(content_direction);
style->SetDisplay(new_display);
return style;
}
void MultipleFieldsTemporalInputTypeView::CreateShadowSubtree() {
DCHECK(IsShadowHost(GetElement()));
// Element must not have a layoutObject here, because if it did
// DateTimeEditElement::customStyleForLayoutObject() is called in
// appendChild() before the field wrapper element is created.
// FIXME: This code should not depend on such craziness.
DCHECK(!GetElement().GetLayoutObject());
Document& document = GetElement().GetDocument();
ContainerNode* container = GetElement().UserAgentShadowRoot();
container->AppendChild(DateTimeEditElement::Create(document, *this));
GetElement().UpdateView();
container->AppendChild(ClearButtonElement::Create(document, *this));
container->AppendChild(SpinButtonElement::Create(document, *this));
if (LayoutTheme::GetTheme().SupportsCalendarPicker(
input_type_->FormControlType()))
picker_indicator_is_always_visible_ = true;
container->AppendChild(PickerIndicatorElement::Create(document, *this));
picker_indicator_is_visible_ = true;
UpdatePickerIndicatorVisibility();
}
void MultipleFieldsTemporalInputTypeView::DestroyShadowSubtree() {
DCHECK(!is_destroying_shadow_subtree_);
is_destroying_shadow_subtree_ = true;
if (SpinButtonElement* element = GetSpinButtonElement())
element->RemoveSpinButtonOwner();
if (ClearButtonElement* element = GetClearButtonElement())
element->RemoveClearButtonOwner();
if (DateTimeEditElement* element = GetDateTimeEditElement())
element->RemoveEditControlOwner();
if (PickerIndicatorElement* element = GetPickerIndicatorElement())
element->RemovePickerIndicatorOwner();
// If a field element has focus, set focus back to the <input> itself before
// deleting the field. This prevents unnecessary focusout/blur events.
if (ContainsFocusedShadowElement())
GetElement().focus();
InputTypeView::DestroyShadowSubtree();
is_destroying_shadow_subtree_ = false;
}
void MultipleFieldsTemporalInputTypeView::HandleClickEvent(MouseEvent& event) {
if (!event.isTrusted()) {
UseCounter::Count(GetElement().GetDocument(),
WebFeature::kTemporalInputTypeIgnoreUntrustedClick);
}
}
void MultipleFieldsTemporalInputTypeView::HandleFocusInEvent(
Element* old_focused_element,
WebFocusType type) {
DateTimeEditElement* edit = GetDateTimeEditElement();
if (!edit || is_destroying_shadow_subtree_)
return;
if (type == kWebFocusTypeBackward) {
if (GetElement().GetDocument().GetPage())
GetElement().GetDocument().GetPage()->GetFocusController().AdvanceFocus(
type);
} else if (type == kWebFocusTypeNone || type == kWebFocusTypeMouse ||
type == kWebFocusTypePage) {
edit->FocusByOwner(old_focused_element);
} else {
edit->FocusByOwner();
}
}
void MultipleFieldsTemporalInputTypeView::ForwardEvent(Event& event) {
if (SpinButtonElement* element = GetSpinButtonElement()) {
element->ForwardEvent(event);
if (event.DefaultHandled())
return;
}
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->DefaultEventHandler(event);
}
void MultipleFieldsTemporalInputTypeView::DisabledAttributeChanged() {
EventQueueScope scope;
GetSpinButtonElement()->ReleaseCapture();
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->DisabledStateChanged();
}
void MultipleFieldsTemporalInputTypeView::RequiredAttributeChanged() {
UpdateClearButtonVisibility();
}
void MultipleFieldsTemporalInputTypeView::HandleKeydownEvent(
KeyboardEvent& event) {
if (!GetElement().IsFocused())
return;
if (picker_indicator_is_visible_ &&
((event.key() == "ArrowDown" && event.getModifierState("Alt")) ||
(LayoutTheme::GetTheme().ShouldOpenPickerWithF4Key() &&
event.key() == "F4"))) {
if (PickerIndicatorElement* element = GetPickerIndicatorElement())
element->OpenPopup();
event.SetDefaultHandled();
} else {
ForwardEvent(event);
}
}
bool MultipleFieldsTemporalInputTypeView::HasBadInput() const {
DateTimeEditElement* edit = GetDateTimeEditElement();
return GetElement().value().IsEmpty() && edit &&
edit->AnyEditableFieldsHaveValues();
}
AtomicString MultipleFieldsTemporalInputTypeView::LocaleIdentifier() const {
return GetElement().ComputeInheritedLanguage();
}
void MultipleFieldsTemporalInputTypeView::
EditControlDidChangeValueByKeyboard() {
GetElement().DispatchFormControlChangeEvent();
}
void MultipleFieldsTemporalInputTypeView::MinOrMaxAttributeChanged() {
UpdateView();
}
void MultipleFieldsTemporalInputTypeView::ReadonlyAttributeChanged() {
EventQueueScope scope;
GetSpinButtonElement()->ReleaseCapture();
if (DateTimeEditElement* edit = GetDateTimeEditElement())
edit->ReadOnlyStateChanged();
}
void MultipleFieldsTemporalInputTypeView::RestoreFormControlState(
const FormControlState& state) {
DateTimeEditElement* edit = GetDateTimeEditElement();
if (!edit)
return;
DateTimeFieldsState date_time_fields_state =
DateTimeFieldsState::RestoreFormControlState(state);
edit->SetValueAsDateTimeFieldsState(date_time_fields_state);
GetElement().SetNonAttributeValue(input_type_->SanitizeValue(edit->Value()));
UpdateClearButtonVisibility();
}
FormControlState MultipleFieldsTemporalInputTypeView::SaveFormControlState()
const {
if (DateTimeEditElement* edit = GetDateTimeEditElement())
return edit->ValueAsDateTimeFieldsState().SaveFormControlState();
return FormControlState();
}
void MultipleFieldsTemporalInputTypeView::DidSetValue(
const String& sanitized_value,
bool value_changed) {
DateTimeEditElement* edit = GetDateTimeEditElement();
if (value_changed || (sanitized_value.IsEmpty() && edit &&
edit->AnyEditableFieldsHaveValues())) {
GetElement().UpdateView();
GetElement().SetNeedsValidityCheck();
}
}
void MultipleFieldsTemporalInputTypeView::StepAttributeChanged() {
UpdateView();
}
void MultipleFieldsTemporalInputTypeView::UpdateView() {
DateTimeEditElement* edit = GetDateTimeEditElement();
if (!edit)
return;
DateTimeEditElement::LayoutParameters layout_parameters(
GetElement().GetLocale(),
input_type_->CreateStepRange(kAnyIsDefaultStep));
DateComponents date;
bool has_value = false;
if (!GetElement().SuggestedValue().IsNull())
has_value = input_type_->ParseToDateComponents(
GetElement().SuggestedValue(), &date);
else
has_value = input_type_->ParseToDateComponents(GetElement().value(), &date);
if (!has_value)
input_type_->SetMillisecondToDateComponents(
layout_parameters.step_range.Minimum().ToDouble(), &date);
input_type_->SetupLayoutParameters(layout_parameters, date);
DEFINE_STATIC_LOCAL(AtomicString, datetimeformat_attr, ("datetimeformat"));
edit->setAttribute(datetimeformat_attr,
AtomicString(layout_parameters.date_time_format),
ASSERT_NO_EXCEPTION);
const AtomicString pattern = edit->FastGetAttribute(html_names::kPatternAttr);
if (!pattern.IsEmpty())
layout_parameters.date_time_format = pattern;
if (!DateTimeFormatValidator().ValidateFormat(
layout_parameters.date_time_format, *input_type_))
layout_parameters.date_time_format =
layout_parameters.fallback_date_time_format;
if (has_value)
edit->SetValueAsDate(layout_parameters, date);
else
edit->SetEmptyValue(layout_parameters, date);
UpdateClearButtonVisibility();
}
void MultipleFieldsTemporalInputTypeView::ClosePopupView() {
if (PickerIndicatorElement* picker = GetPickerIndicatorElement())
picker->ClosePopup();
}
void MultipleFieldsTemporalInputTypeView::ValueAttributeChanged() {
if (!GetElement().HasDirtyValue())
UpdateView();
}
void MultipleFieldsTemporalInputTypeView::ListAttributeTargetChanged() {
UpdatePickerIndicatorVisibility();
}
void MultipleFieldsTemporalInputTypeView::UpdatePickerIndicatorVisibility() {
if (picker_indicator_is_always_visible_) {
ShowPickerIndicator();
return;
}
if (GetElement().HasValidDataListOptions())
ShowPickerIndicator();
else
HidePickerIndicator();
}
void MultipleFieldsTemporalInputTypeView::HidePickerIndicator() {
if (!picker_indicator_is_visible_)
return;
picker_indicator_is_visible_ = false;
DCHECK(GetPickerIndicatorElement());
GetPickerIndicatorElement()->SetInlineStyleProperty(CSSPropertyDisplay,
CSSValueNone);
}
void MultipleFieldsTemporalInputTypeView::ShowPickerIndicator() {
if (picker_indicator_is_visible_)
return;
picker_indicator_is_visible_ = true;
DCHECK(GetPickerIndicatorElement());
GetPickerIndicatorElement()->RemoveInlineStyleProperty(CSSPropertyDisplay);
}
void MultipleFieldsTemporalInputTypeView::FocusAndSelectClearButtonOwner() {
GetElement().focus();
}
bool MultipleFieldsTemporalInputTypeView::
ShouldClearButtonRespondToMouseEvents() {
return !GetElement().IsDisabledOrReadOnly() && !GetElement().IsRequired();
}
void MultipleFieldsTemporalInputTypeView::ClearValue() {
GetElement().setValue("", kDispatchInputAndChangeEvent);
GetElement().UpdateClearButtonVisibility();
}
void MultipleFieldsTemporalInputTypeView::UpdateClearButtonVisibility() {
ClearButtonElement* clear_button = GetClearButtonElement();
if (!clear_button)
return;
if (GetElement().IsRequired() ||
!GetDateTimeEditElement()->AnyEditableFieldsHaveValues()) {
clear_button->SetInlineStyleProperty(CSSPropertyOpacity, 0.0,
CSSPrimitiveValue::UnitType::kNumber);
clear_button->SetInlineStyleProperty(CSSPropertyPointerEvents,
CSSValueNone);
} else {
clear_button->RemoveInlineStyleProperty(CSSPropertyOpacity);
clear_button->RemoveInlineStyleProperty(CSSPropertyPointerEvents);
}
}
TextDirection MultipleFieldsTemporalInputTypeView::ComputedTextDirection() {
return GetElement().GetLocale().IsRTL() ? TextDirection::kRtl
: TextDirection::kLtr;
}
AXObject* MultipleFieldsTemporalInputTypeView::PopupRootAXObject() {
if (PickerIndicatorElement* picker = GetPickerIndicatorElement())
return picker->PopupRootAXObject();
return nullptr;
}
} // namespace blink