[Forms] multiple fields time input UI should save/restore its value even if it has...
[WebKit-https.git] / Source / WebCore / html / shadow / DateTimeFieldElement.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1.  Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
20  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25
26 #ifndef DateTimeFieldElement_h
27 #define DateTimeFieldElement_h
28
29 #if ENABLE(INPUT_TYPE_TIME_MULTIPLE_FIELDS)
30
31 #include "HTMLDivElement.h"
32
33 namespace WebCore {
34
35 class DateComponents;
36 class DateTimeFieldsState;
37
38 // DateTimeFieldElement is base class of date time field element.
39 class DateTimeFieldElement : public HTMLElement {
40     WTF_MAKE_NONCOPYABLE(DateTimeFieldElement);
41
42 public:
43     enum EventBehavior {
44         DispatchNoEvent,
45         DispatchEvent,
46     };
47
48     // FieldOwner implementer must call removeEventHandler when
49     // it doesn't handle event, e.g. at destruction.
50     class FieldOwner {
51     public:
52         virtual ~FieldOwner();
53         virtual void didBlurFromField() = 0;
54         virtual void didFocusOnField() = 0;
55         virtual void fieldValueChanged() = 0;
56         virtual bool focusOnNextField(const DateTimeFieldElement&) = 0;
57         virtual bool focusOnPreviousField(const DateTimeFieldElement&) = 0;
58     };
59
60     virtual void defaultEventHandler(Event*) OVERRIDE;
61     virtual bool hasValue() const = 0;
62     bool isReadOnly() const;
63     virtual void populateDateTimeFieldsState(DateTimeFieldsState&) = 0;
64     void removeEventHandler() { m_fieldOwner = 0; }
65     void setReadOnly();
66     virtual void setEmptyValue(const DateComponents& dateForReadOnlyField, EventBehavior = DispatchNoEvent) = 0;
67     virtual void setValueAsDate(const DateComponents&) = 0;
68     virtual void setValueAsDateTimeFieldsState(const DateTimeFieldsState&, const DateComponents& dateForReadOnlyField) = 0;
69     virtual void setValueAsInteger(int, EventBehavior = DispatchNoEvent) = 0;
70     virtual void stepDown() = 0;
71     virtual void stepUp() = 0;
72     virtual String value() const = 0;
73     double valueAsDouble() const;
74     virtual int valueAsInteger() const = 0;
75     virtual String visibleValue() const = 0;
76
77 protected:
78     DateTimeFieldElement(Document*, FieldOwner&);
79     virtual void didBlur();
80     virtual void didFocus();
81     void focusOnNextField();
82     virtual void handleKeyboardEvent(KeyboardEvent*) = 0;
83     void initialize(const AtomicString& shadowPseudoId, const String& axHelpText);
84     virtual int maximum() const = 0;
85     virtual int minimum() const = 0;
86     virtual double unitInMillisecond() const = 0;
87     void updateVisibleValue(EventBehavior);
88
89 private:
90     void defaultKeyboardEventHandler(KeyboardEvent*);
91     virtual bool isFocusable() const OVERRIDE FINAL;
92     bool isRTL() const;
93     virtual bool supportsFocus() const OVERRIDE FINAL;
94
95     FieldOwner* m_fieldOwner;
96 };
97
98 } // namespace WebCore
99
100 #endif
101 #endif