dom/html/HTMLObjectElement.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 // vim:set et sw=2 sts=2 cin:
   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_HTMLObjectElement_h
   8 #define mozilla_dom_HTMLObjectElement_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "nsGenericHTMLElement.h"
  12 #include "nsObjectLoadingContent.h"
  13 #include "nsIDOMHTMLObjectElement.h"
  14 #include "nsIConstraintValidation.h"
  15
  16 namespace mozilla {
  17 namespace dom {
  18
  19 class HTMLObjectElement MOZ_FINAL : public nsGenericHTMLFormElement
  20                                   , public nsObjectLoadingContent
  21                                   , public nsIDOMHTMLObjectElement
  22                                   , public nsIConstraintValidation
  23 {
  24 public:
  25   explicit HTMLObjectElement(already_AddRefed<mozilla::dom::NodeInfo>& aNodeInfo,
  26                              FromParser aFromParser = NOT_FROM_PARSER);
  27
  28   // nsISupports
  29   NS_DECL_ISUPPORTS_INHERITED
  30
  31   virtual int32_t TabIndexDefault() MOZ_OVERRIDE;
  32
  33 #ifdef XP_MACOSX
  34   // nsIDOMEventTarget
  35   NS_IMETHOD PostHandleEvent(EventChainPostVisitor& aVisitor) MOZ_OVERRIDE;
  36   // Helper methods
  37   static void OnFocusBlurPlugin(Element* aElement, bool aFocus);
  38   static void HandleFocusBlurPlugin(Element* aElement, WidgetEvent* aEvent);
  39   // Weak pointer. Null if last action was blur.
  40   static Element* sLastFocused;
  41 #endif
  42
  43   // nsIDOMHTMLObjectElement
  44   NS_DECL_NSIDOMHTMLOBJECTELEMENT
  45
  46   virtual nsresult BindToTree(nsIDocument *aDocument, nsIContent *aParent,
  47                               nsIContent *aBindingParent,
  48                               bool aCompileEventHandlers) MOZ_OVERRIDE;
  49   virtual void UnbindFromTree(bool aDeep = true,
  50                               bool aNullParent = true) MOZ_OVERRIDE;
  51   virtual nsresult SetAttr(int32_t aNameSpaceID, nsIAtom *aName,
  52                            nsIAtom *aPrefix, const nsAString &aValue,
  53                            bool aNotify) MOZ_OVERRIDE;
  54   virtual nsresult UnsetAttr(int32_t aNameSpaceID, nsIAtom* aAttribute,
  55                              bool aNotify) MOZ_OVERRIDE;
  56
  57   virtual bool IsHTMLFocusable(bool aWithMouse, bool *aIsFocusable, int32_t *aTabIndex) MOZ_OVERRIDE;
  58   virtual IMEState GetDesiredIMEState() MOZ_OVERRIDE;
  59
  60   // Overriden nsIFormControl methods
  61   NS_IMETHOD_(uint32_t) GetType() const MOZ_OVERRIDE
  62   {
  63     return NS_FORM_OBJECT;
  64   }
  65
  66   NS_IMETHOD Reset() MOZ_OVERRIDE;
  67   NS_IMETHOD SubmitNamesValues(nsFormSubmission *aFormSubmission) MOZ_OVERRIDE;
  68
  69   virtual bool IsDisabled() const MOZ_OVERRIDE { return false; }
  70
  71   virtual void DoneAddingChildren(bool aHaveNotified) MOZ_OVERRIDE;
  72   virtual bool IsDoneAddingChildren() MOZ_OVERRIDE;
  73
  74   virtual bool ParseAttribute(int32_t aNamespaceID,
  75                                 nsIAtom *aAttribute,
  76                                 const nsAString &aValue,
  77                                 nsAttrValue &aResult) MOZ_OVERRIDE;
  78   virtual nsMapRuleToAttributesFunc GetAttributeMappingFunction() const MOZ_OVERRIDE;
  79   NS_IMETHOD_(bool) IsAttributeMapped(const nsIAtom *aAttribute) const MOZ_OVERRIDE;
  80   virtual EventStates IntrinsicState() const MOZ_OVERRIDE;
  81   virtual void DestroyContent() MOZ_OVERRIDE;
  82
  83   // nsObjectLoadingContent
  84   virtual uint32_t GetCapabilities() const MOZ_OVERRIDE;
  85
  86   virtual nsresult Clone(mozilla::dom::NodeInfo *aNodeInfo, nsINode **aResult) const MOZ_OVERRIDE;
  87
  88   nsresult CopyInnerTo(Element* aDest);
  89
  90   void StartObjectLoad() { StartObjectLoad(true); }
  91
  92   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(HTMLObjectElement,
  93                                            nsGenericHTMLFormElement)
  94
  95   // Web IDL binding methods
  96   // XPCOM GetData is ok; note that it's a URI attribute with a weird base URI
  97   void SetData(const nsAString& aValue, ErrorResult& aRv)
  98   {
  99     SetHTMLAttr(nsGkAtoms::data, aValue, aRv);
 100   }
 101   void GetType(DOMString& aValue)
 102   {
 103     GetHTMLAttr(nsGkAtoms::type, aValue);
 104   }
 105   void SetType(const nsAString& aValue, ErrorResult& aRv)
 106   {
 107     SetHTMLAttr(nsGkAtoms::type, aValue, aRv);
 108   }
 109   bool TypeMustMatch()
 110   {
 111     return GetBoolAttr(nsGkAtoms::typemustmatch);
 112   }
 113   void SetTypeMustMatch(bool aValue, ErrorResult& aRv)
 114   {
 115     SetHTMLBoolAttr(nsGkAtoms::typemustmatch, aValue, aRv);
 116   }
 117   void GetName(DOMString& aValue)
 118   {
 119     GetHTMLAttr(nsGkAtoms::name, aValue);
 120   }
 121   void SetName(const nsAString& aValue, ErrorResult& aRv)
 122   {
 123     SetHTMLAttr(nsGkAtoms::name, aValue, aRv);
 124   }
 125   void GetUseMap(DOMString& aValue)
 126   {
 127     GetHTMLAttr(nsGkAtoms::usemap, aValue);
 128   }
 129   void SetUseMap(const nsAString& aValue, ErrorResult& aRv)
 130   {
 131     SetHTMLAttr(nsGkAtoms::usemap, aValue, aRv);
 132   }
 133   using nsGenericHTMLFormElement::GetForm;
 134   void GetWidth(DOMString& aValue)
 135   {
 136     GetHTMLAttr(nsGkAtoms::width, aValue);
 137   }
 138   void SetWidth(const nsAString& aValue, ErrorResult& aRv)
 139   {
 140     SetHTMLAttr(nsGkAtoms::width, aValue, aRv);
 141   }
 142   void GetHeight(DOMString& aValue)
 143   {
 144     GetHTMLAttr(nsGkAtoms::height, aValue);
 145   }
 146   void SetHeight(const nsAString& aValue, ErrorResult& aRv)
 147   {
 148     SetHTMLAttr(nsGkAtoms::height, aValue, aRv);
 149   }
 150   using nsObjectLoadingContent::GetContentDocument;
 151   nsIDOMWindow* GetContentWindow();
 152   using nsIConstraintValidation::CheckValidity;
 153   using nsIConstraintValidation::GetValidationMessage;
 154   void GetAlign(DOMString& aValue)
 155   {
 156     GetHTMLAttr(nsGkAtoms::align, aValue);
 157   }
 158   void SetAlign(const nsAString& aValue, ErrorResult& aRv)
 159   {
 160     SetHTMLAttr(nsGkAtoms::align, aValue, aRv);
 161   }
 162   void GetArchive(DOMString& aValue)
 163   {
 164     GetHTMLAttr(nsGkAtoms::archive, aValue);
 165   }
 166   void SetArchive(const nsAString& aValue, ErrorResult& aRv)
 167   {
 168     SetHTMLAttr(nsGkAtoms::archive, aValue, aRv);
 169   }
 170   // XPCOM GetCode is ok; note that it's a URI attribute with a weird base URI
 171   void SetCode(const nsAString& aValue, ErrorResult& aRv)
 172   {
 173     SetHTMLAttr(nsGkAtoms::code, aValue, aRv);
 174   }
 175   bool Declare()
 176   {
 177     return GetBoolAttr(nsGkAtoms::declare);
 178   }
 179   void SetDeclare(bool aValue, ErrorResult& aRv)
 180   {
 181     SetHTMLBoolAttr(nsGkAtoms::declare, aValue, aRv);
 182   }
 183   uint32_t Hspace()
 184   {
 185     return GetUnsignedIntAttr(nsGkAtoms::hspace, 0);
 186   }
 187   void SetHspace(uint32_t aValue, ErrorResult& aRv)
 188   {
 189     SetUnsignedIntAttr(nsGkAtoms::hspace, aValue, aRv);
 190   }
 191   void GetStandby(DOMString& aValue)
 192   {
 193     GetHTMLAttr(nsGkAtoms::standby, aValue);
 194   }
 195   void SetStandby(const nsAString& aValue, ErrorResult& aRv)
 196   {
 197     SetHTMLAttr(nsGkAtoms::standby, aValue, aRv);
 198   }
 199   uint32_t Vspace()
 200   {
 201     return GetUnsignedIntAttr(nsGkAtoms::vspace, 0);
 202   }
 203   void SetVspace(uint32_t aValue, ErrorResult& aRv)
 204   {
 205     SetUnsignedIntAttr(nsGkAtoms::vspace, aValue, aRv);
 206   }
 207   // XPCOM GetCodebase is ok; note that it's a URI attribute
 208   void SetCodeBase(const nsAString& aValue, ErrorResult& aRv)
 209   {
 210     SetHTMLAttr(nsGkAtoms::codebase, aValue, aRv);
 211   }
 212   void GetCodeType(DOMString& aValue)
 213   {
 214     GetHTMLAttr(nsGkAtoms::codetype, aValue);
 215   }
 216   void SetCodeType(const nsAString& aValue, ErrorResult& aRv)
 217   {
 218     SetHTMLAttr(nsGkAtoms::codetype, aValue, aRv);
 219   }
 220   void GetBorder(DOMString& aValue)
 221   {
 222     GetHTMLAttr(nsGkAtoms::border, aValue);
 223   }
 224   void SetBorder(const nsAString& aValue, ErrorResult& aRv)
 225   {
 226     SetHTMLAttr(nsGkAtoms::border, aValue, aRv);
 227   }
 228   nsIDocument* GetSVGDocument()
 229   {
 230     return GetContentDocument();
 231   }
 232
 233 private:
 234   /**
 235    * Calls LoadObject with the correct arguments to start the plugin load.
 236    */
 237   void StartObjectLoad(bool aNotify);
 238
 239   /**
 240    * Returns if the element is currently focusable regardless of it's tabindex
 241    * value. This is used to know the default tabindex value.
 242    */
 243   bool IsFocusableForTabIndex();
 244
 245   virtual void GetItemValueText(nsAString& text) MOZ_OVERRIDE;
 246   virtual void SetItemValueText(const nsAString& text) MOZ_OVERRIDE;
 247
 248   virtual ~HTMLObjectElement();
 249
 250   virtual JSObject* WrapNode(JSContext *aCx) MOZ_OVERRIDE;
 251
 252   static void MapAttributesIntoRule(const nsMappedAttributes* aAttributes,
 253                                     nsRuleData* aData);
 254
 255   bool mIsDoneAddingChildren;
 256 };
 257
 258 } // namespace dom
 259 } // namespace mozilla
 260
 261 #endif // mozilla_dom_HTMLObjectElement_h