InputElement.h revision 2fc2651226baac27029e38c9d6ef883fa32084db 
1/*
2 * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public License
15 * along with this library; see the file COPYING.LIB.  If not, write to
16 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 *
19 */
20
21#ifndef InputElement_h
22#define InputElement_h
23
24#include "PlatformString.h"
25#include <wtf/text/AtomicString.h>
26
27namespace WebCore {
28
29class Attribute;
30class Document;
31class Element;
32class Event;
33class InputElementData;
34
35class InputElement {
36public:
37    virtual ~InputElement() { }
38
39    virtual bool isAutofilled() const = 0;
40    virtual bool isChecked() const = 0;
41    virtual bool isIndeterminate() const = 0;
42    virtual bool isInputTypeHidden() const = 0;
43    virtual bool isPasswordField() const = 0;
44    virtual bool isSearchField() const = 0;
45    virtual bool isTextField() const = 0;
46    virtual bool isRadioButton() const = 0;
47    virtual bool isCheckbox() const = 0;
48
49    virtual bool supportsMaxLength() const = 0;
50    virtual bool hasSpinButton() const { return false; }
51#if ENABLE(INPUT_SPEECH)
52    virtual bool isSpeechEnabled() const = 0;
53#endif
54
55    virtual bool searchEventsShouldBeDispatched() const = 0;
56
57    virtual int size() const = 0;
58    virtual const String& suggestedValue() const = 0;
59    virtual String value() const = 0;
60    virtual void setValue(const String&, bool sendChangeEvent = false) = 0;
61    virtual void setValueForUser(const String&) = 0;
62    // The value which is drawn by a renderer.
63    virtual String visibleValue() const = 0;
64
65    // Returns true if the specified string can be set as the value of InputElement.
66    virtual bool isAcceptableValue(const String&) const = 0;
67    virtual String sanitizeValue(const String&) const = 0;
68    virtual void setValueFromRenderer(const String&) = 0;
69
70    virtual void cacheSelection(int start, int end) = 0;
71    virtual void select() = 0;
72
73#if ENABLE(WCSS)
74    virtual InputElementData data() const = 0;
75#endif
76
77    static const int s_maximumLength;
78    static const int s_defaultSize;
79
80    // Replaces CRs and LFs, shrinks the value for s_maximumLength.
81    // This should be applied to values from the HTML value attribute and the DOM value property.
82    // This function should be called only by sanitizeValue() implementations.
83    // Public so it can be called by InputType.
84    static String sanitizeValueForTextField(const InputElement*, const String&);
85
86protected:
87    static void dispatchFocusEvent(InputElement*, Element*);
88    static void dispatchBlurEvent(InputElement*, Element*);
89    static void updateFocusAppearance(InputElementData&, InputElement*, Element*, bool restorePreviousSelection);
90    static void updateSelectionRange(InputElement*, Element*, int start, int end);
91    static void aboutToUnload(InputElement*, Element*);
92    static void setValueFromRenderer(InputElementData&, InputElement*, Element*, const String&);
93    // Replaces CRs and LFs, shrinks the value for the specified maximum length.
94    // This should be applied to values specified by users.
95    // The input string may be a fragment of the whole value.
96    static String sanitizeUserInputValue(const InputElement*, const String&, int);
97    static void handleBeforeTextInsertedEvent(InputElementData&, InputElement*, Element*, Event*);
98    static void parseSizeAttribute(InputElementData&, Element*, Attribute*);
99    static void parseMaxLengthAttribute(InputElementData&, InputElement*, Element*, Attribute*);
100    static void updateValueIfNeeded(InputElementData&, InputElement*);
101    static void notifyFormStateChanged(Element*);
102#if ENABLE(WCSS)
103    static bool isConformToInputMask(const InputElementData&, const String&);
104    static bool isConformToInputMask(const InputElementData&, UChar, unsigned);
105    static String validateInputMask(InputElementData&, String&);
106#endif
107};
108
109// HTML/WMLInputElement hold this struct as member variable
110// and pass it to the static helper functions in InputElement
111class InputElementData {
112public:
113    InputElementData();
114    ~InputElementData();
115
116    const AtomicString& name() const;
117    void setName(const AtomicString& value) { m_name = value; }
118
119    String value() const { return m_value; }
120    void setValue(const String& value) { m_value = value; }
121
122    const String& suggestedValue() const { return m_suggestedValue; }
123    void setSuggestedValue(const String& value) { m_suggestedValue = value; }
124
125    int size() const { return m_size; }
126    void setSize(int value) { m_size = value; }
127
128    int maxLength() const { return m_maxLength; }
129    void setMaxLength(int value) { m_maxLength = value; }
130
131    int cachedSelectionStart() const { return m_cachedSelectionStart; }
132    void setCachedSelectionStart(int value) { m_cachedSelectionStart = value; }
133
134    int cachedSelectionEnd() const { return m_cachedSelectionEnd; }
135    void setCachedSelectionEnd(int value) { m_cachedSelectionEnd = value; }
136
137#if ENABLE(WCSS)
138    String inputFormatMask() const { return m_inputFormatMask; }
139    void setInputFormatMask(const String& mask) { m_inputFormatMask = mask; }
140
141    unsigned maxInputCharsAllowed() const { return m_maxInputCharsAllowed; }
142    void setMaxInputCharsAllowed(unsigned maxLength) { m_maxInputCharsAllowed = maxLength; }
143
144#endif
145
146private:
147    AtomicString m_name;
148    String m_value;
149    String m_suggestedValue;
150    int m_size;
151    int m_maxLength;
152    int m_cachedSelectionStart;
153    int m_cachedSelectionEnd;
154#if ENABLE(WCSS)
155    String m_inputFormatMask;
156    unsigned m_maxInputCharsAllowed;
157#endif
158};
159
160InputElement* toInputElement(Element*);
161
162}
163
164#endif
165