summaryrefslogtreecommitdiff
path: root/chromium/third_party/blink/renderer/core/html/forms/date_time_edit_element.h
blob: b241d8d00df64d61e1557eb0f58ff2722aacfbb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
 * Copyright (C) 2012 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:
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_HTML_FORMS_DATE_TIME_EDIT_ELEMENT_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_HTML_FORMS_DATE_TIME_EDIT_ELEMENT_H_

#include "base/macros.h"
#include "third_party/blink/public/mojom/input/focus_type.mojom-blink-forward.h"
#include "third_party/blink/renderer/core/html/forms/date_time_field_element.h"
#include "third_party/blink/renderer/core/html/forms/step_range.h"
#include "third_party/blink/renderer/platform/text/date_components.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"

namespace blink {

class DateTimeFieldsState;
class Locale;
class StepRange;
enum class DateTimeField;

// DateTimeEditElement class contains numberic field and symbolc field for
// representing date and time, such as
//  - Year, Month, Day Of Month
//  - Hour, Minute, Second, Millisecond, AM/PM
class DateTimeEditElement final : public HTMLDivElement,
                                  public DateTimeFieldElement::FieldOwner {
  USING_GARBAGE_COLLECTED_MIXIN(DateTimeEditElement);

 public:
  // EditControlOwner implementer must call removeEditControlOwner when
  // it doesn't handle event, e.g. at destruction.
  class EditControlOwner : public GarbageCollectedMixin {
   public:
    virtual ~EditControlOwner();
    virtual void DidBlurFromControl(mojom::blink::FocusType) = 0;
    virtual void DidFocusOnControl(mojom::blink::FocusType) = 0;
    virtual void EditControlValueChanged() = 0;
    virtual String FormatDateTimeFieldsState(
        const DateTimeFieldsState&) const = 0;
    virtual bool IsEditControlOwnerDisabled() const = 0;
    virtual bool IsEditControlOwnerReadOnly() const = 0;
    virtual AtomicString LocaleIdentifier() const = 0;
    virtual void EditControlDidChangeValueByKeyboard() = 0;
  };

  struct LayoutParameters {
    STACK_ALLOCATED();

   public:
    String date_time_format;
    String fallback_date_time_format;
    Locale& locale;
    const StepRange step_range;
    DateComponents minimum;
    DateComponents maximum;
    String placeholder_for_day;
    String placeholder_for_month;
    String placeholder_for_year;

    LayoutParameters(Locale& locale, const StepRange& step_range)
        : locale(locale), step_range(step_range) {}
  };

  DateTimeEditElement(Document&, EditControlOwner&);
  ~DateTimeEditElement() override;
  void Trace(Visitor*) override;

  void AddField(DateTimeFieldElement*);
  bool AnyEditableFieldsHaveValues() const;
  void BlurByOwner();
  void DefaultEventHandler(Event&) override;
  void DisabledStateChanged();
  Element* FieldsWrapperElement() const;
  void FocusIfNoFocus();
  // If oldFocusedNode is one of sub-fields, focus on it. Otherwise focus on
  // the first sub-field.
  void FocusByOwner(Element* old_focused_element = nullptr);
  bool HasFocusedField();
  void ReadOnlyStateChanged();
  void RemoveEditControlOwner() { edit_control_owner_ = nullptr; }
  void ResetFields();
  void SetEmptyValue(const LayoutParameters&,
                     const DateComponents& date_for_read_only_field);
  void SetValueAsDate(const LayoutParameters&, const DateComponents&);
  void SetValueAsDateTimeFieldsState(const DateTimeFieldsState&);
  void SetOnlyYearMonthDay(const DateComponents&);
  void SetOnlyTime(const DateComponents&);
  void StepDown();
  void StepUp();
  String Value() const;
  DateTimeFieldsState ValueAsDateTimeFieldsState() const;
  bool HasField(DateTimeField) const;
  bool IsFirstFieldAMPM() const;

 private:
  static const wtf_size_t kInvalidFieldIndex = UINT_MAX;

  // Datetime can be represent at most five fields, such as
  //  1. year
  //  2. month
  //  3. day-of-month
  //  4. hour
  //  5. minute
  //  6. second
  //  7. millisecond
  //  8. AM/PM
  static const int kMaximumNumberOfFields = 8;

  DateTimeFieldElement* FieldAt(wtf_size_t) const;
  wtf_size_t FieldIndexOf(const DateTimeFieldElement&) const;
  DateTimeFieldElement* FocusedField() const;
  wtf_size_t FocusedFieldIndex() const;
  bool FocusOnNextFocusableField(wtf_size_t start_index);
  bool IsDisabled() const;
  bool IsReadOnly() const;
  void GetLayout(const LayoutParameters&, const DateComponents&);
  void UpdateUIState();

  // Element function.
  scoped_refptr<ComputedStyle> CustomStyleForLayoutObject() override;
  bool IsDateTimeEditElement() const override;

  // DateTimeFieldElement::FieldOwner functions.
  void DidBlurFromField(mojom::blink::FocusType) override;
  void DidFocusOnField(mojom::blink::FocusType) override;
  void FieldValueChanged() override;
  bool FocusOnNextField(const DateTimeFieldElement&) override;
  bool FocusOnPreviousField(const DateTimeFieldElement&) override;
  bool IsFieldOwnerDisabled() const override;
  bool IsFieldOwnerReadOnly() const override;
  AtomicString LocaleIdentifier() const override;
  void FieldDidChangeValueByKeyboard() override;

  HeapVector<Member<DateTimeFieldElement>, kMaximumNumberOfFields> fields_;
  Member<EditControlOwner> edit_control_owner_;

  DISALLOW_COPY_AND_ASSIGN(DateTimeEditElement);
};

template <>
struct DowncastTraits<DateTimeEditElement> {
  static bool AllowFrom(const Element& element) {
    return element.IsDateTimeEditElement();
  }
};

}  // namespace blink

#endif