dom/html/HTMLTableElement.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 #ifndef mozilla_dom_HTMLTableElement_h
   7 #define mozilla_dom_HTMLTableElement_h
   8
   9 #include "mozilla/Attributes.h"
  10 #include "nsGenericHTMLElement.h"
  11 #include "mozilla/dom/HTMLTableCaptionElement.h"
  12 #include "mozilla/dom/HTMLTableSectionElement.h"
  13
  14 namespace mozilla::dom {
  15
  16 class TableRowsCollection;
  17
  18 class HTMLTableElement final : public nsGenericHTMLElement {
  19  public:
  20   explicit HTMLTableElement(
  21       already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo);
  22
  23   NS_IMPL_FROMNODE_HTML_WITH_TAG(HTMLTableElement, table)
  24
  25   // nsISupports
  26   NS_DECL_ISUPPORTS_INHERITED
  27
  28   HTMLTableCaptionElement* GetCaption() const {
  29     return static_cast<HTMLTableCaptionElement*>(GetChild(nsGkAtoms::caption));
  30   }
  31   void SetCaption(HTMLTableCaptionElement* aCaption, ErrorResult& aError) {
  32     DeleteCaption();
  33     if (aCaption) {
  34       nsCOMPtr<nsINode> firstChild = nsINode::GetFirstChild();
  35       nsINode::InsertBefore(*aCaption, firstChild, aError);
  36     }
  37   }
  38
  39   void DeleteTFoot();
  40
  41   already_AddRefed<nsGenericHTMLElement> CreateCaption();
  42
  43   void DeleteCaption();
  44
  45   HTMLTableSectionElement* GetTHead() const {
  46     return static_cast<HTMLTableSectionElement*>(GetChild(nsGkAtoms::thead));
  47   }
  48   void SetTHead(HTMLTableSectionElement* aTHead, ErrorResult& aError) {
  49     if (aTHead && !aTHead->IsHTMLElement(nsGkAtoms::thead)) {
  50       aError.ThrowHierarchyRequestError("New value must be a thead element.");
  51       return;
  52     }
  53
  54     DeleteTHead();
  55     if (aTHead) {
  56       nsCOMPtr<nsIContent> refNode = nullptr;
  57       for (refNode = nsINode::GetFirstChild(); refNode;
  58            refNode = refNode->GetNextSibling()) {
  59         if (refNode->IsHTMLElement() &&
  60             !refNode->IsHTMLElement(nsGkAtoms::caption) &&
  61             !refNode->IsHTMLElement(nsGkAtoms::colgroup)) {
  62           break;
  63         }
  64       }
  65
  66       nsINode::InsertBefore(*aTHead, refNode, aError);
  67     }
  68   }
  69   already_AddRefed<nsGenericHTMLElement> CreateTHead();
  70
  71   void DeleteTHead();
  72
  73   HTMLTableSectionElement* GetTFoot() const {
  74     return static_cast<HTMLTableSectionElement*>(GetChild(nsGkAtoms::tfoot));
  75   }
  76   void SetTFoot(HTMLTableSectionElement* aTFoot, ErrorResult& aError) {
  77     if (aTFoot && !aTFoot->IsHTMLElement(nsGkAtoms::tfoot)) {
  78       aError.ThrowHierarchyRequestError("New value must be a tfoot element.");
  79       return;
  80     }
  81
  82     DeleteTFoot();
  83     if (aTFoot) {
  84       nsINode::AppendChild(*aTFoot, aError);
  85     }
  86   }
  87   already_AddRefed<nsGenericHTMLElement> CreateTFoot();
  88
  89   nsIHTMLCollection* TBodies();
  90
  91   already_AddRefed<nsGenericHTMLElement> CreateTBody();
  92
  93   nsIHTMLCollection* Rows();
  94
  95   already_AddRefed<nsGenericHTMLElement> InsertRow(int32_t aIndex,
  96                                                    ErrorResult& aError);
  97   void DeleteRow(int32_t aIndex, ErrorResult& aError);
  98
  99   void GetAlign(DOMString& aAlign) { GetHTMLAttr(nsGkAtoms::align, aAlign); }
 100   void SetAlign(const nsAString& aAlign, ErrorResult& aError) {
 101     SetHTMLAttr(nsGkAtoms::align, aAlign, aError);
 102   }
 103   void GetBorder(DOMString& aBorder) {
 104     GetHTMLAttr(nsGkAtoms::border, aBorder);
 105   }
 106   void SetBorder(const nsAString& aBorder, ErrorResult& aError) {
 107     SetHTMLAttr(nsGkAtoms::border, aBorder, aError);
 108   }
 109   void GetFrame(DOMString& aFrame) { GetHTMLAttr(nsGkAtoms::frame, aFrame); }
 110   void SetFrame(const nsAString& aFrame, ErrorResult& aError) {
 111     SetHTMLAttr(nsGkAtoms::frame, aFrame, aError);
 112   }
 113   void GetRules(DOMString& aRules) { GetHTMLAttr(nsGkAtoms::rules, aRules); }
 114   void SetRules(const nsAString& aRules, ErrorResult& aError) {
 115     SetHTMLAttr(nsGkAtoms::rules, aRules, aError);
 116   }
 117   void GetSummary(nsString& aSummary) {
 118     GetHTMLAttr(nsGkAtoms::summary, aSummary);
 119   }
 120   void GetSummary(DOMString& aSummary) {
 121     GetHTMLAttr(nsGkAtoms::summary, aSummary);
 122   }
 123   void SetSummary(const nsAString& aSummary, ErrorResult& aError) {
 124     SetHTMLAttr(nsGkAtoms::summary, aSummary, aError);
 125   }
 126   void GetWidth(DOMString& aWidth) { GetHTMLAttr(nsGkAtoms::width, aWidth); }
 127   void SetWidth(const nsAString& aWidth, ErrorResult& aError) {
 128     SetHTMLAttr(nsGkAtoms::width, aWidth, aError);
 129   }
 130   void GetBgColor(DOMString& aBgColor) {
 131     GetHTMLAttr(nsGkAtoms::bgcolor, aBgColor);
 132   }
 133   void SetBgColor(const nsAString& aBgColor, ErrorResult& aError) {
 134     SetHTMLAttr(nsGkAtoms::bgcolor, aBgColor, aError);
 135   }
 136   void GetCellPadding(DOMString& aCellPadding) {
 137     GetHTMLAttr(nsGkAtoms::cellpadding, aCellPadding);
 138   }
 139   void SetCellPadding(const nsAString& aCellPadding, ErrorResult& aError) {
 140     SetHTMLAttr(nsGkAtoms::cellpadding, aCellPadding, aError);
 141   }
 142   void GetCellSpacing(DOMString& aCellSpacing) {
 143     GetHTMLAttr(nsGkAtoms::cellspacing, aCellSpacing);
 144   }
 145   void SetCellSpacing(const nsAString& aCellSpacing, ErrorResult& aError) {
 146     SetHTMLAttr(nsGkAtoms::cellspacing, aCellSpacing, aError);
 147   }
 148
 149   bool ParseAttribute(int32_t aNamespaceID, nsAtom* aAttribute,
 150                       const nsAString& aValue,
 151                       nsIPrincipal* aMaybeScriptedPrincipal,
 152                       nsAttrValue& aResult) override;
 153   nsMapRuleToAttributesFunc GetAttributeMappingFunction() const override;
 154   NS_IMETHOD_(bool) IsAttributeMapped(const nsAtom* aAttribute) const override;
 155
 156   nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
 157
 158   nsresult BindToTree(BindContext&, nsINode& aParent) override;
 159   void UnbindFromTree(UnbindContext&) override;
 160   /**
 161    * Called when an attribute is about to be changed
 162    */
 163   void BeforeSetAttr(int32_t aNameSpaceID, nsAtom* aName,
 164                      const nsAttrValue* aValue, bool aNotify) override;
 165   /**
 166    * Called when an attribute has just been changed
 167    */
 168   void AfterSetAttr(int32_t aNameSpaceID, nsAtom* aName,
 169                     const nsAttrValue* aValue, const nsAttrValue* aOldValue,
 170                     nsIPrincipal* aSubjectPrincipal, bool aNotify) override;
 171
 172   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(HTMLTableElement,
 173                                            nsGenericHTMLElement)
 174   StyleLockedDeclarationBlock* GetAttributesMappedForCell() const {
 175     return mTableInheritedAttributes;
 176   }
 177
 178  protected:
 179   virtual ~HTMLTableElement();
 180
 181   JSObject* WrapNode(JSContext*, JS::Handle<JSObject*> aGivenProto) override;
 182
 183   nsIContent* GetChild(nsAtom* aTag) const {
 184     for (nsIContent* cur = nsINode::GetFirstChild(); cur;
 185          cur = cur->GetNextSibling()) {
 186       if (cur->IsHTMLElement(aTag)) {
 187         return cur;
 188       }
 189     }
 190     return nullptr;
 191   }
 192
 193   RefPtr<nsContentList> mTBodies;
 194   RefPtr<TableRowsCollection> mRows;
 195   RefPtr<StyleLockedDeclarationBlock> mTableInheritedAttributes;
 196   void BuildInheritedAttributes();
 197   void ReleaseInheritedAttributes();
 198
 199  private:
 200   static void MapAttributesIntoRule(MappedDeclarationsBuilder&);
 201 };
 202
 203 }  // namespace mozilla::dom
 204
 205 #endif /* mozilla_dom_HTMLTableElement_h */