dom/html/HTMLFieldSetElement.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_HTMLFieldSetElement_h
   8 #define mozilla_dom_HTMLFieldSetElement_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "nsGenericHTMLElement.h"
  12 #include "nsIConstraintValidation.h"
  13 #include "mozilla/dom/HTMLFormElement.h"
  14 #include "mozilla/dom/ValidityState.h"
  15
  16 namespace mozilla {
  17 class EventChainPreVisitor;
  18 namespace dom {
  19
  20 class HTMLFieldSetElement final : public nsGenericHTMLFormElement,
  21                                   public nsIConstraintValidation {
  22  public:
  23   using nsGenericHTMLFormElement::GetForm;
  24   using nsIConstraintValidation::GetValidationMessage;
  25   using nsIConstraintValidation::SetCustomValidity;
  26
  27   explicit HTMLFieldSetElement(
  28       already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo);
  29
  30   NS_IMPL_FROMNODE_HTML_WITH_TAG(HTMLFieldSetElement, fieldset)
  31
  32   // nsISupports
  33   NS_DECL_ISUPPORTS_INHERITED
  34
  35   // nsIContent
  36   void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
  37   virtual nsresult AfterSetAttr(int32_t aNameSpaceID, nsAtom* aName,
  38                                 const nsAttrValue* aValue,
  39                                 const nsAttrValue* aOldValue,
  40                                 nsIPrincipal* aSubjectPrincipal,
  41                                 bool aNotify) override;
  42
  43   virtual nsresult InsertChildBefore(nsIContent* aChild,
  44                                      nsIContent* aBeforeThis,
  45                                      bool aNotify) override;
  46   virtual void RemoveChildNode(nsIContent* aKid, bool aNotify) override;
  47
  48   // nsIFormControl
  49   NS_IMETHOD Reset() override;
  50   NS_IMETHOD SubmitNamesValues(HTMLFormSubmission* aFormSubmission) override;
  51   virtual bool IsDisabledForEvents(WidgetEvent* aEvent) override;
  52   virtual nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
  53
  54   const nsIContent* GetFirstLegend() const { return mFirstLegend; }
  55
  56   void AddElement(nsGenericHTMLFormElement* aElement);
  57
  58   void RemoveElement(nsGenericHTMLFormElement* aElement);
  59
  60   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(HTMLFieldSetElement,
  61                                            nsGenericHTMLFormElement)
  62
  63   // WebIDL
  64   bool Disabled() const { return GetBoolAttr(nsGkAtoms::disabled); }
  65   void SetDisabled(bool aValue, ErrorResult& aRv) {
  66     SetHTMLBoolAttr(nsGkAtoms::disabled, aValue, aRv);
  67   }
  68
  69   void GetName(nsAString& aValue) { GetHTMLAttr(nsGkAtoms::name, aValue); }
  70
  71   void SetName(const nsAString& aValue, ErrorResult& aRv) {
  72     SetHTMLAttr(nsGkAtoms::name, aValue, aRv);
  73   }
  74
  75   void GetType(nsAString& aType) const;
  76
  77   nsIHTMLCollection* Elements();
  78
  79   // XPCOM WillValidate is OK for us
  80
  81   // XPCOM Validity is OK for us
  82
  83   // XPCOM GetValidationMessage is OK for us
  84
  85   // XPCOM CheckValidity is OK for us
  86
  87   // XPCOM SetCustomValidity is OK for us
  88
  89   virtual EventStates IntrinsicState() const override;
  90
  91   /*
  92    * This method will update the fieldset's validity.  This method has to be
  93    * called by fieldset elements whenever their validity state or status
  94    * regarding constraint validation changes.
  95    *
  96    * @note If an element becomes barred from constraint validation, it has to
  97    * be considered as valid.
  98    *
  99    * @param aElementValidityState the new validity state of the element
 100    */
 101   void UpdateValidity(bool aElementValidityState);
 102
 103  protected:
 104   virtual ~HTMLFieldSetElement();
 105
 106   virtual JSObject* WrapNode(JSContext* aCx,
 107                              JS::Handle<JSObject*> aGivenProto) override;
 108
 109  private:
 110   /**
 111    * Notify all elements (in mElements) that the first legend of the fieldset
 112    * has now changed.
 113    */
 114   void NotifyElementsForFirstLegendChange(bool aNotify);
 115
 116   // This function is used to generate the nsContentList (listed form elements).
 117   static bool MatchListedElements(Element* aElement, int32_t aNamespaceID,
 118                                   nsAtom* aAtom, void* aData);
 119
 120   // listed form controls elements.
 121   RefPtr<nsContentList> mElements;
 122
 123   // List of elements which have this fieldset as first fieldset ancestor.
 124   nsTArray<nsGenericHTMLFormElement*> mDependentElements;
 125
 126   nsIContent* mFirstLegend;
 127
 128   /**
 129    * Number of invalid and candidate for constraint validation
 130    * elements in the fieldSet the last time UpdateValidity has been called.
 131    *
 132    * @note Should only be used by UpdateValidity() and IntrinsicState()!
 133    */
 134   int32_t mInvalidElementsCount;
 135 };
 136
 137 }  // namespace dom
 138 }  // namespace mozilla
 139
 140 #endif /* mozilla_dom_HTMLFieldSetElement_h */