Unreviewed, rolling out r124171.
[WebKit-https.git] / Source / WebCore / html / HTMLFormControlElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef HTMLFormControlElement_h
25 #define HTMLFormControlElement_h
26
27 #include "FormAssociatedElement.h"
28 #include "LabelableElement.h"
29
30 namespace WebCore {
31
32 class FormDataList;
33 class HTMLFieldSetElement;
34 class HTMLFormElement;
35 class HTMLLegendElement;
36 class ValidationMessage;
37 class ValidityState;
38
39 // HTMLFormControlElement is the default implementation of FormAssociatedElement,
40 // and form-associated element implementations should use HTMLFormControlElement
41 // unless there is a special reason.
42 class HTMLFormControlElement : public LabelableElement, public FormAssociatedElement {
43 public:
44     virtual ~HTMLFormControlElement();
45
46     HTMLFormElement* form() const { return FormAssociatedElement::form(); }
47
48     void willAddAuthorShadowRoot() OVERRIDE;
49
50     String formEnctype() const;
51     void setFormEnctype(const String&);
52     String formMethod() const;
53     void setFormMethod(const String&);
54     bool formNoValidate() const;
55
56     void ancestorDisabledStateWasChanged();
57
58     virtual void reset() { }
59
60     virtual bool formControlValueMatchesRenderer() const { return m_valueMatchesRenderer; }
61     virtual void setFormControlValueMatchesRenderer(bool b) { m_valueMatchesRenderer = b; }
62
63     virtual bool wasChangedSinceLastFormControlChangeEvent() const;
64     virtual void setChangedSinceLastFormControlChangeEvent(bool);
65
66     virtual void dispatchFormControlChangeEvent();
67     virtual void dispatchFormControlInputEvent();
68
69     virtual bool disabled() const;
70     void setDisabled(bool);
71
72     virtual bool isFocusable() const;
73     virtual bool isEnumeratable() const { return false; }
74
75     // Determines whether or not a control will be automatically focused.
76     virtual bool autofocus() const;
77
78     bool required() const;
79
80     const AtomicString& type() const { return formControlType(); }
81
82     virtual const AtomicString& formControlType() const OVERRIDE = 0;
83     virtual bool isEnabledFormControl() const { return !disabled(); }
84     virtual bool isReadOnlyFormControl() const { return readOnly(); }
85
86     virtual bool canTriggerImplicitSubmission() const { return false; }
87
88     // Override in derived classes to get the encoded name=value pair for submitting.
89     // Return true for a successful control (see HTML4-17.13.2).
90     virtual bool appendFormData(FormDataList&, bool) { return false; }
91
92     virtual bool isSuccessfulSubmitButton() const { return false; }
93     virtual bool isActivatedSubmit() const { return false; }
94     virtual void setActivatedSubmit(bool) { }
95
96     virtual bool willValidate() const;
97     void updateVisibleValidationMessage();
98     void hideVisibleValidationMessage();
99     bool checkValidity(Vector<RefPtr<FormAssociatedElement> >* unhandledInvalidControls = 0);
100     // This must be called when a validation constraint or control value is changed.
101     void setNeedsValidityCheck();
102     virtual void setCustomValidity(const String&) OVERRIDE;
103
104     bool readOnly() const { return m_readOnly; }
105
106     bool hasAutofocused() { return m_hasAutofocused; }
107     void setAutofocused() { m_hasAutofocused = true; }
108
109     static HTMLFormControlElement* enclosingFormControlElement(Node*);
110
111     using Node::ref;
112     using Node::deref;
113
114 protected:
115     HTMLFormControlElement(const QualifiedName& tagName, Document*, HTMLFormElement*);
116
117     virtual void parseAttribute(const Attribute&) OVERRIDE;
118     virtual void requiredAttributeChanged();
119     virtual void disabledAttributeChanged();
120     virtual void attach();
121     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
122     virtual void removedFrom(ContainerNode*) OVERRIDE;
123     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
124
125     virtual bool supportsFocus() const;
126     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
127     virtual bool isMouseFocusable() const;
128
129     virtual void didRecalcStyle(StyleChange) OVERRIDE;
130
131     virtual void dispatchBlurEvent(PassRefPtr<Node> newFocusedNode);
132
133     // This must be called any time the result of willValidate() has changed.
134     void setNeedsWillValidateCheck();
135     virtual bool recalcWillValidate() const;
136
137     bool validationMessageShadowTreeContains(Node*) const;
138
139 private:
140     virtual void refFormAssociatedElement() { ref(); }
141     virtual void derefFormAssociatedElement() { deref(); }
142
143     virtual bool isFormControlElement() const { return true; }
144
145     virtual short tabIndex() const;
146
147     virtual HTMLFormElement* virtualForm() const;
148     virtual bool isDefaultButtonForForm() const;
149     virtual bool isValidFormControlElement();
150     String visibleValidationMessage() const;
151     void updateAncestorDisabledState() const;
152
153     OwnPtr<ValidationMessage> m_validationMessage;
154     bool m_disabled : 1;
155     bool m_readOnly : 1;
156     bool m_required : 1;
157     bool m_valueMatchesRenderer : 1;
158
159     enum AncestorDisabledState { AncestorDisabledStateUnknown, AncestorDisabledStateEnabled, AncestorDisabledStateDisabled };
160     mutable AncestorDisabledState m_ancestorDisabledState;
161     enum DataListAncestorState { Unknown, InsideDataList, NotInsideDataList };
162     mutable enum DataListAncestorState m_dataListAncestorState;
163
164     // The initial value of m_willValidate depends on the derived class. We can't
165     // initialize it with a virtual function in the constructor. m_willValidate
166     // is not deterministic as long as m_willValidateInitialized is false.
167     mutable bool m_willValidateInitialized: 1;
168     mutable bool m_willValidate : 1;
169
170     // Cache of validity()->valid().
171     // But "candidate for constraint validation" doesn't affect m_isValid.
172     bool m_isValid : 1;
173
174     bool m_wasChangedSinceLastFormControlChangeEvent : 1;
175
176     bool m_hasAutofocused : 1;
177 };
178
179 } // namespace
180
181 #endif