ca2ec9a478cc3acd07b11f2798083dd9ce00bb05
[WebKit-https.git] / Source / WebCore / html / HTMLTextAreaElement.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, 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 #pragma once
25
26 #include "HTMLTextFormControlElement.h"
27
28 namespace WebCore {
29
30 class BeforeTextInsertedEvent;
31 class RenderTextControlMultiLine;
32 class VisibleSelection;
33
34 class HTMLTextAreaElement final : public HTMLTextFormControlElement {
35 public:
36     static Ref<HTMLTextAreaElement> create(const QualifiedName&, Document&, HTMLFormElement*);
37
38     unsigned cols() const { return m_cols; }
39     unsigned rows() const { return m_rows; }
40
41     bool shouldWrapText() const { return m_wrap != NoWrap; }
42
43     WEBCORE_EXPORT String value() const override;
44     WEBCORE_EXPORT void setValue(const String&);
45     String defaultValue() const;
46     void setDefaultValue(const String&);
47     int textLength() const { return value().length(); }
48     int maxLengthForBindings() const { return m_maxLength; }
49     int effectiveMaxLength() const { return m_maxLength; }
50     // For ValidityState
51     String validationMessage() const override;
52     bool valueMissing() const override;
53     bool tooLong() const override;
54     bool isValidValue(const String&) const;
55     
56     TextControlInnerTextElement* innerTextElement() const override;
57     RenderStyle createInnerTextStyle(const RenderStyle&) const override;
58
59     void rendererWillBeDestroyed();
60
61     void setCols(unsigned);
62     void setRows(unsigned);
63
64     bool willRespondToMouseClickEvents() override;
65
66     RenderTextControlMultiLine* renderer() const;
67
68 private:
69     HTMLTextAreaElement(const QualifiedName&, Document&, HTMLFormElement*);
70
71     enum WrapMethod { NoWrap, SoftWrap, HardWrap };
72
73     void didAddUserAgentShadowRoot(ShadowRoot*) override;
74
75     void maxLengthAttributeChanged(const AtomicString& newValue);
76
77     void handleBeforeTextInsertedEvent(BeforeTextInsertedEvent*) const;
78     static String sanitizeUserInputValue(const String&, unsigned maxLength);
79     void updateValue() const;
80     void setNonDirtyValue(const String&);
81     void setValueCommon(const String&);
82
83     bool supportsPlaceholder() const override { return true; }
84     HTMLElement* placeholderElement() const override;
85     void updatePlaceholderText() override;
86     bool isEmptyValue() const override { return value().isEmpty(); }
87
88     bool isOptionalFormControl() const override { return !isRequiredFormControl(); }
89     bool isRequiredFormControl() const override { return isRequired(); }
90
91     void defaultEventHandler(Event*) override;
92     
93     void subtreeHasChanged() override;
94
95     bool isEnumeratable() const override { return true; }
96     bool supportLabels() const override { return true; }
97
98     const AtomicString& formControlType() const override;
99
100     FormControlState saveFormControlState() const override;
101     void restoreFormControlState(const FormControlState&) override;
102
103     bool isTextFormControl() const override { return true; }
104
105     void childrenChanged(const ChildChange&) override;
106     void parseAttribute(const QualifiedName&, const AtomicString&) override;
107     bool isPresentationAttribute(const QualifiedName&) const override;
108     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
109     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
110     bool appendFormData(FormDataList&, bool) override;
111     void reset() override;
112     bool hasCustomFocusLogic() const override;
113     bool isMouseFocusable() const override;
114     bool isKeyboardFocusable(KeyboardEvent*) const override;
115     void updateFocusAppearance(SelectionRestorationMode, SelectionRevealMode) override;
116
117     void accessKeyAction(bool sendMouseEvents) override;
118
119     bool shouldUseInputMethod() override;
120     bool matchesReadWritePseudoClass() const override;
121
122     bool valueMissing(const String& value) const { return isRequiredFormControl() && !isDisabledOrReadOnly() && value.isEmpty(); }
123     bool tooLong(const String&, NeedsToCheckDirtyFlag) const;
124
125     unsigned m_rows;
126     unsigned m_cols;
127     int m_maxLength { -1 };
128     WrapMethod m_wrap { SoftWrap };
129     RefPtr<HTMLElement> m_placeholder;
130     mutable String m_value;
131     mutable bool m_isDirty { false };
132     mutable bool m_wasModifiedByUser { false };
133 };
134
135 } //namespace