Refactoring: Remove HTMLFormControlElement::autofocus
[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
71     virtual bool isFocusable() const;
72     virtual bool isEnumeratable() const { return false; }
73
74     bool isRequired() const;
75
76     const AtomicString& type() const { return formControlType(); }
77
78     virtual const AtomicString& formControlType() const OVERRIDE = 0;
79     virtual bool isEnabledFormControl() const { return !disabled(); }
80
81     virtual bool canTriggerImplicitSubmission() const { return false; }
82
83     // Override in derived classes to get the encoded name=value pair for submitting.
84     // Return true for a successful control (see HTML4-17.13.2).
85     virtual bool appendFormData(FormDataList&, bool) { return false; }
86
87     virtual bool isSuccessfulSubmitButton() const { return false; }
88     virtual bool isActivatedSubmit() const { return false; }
89     virtual void setActivatedSubmit(bool) { }
90
91     virtual bool willValidate() const;
92     void updateVisibleValidationMessage();
93     void hideVisibleValidationMessage();
94     bool checkValidity(Vector<RefPtr<FormAssociatedElement> >* unhandledInvalidControls = 0);
95     // This must be called when a validation constraint or control value is changed.
96     void setNeedsValidityCheck();
97     virtual void setCustomValidity(const String&) OVERRIDE;
98
99     bool readOnly() const { return m_readOnly; }
100     bool isDisabledOrReadOnly() const { return disabled() || m_readOnly; }
101
102     bool hasAutofocused() { return m_hasAutofocused; }
103     void setAutofocused() { m_hasAutofocused = true; }
104
105     static HTMLFormControlElement* enclosingFormControlElement(Node*);
106
107     using Node::ref;
108     using Node::deref;
109
110     virtual void reportMemoryUsage(MemoryObjectInfo*) const OVERRIDE;
111
112 protected:
113     HTMLFormControlElement(const QualifiedName& tagName, Document*, HTMLFormElement*);
114
115     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
116     virtual void requiredAttributeChanged();
117     virtual void disabledAttributeChanged();
118     virtual void attach();
119     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
120     virtual void removedFrom(ContainerNode*) OVERRIDE;
121     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
122
123     virtual bool supportsFocus() const;
124     virtual bool isKeyboardFocusable(KeyboardEvent*) const;
125     virtual bool isMouseFocusable() const;
126
127     virtual void didRecalcStyle(StyleChange) OVERRIDE;
128
129     virtual void dispatchBlurEvent(PassRefPtr<Node> newFocusedNode);
130
131     // This must be called any time the result of willValidate() has changed.
132     void setNeedsWillValidateCheck();
133     virtual bool recalcWillValidate() const;
134
135     bool validationMessageShadowTreeContains(Node*) const;
136
137 private:
138     virtual void refFormAssociatedElement() { ref(); }
139     virtual void derefFormAssociatedElement() { deref(); }
140
141     virtual bool isFormControlElement() const { return true; }
142
143     virtual short tabIndex() const;
144
145     virtual HTMLFormElement* virtualForm() const;
146     virtual bool isDefaultButtonForForm() const;
147     virtual bool isValidFormControlElement();
148     void updateAncestorDisabledState() const;
149
150     OwnPtr<ValidationMessage> m_validationMessage;
151     bool m_disabled : 1;
152     bool m_readOnly : 1;
153     bool m_isRequired : 1;
154     bool m_valueMatchesRenderer : 1;
155
156     enum AncestorDisabledState { AncestorDisabledStateUnknown, AncestorDisabledStateEnabled, AncestorDisabledStateDisabled };
157     mutable AncestorDisabledState m_ancestorDisabledState;
158     enum DataListAncestorState { Unknown, InsideDataList, NotInsideDataList };
159     mutable enum DataListAncestorState m_dataListAncestorState;
160
161     // The initial value of m_willValidate depends on the derived class. We can't
162     // initialize it with a virtual function in the constructor. m_willValidate
163     // is not deterministic as long as m_willValidateInitialized is false.
164     mutable bool m_willValidateInitialized: 1;
165     mutable bool m_willValidate : 1;
166
167     // Cache of validity()->valid().
168     // But "candidate for constraint validation" doesn't affect m_isValid.
169     bool m_isValid : 1;
170
171     bool m_wasChangedSinceLastFormControlChangeEvent : 1;
172
173     bool m_hasAutofocused : 1;
174 };
175
176 } // namespace
177
178 #endif