forked from mirrors/gecko-dev
3b42787268
This doesn't change behavior on its own, but it's likely we want to make the tab focusability more complicated in bug 1895184, and this will make changes to this area less painful. Differential Revision: https://phabricator.services.mozilla.com/D209525
382 lines
14 KiB
C++
382 lines
14 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_dom_HTMLTextAreaElement_h
|
|
#define mozilla_dom_HTMLTextAreaElement_h
|
|
|
|
#include "mozilla/Attributes.h"
|
|
#include "mozilla/TextControlElement.h"
|
|
#include "mozilla/TextControlState.h"
|
|
#include "mozilla/TextEditor.h"
|
|
#include "mozilla/dom/ConstraintValidation.h"
|
|
#include "mozilla/dom/HTMLFormElement.h"
|
|
#include "mozilla/dom/HTMLInputElementBinding.h"
|
|
#include "nsIControllers.h"
|
|
#include "nsCOMPtr.h"
|
|
#include "nsGenericHTMLElement.h"
|
|
#include "nsStubMutationObserver.h"
|
|
#include "nsGkAtoms.h"
|
|
|
|
class nsIControllers;
|
|
class nsPresContext;
|
|
|
|
namespace mozilla {
|
|
|
|
class EventChainPostVisitor;
|
|
class EventChainPreVisitor;
|
|
class PresState;
|
|
|
|
namespace dom {
|
|
|
|
class FormData;
|
|
|
|
class HTMLTextAreaElement final : public TextControlElement,
|
|
public nsStubMutationObserver,
|
|
public ConstraintValidation {
|
|
public:
|
|
using ConstraintValidation::GetValidationMessage;
|
|
using ValueSetterOption = TextControlState::ValueSetterOption;
|
|
using ValueSetterOptions = TextControlState::ValueSetterOptions;
|
|
|
|
explicit HTMLTextAreaElement(
|
|
already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo,
|
|
FromParser aFromParser = NOT_FROM_PARSER);
|
|
|
|
// nsISupports
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
|
|
NS_IMPL_FROMNODE_HTML_WITH_TAG(HTMLTextAreaElement, textarea)
|
|
|
|
int32_t TabIndexDefault() override;
|
|
|
|
// Element
|
|
bool IsInteractiveHTMLContent() const override { return true; }
|
|
|
|
// nsGenericHTMLElement
|
|
bool IsDisabledForEvents(WidgetEvent* aEvent) override;
|
|
|
|
// nsGenericHTMLFormElement
|
|
void SaveState() override;
|
|
|
|
// FIXME: Shouldn't be a CAN_RUN_SCRIPT_BOUNDARY probably?
|
|
MOZ_CAN_RUN_SCRIPT_BOUNDARY bool RestoreState(PresState*) override;
|
|
|
|
// nsIFormControl
|
|
MOZ_CAN_RUN_SCRIPT_BOUNDARY
|
|
NS_IMETHOD Reset() override;
|
|
NS_IMETHOD SubmitNamesValues(FormData* aFormData) override;
|
|
|
|
void FieldSetDisabledChanged(bool aNotify) override;
|
|
|
|
void SetLastValueChangeWasInteractive(bool);
|
|
|
|
// TextControlElement
|
|
bool IsSingleLineTextControlOrTextArea() const override { return true; }
|
|
void SetValueChanged(bool aValueChanged) override;
|
|
bool IsSingleLineTextControl() const override;
|
|
bool IsTextArea() const override;
|
|
bool IsPasswordTextControl() const override;
|
|
int32_t GetCols() override;
|
|
int32_t GetWrapCols() override;
|
|
int32_t GetRows() override;
|
|
void GetDefaultValueFromContent(nsAString& aValue, bool aForDisplay) override;
|
|
bool ValueChanged() const override;
|
|
void GetTextEditorValue(nsAString& aValue) const override;
|
|
MOZ_CAN_RUN_SCRIPT TextEditor* GetTextEditor() override;
|
|
TextEditor* GetTextEditorWithoutCreation() const override;
|
|
nsISelectionController* GetSelectionController() override;
|
|
nsFrameSelection* GetConstFrameSelection() override;
|
|
TextControlState* GetTextControlState() const override { return mState; }
|
|
nsresult BindToFrame(nsTextControlFrame* aFrame) override;
|
|
MOZ_CAN_RUN_SCRIPT void UnbindFromFrame(nsTextControlFrame* aFrame) override;
|
|
MOZ_CAN_RUN_SCRIPT nsresult CreateEditor() override;
|
|
void SetPreviewValue(const nsAString& aValue) override;
|
|
void GetPreviewValue(nsAString& aValue) override;
|
|
void EnablePreview() override;
|
|
bool IsPreviewEnabled() override;
|
|
void InitializeKeyboardEventListeners() override;
|
|
void UpdatePlaceholderShownState();
|
|
void OnValueChanged(ValueChangeKind, bool aNewValueEmpty,
|
|
const nsAString* aKnownNewValue) override;
|
|
void GetValueFromSetRangeText(nsAString& aValue) override;
|
|
MOZ_CAN_RUN_SCRIPT nsresult
|
|
SetValueFromSetRangeText(const nsAString& aValue) override;
|
|
bool HasCachedSelection() override;
|
|
|
|
// nsIContent
|
|
nsresult BindToTree(BindContext&, nsINode& aParent) override;
|
|
void UnbindFromTree(UnbindContext&) override;
|
|
bool ParseAttribute(int32_t aNamespaceID, nsAtom* aAttribute,
|
|
const nsAString& aValue,
|
|
nsIPrincipal* aMaybeScriptedPrincipal,
|
|
nsAttrValue& aResult) override;
|
|
nsMapRuleToAttributesFunc GetAttributeMappingFunction() const override;
|
|
nsChangeHint GetAttributeChangeHint(const nsAtom* aAttribute,
|
|
int32_t aModType) const override;
|
|
NS_IMETHOD_(bool) IsAttributeMapped(const nsAtom* aAttribute) const override;
|
|
|
|
void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
|
|
nsresult PreHandleEvent(EventChainVisitor& aVisitor) override;
|
|
nsresult PostHandleEvent(EventChainPostVisitor& aVisitor) override;
|
|
|
|
bool IsHTMLFocusable(IsFocusableFlags, bool* aIsFocusable,
|
|
int32_t* aTabIndex) override;
|
|
|
|
void DoneAddingChildren(bool aHaveNotified) override;
|
|
|
|
nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
|
|
|
|
MOZ_CAN_RUN_SCRIPT_BOUNDARY
|
|
nsresult CopyInnerTo(Element* aDest);
|
|
|
|
/**
|
|
* Called when an attribute is about to be changed
|
|
*/
|
|
void BeforeSetAttr(int32_t aNameSpaceID, nsAtom* aName,
|
|
const nsAttrValue* aValue, bool aNotify) override;
|
|
|
|
// nsIMutationObserver
|
|
NS_DECL_NSIMUTATIONOBSERVER_CHARACTERDATACHANGED
|
|
NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
|
|
NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
|
|
NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED
|
|
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(HTMLTextAreaElement,
|
|
TextControlElement)
|
|
|
|
// nsIConstraintValidation
|
|
bool IsTooLong();
|
|
bool IsTooShort();
|
|
bool IsValueMissing() const;
|
|
void UpdateTooLongValidityState();
|
|
void UpdateTooShortValidityState();
|
|
void UpdateValueMissingValidityState();
|
|
void UpdateBarredFromConstraintValidation();
|
|
|
|
// ConstraintValidation
|
|
nsresult GetValidationMessage(nsAString& aValidationMessage,
|
|
ValidityStateType aType) override;
|
|
|
|
// Web IDL binding methods
|
|
void GetAutocomplete(DOMString& aValue);
|
|
void SetAutocomplete(const nsAString& aValue, ErrorResult& aRv) {
|
|
SetHTMLAttr(nsGkAtoms::autocomplete, aValue, aRv);
|
|
}
|
|
uint32_t Cols() { return GetUnsignedIntAttr(nsGkAtoms::cols, DEFAULT_COLS); }
|
|
void SetCols(uint32_t aCols, ErrorResult& aError) {
|
|
uint32_t cols = aCols ? aCols : DEFAULT_COLS;
|
|
SetUnsignedIntAttr(nsGkAtoms::cols, cols, DEFAULT_COLS, aError);
|
|
}
|
|
void GetDirName(nsAString& aValue) {
|
|
GetHTMLAttr(nsGkAtoms::dirname, aValue);
|
|
}
|
|
void SetDirName(const nsAString& aValue, ErrorResult& aError) {
|
|
SetHTMLAttr(nsGkAtoms::dirname, aValue, aError);
|
|
}
|
|
bool Disabled() { return GetBoolAttr(nsGkAtoms::disabled); }
|
|
void SetDisabled(bool aDisabled, ErrorResult& aError) {
|
|
SetHTMLBoolAttr(nsGkAtoms::disabled, aDisabled, aError);
|
|
}
|
|
// nsGenericHTMLFormControlElementWithState::GetForm is fine
|
|
using nsGenericHTMLFormControlElementWithState::GetForm;
|
|
int32_t MaxLength() const { return GetIntAttr(nsGkAtoms::maxlength, -1); }
|
|
int32_t UsedMaxLength() const final { return MaxLength(); }
|
|
void SetMaxLength(int32_t aMaxLength, ErrorResult& aError) {
|
|
int32_t minLength = MinLength();
|
|
if (aMaxLength < 0 || (minLength >= 0 && aMaxLength < minLength)) {
|
|
aError.Throw(NS_ERROR_DOM_INDEX_SIZE_ERR);
|
|
} else {
|
|
SetHTMLIntAttr(nsGkAtoms::maxlength, aMaxLength, aError);
|
|
}
|
|
}
|
|
int32_t MinLength() const { return GetIntAttr(nsGkAtoms::minlength, -1); }
|
|
void SetMinLength(int32_t aMinLength, ErrorResult& aError) {
|
|
int32_t maxLength = MaxLength();
|
|
if (aMinLength < 0 || (maxLength >= 0 && aMinLength > maxLength)) {
|
|
aError.Throw(NS_ERROR_DOM_INDEX_SIZE_ERR);
|
|
} else {
|
|
SetHTMLIntAttr(nsGkAtoms::minlength, aMinLength, aError);
|
|
}
|
|
}
|
|
void GetName(nsAString& aName) { GetHTMLAttr(nsGkAtoms::name, aName); }
|
|
void SetName(const nsAString& aName, ErrorResult& aError) {
|
|
SetHTMLAttr(nsGkAtoms::name, aName, aError);
|
|
}
|
|
void GetPlaceholder(nsAString& aPlaceholder) {
|
|
GetHTMLAttr(nsGkAtoms::placeholder, aPlaceholder);
|
|
}
|
|
void SetPlaceholder(const nsAString& aPlaceholder, ErrorResult& aError) {
|
|
SetHTMLAttr(nsGkAtoms::placeholder, aPlaceholder, aError);
|
|
}
|
|
bool ReadOnly() { return GetBoolAttr(nsGkAtoms::readonly); }
|
|
void SetReadOnly(bool aReadOnly, ErrorResult& aError) {
|
|
SetHTMLBoolAttr(nsGkAtoms::readonly, aReadOnly, aError);
|
|
}
|
|
bool Required() const { return State().HasState(ElementState::REQUIRED); }
|
|
|
|
MOZ_CAN_RUN_SCRIPT void SetRangeText(const nsAString& aReplacement,
|
|
ErrorResult& aRv);
|
|
|
|
MOZ_CAN_RUN_SCRIPT void SetRangeText(const nsAString& aReplacement,
|
|
uint32_t aStart, uint32_t aEnd,
|
|
SelectionMode aSelectMode,
|
|
ErrorResult& aRv);
|
|
|
|
void SetRequired(bool aRequired, ErrorResult& aError) {
|
|
SetHTMLBoolAttr(nsGkAtoms::required, aRequired, aError);
|
|
}
|
|
uint32_t Rows() {
|
|
return GetUnsignedIntAttr(nsGkAtoms::rows, DEFAULT_ROWS_TEXTAREA);
|
|
}
|
|
void SetRows(uint32_t aRows, ErrorResult& aError) {
|
|
uint32_t rows = aRows ? aRows : DEFAULT_ROWS_TEXTAREA;
|
|
SetUnsignedIntAttr(nsGkAtoms::rows, rows, DEFAULT_ROWS_TEXTAREA, aError);
|
|
}
|
|
void GetWrap(nsAString& aWrap) { GetHTMLAttr(nsGkAtoms::wrap, aWrap); }
|
|
void SetWrap(const nsAString& aWrap, ErrorResult& aError) {
|
|
SetHTMLAttr(nsGkAtoms::wrap, aWrap, aError);
|
|
}
|
|
void GetType(nsAString& aType);
|
|
void GetDefaultValue(nsAString& aDefaultValue, ErrorResult& aError) const;
|
|
void SetDefaultValue(const nsAString& aDefaultValue, ErrorResult& aError);
|
|
void GetValue(nsAString& aValue);
|
|
MOZ_CAN_RUN_SCRIPT void SetValue(const nsAString&, ErrorResult&);
|
|
|
|
uint32_t GetTextLength();
|
|
|
|
// Override SetCustomValidity so we update our state properly when it's called
|
|
// via bindings.
|
|
void SetCustomValidity(const nsAString& aError);
|
|
|
|
MOZ_CAN_RUN_SCRIPT void Select();
|
|
Nullable<uint32_t> GetSelectionStart(ErrorResult& aError);
|
|
MOZ_CAN_RUN_SCRIPT void SetSelectionStart(
|
|
const Nullable<uint32_t>& aSelectionStart, ErrorResult& aError);
|
|
Nullable<uint32_t> GetSelectionEnd(ErrorResult& aError);
|
|
MOZ_CAN_RUN_SCRIPT void SetSelectionEnd(
|
|
const Nullable<uint32_t>& aSelectionEnd, ErrorResult& aError);
|
|
void GetSelectionDirection(nsAString& aDirection, ErrorResult& aError);
|
|
MOZ_CAN_RUN_SCRIPT void SetSelectionDirection(const nsAString& aDirection,
|
|
ErrorResult& aError);
|
|
MOZ_CAN_RUN_SCRIPT void SetSelectionRange(
|
|
uint32_t aSelectionStart, uint32_t aSelectionEnd,
|
|
const Optional<nsAString>& aDirecton, ErrorResult& aError);
|
|
nsIControllers* GetControllers(ErrorResult& aError);
|
|
// XPCOM adapter function widely used throughout code, leaving it as is.
|
|
nsresult GetControllers(nsIControllers** aResult);
|
|
|
|
MOZ_CAN_RUN_SCRIPT nsIEditor* GetEditorForBindings();
|
|
bool HasEditor() const {
|
|
MOZ_ASSERT(mState);
|
|
return !!mState->GetTextEditorWithoutCreation();
|
|
}
|
|
|
|
bool IsInputEventTarget() const { return true; }
|
|
|
|
MOZ_CAN_RUN_SCRIPT_BOUNDARY void SetUserInput(
|
|
const nsAString& aValue, nsIPrincipal& aSubjectPrincipal);
|
|
|
|
protected:
|
|
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual ~HTMLTextAreaElement();
|
|
|
|
// get rid of the compiler warning
|
|
using nsGenericHTMLFormControlElementWithState::IsSingleLineTextControl;
|
|
|
|
JSObject* WrapNode(JSContext*, JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
nsCOMPtr<nsIControllers> mControllers;
|
|
/** https://html.spec.whatwg.org/#user-interacted */
|
|
bool mUserInteracted = false;
|
|
/** Whether or not the value has changed since its default value was given. */
|
|
bool mValueChanged = false;
|
|
/** Whether or not the last change to the value was made interactively by the
|
|
* user. */
|
|
bool mLastValueChangeWasInteractive = false;
|
|
/** Whether or not we are already handling select event. */
|
|
bool mHandlingSelect = false;
|
|
/** Whether or not we are done adding children (always true if not
|
|
created by a parser */
|
|
bool mDoneAddingChildren;
|
|
/** Whether state restoration should be inhibited in DoneAddingChildren. */
|
|
bool mInhibitStateRestoration;
|
|
/** Whether our disabled state has changed from the default **/
|
|
bool mDisabledChanged = false;
|
|
bool mIsPreviewEnabled = false;
|
|
|
|
nsContentUtils::AutocompleteAttrState mAutocompleteAttrState;
|
|
|
|
void FireChangeEventIfNeeded();
|
|
|
|
nsString mFocusedValue;
|
|
|
|
/** The state of the text editor (selection controller and the editor) **/
|
|
TextControlState* mState;
|
|
|
|
NS_IMETHOD SelectAll(nsPresContext* aPresContext);
|
|
/**
|
|
* Get the value, whether it is from the content or the frame.
|
|
* @param aValue the value [out]
|
|
* @param aIgnoreWrap whether to ignore the wrap attribute when getting the
|
|
* value. If this is true, linebreaks will not be inserted even if
|
|
* wrap=hard.
|
|
*/
|
|
void GetValueInternal(nsAString& aValue, bool aIgnoreWrap) const;
|
|
|
|
/**
|
|
* Setting the value.
|
|
*
|
|
* @param aValue String to set.
|
|
* @param aOptions See TextControlState::ValueSetterOption.
|
|
*/
|
|
MOZ_CAN_RUN_SCRIPT nsresult
|
|
SetValueInternal(const nsAString& aValue, const ValueSetterOptions& aOptions);
|
|
|
|
/**
|
|
* Common method to call from the various mutation observer methods.
|
|
* aContent is a content node that's either the one that changed or its
|
|
* parent; we should only respond to the change if aContent is non-anonymous.
|
|
*/
|
|
void ContentChanged(nsIContent* aContent);
|
|
|
|
void AfterSetAttr(int32_t aNamespaceID, nsAtom* aName,
|
|
const nsAttrValue* aValue, const nsAttrValue* aOldValue,
|
|
nsIPrincipal* aSubjectPrincipal, bool aNotify) override;
|
|
|
|
void SetDirectionFromValue(bool aNotify,
|
|
const nsAString* aKnownValue = nullptr);
|
|
|
|
/**
|
|
* Get the mutable state of the element.
|
|
*/
|
|
bool IsMutable() const;
|
|
|
|
/**
|
|
* Returns whether the current value is the empty string.
|
|
*
|
|
* @return whether the current value is the empty string.
|
|
*/
|
|
bool IsValueEmpty() const {
|
|
return State().HasState(ElementState::VALUE_EMPTY);
|
|
}
|
|
|
|
/**
|
|
* A helper to get the current selection range. Will throw on the ErrorResult
|
|
* if we have no editor state.
|
|
*/
|
|
void GetSelectionRange(uint32_t* aSelectionStart, uint32_t* aSelectionEnd,
|
|
ErrorResult& aRv);
|
|
|
|
void SetUserInteracted(bool) final;
|
|
void UpdateValidityElementStates(bool aNotify);
|
|
|
|
private:
|
|
static void MapAttributesIntoRule(MappedDeclarationsBuilder&);
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif
|