001/* 002 * Copyright (c) 2003 World Wide Web Consortium, 003 * (Massachusetts Institute of Technology, Institut National de 004 * Recherche en Informatique et en Automatique, Keio University). All 005 * Rights Reserved. This program is distributed under the W3C's Software 006 * Intellectual Property License. This program is distributed in the 007 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even 008 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 009 * PURPOSE. 010 * See W3C License http://www.w3.org/Consortium/Legal/ for more details. 011 */ 012 013package org.w3c.dom.html2; 014 015import org.w3c.dom.Document; 016 017/** 018 * Generic embedded object.In principle, all properties on the object element 019 * are read-write but in some environments some properties may be read-only 020 * once the underlying object is instantiated. See the OBJECT element 021 * definition in [<a href='http://www.w3.org/TR/1999/REC-html401-19991224'>HTML 4.01</a>]. 022 * <p>See also the <a href='http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109'>Document Object Model (DOM) Level 2 HTML Specification</a>. 023 */ 024public interface HTMLObjectElement extends HTMLElement { 025 /** 026 * Returns the <code>FORM</code> element containing this control. Returns 027 * <code>null</code> if this control is not within the context of a 028 * form. 029 */ 030 public HTMLFormElement getForm(); 031 032 /** 033 * Applet class file. See the <code>code</code> attribute for 034 * HTMLAppletElement. 035 */ 036 public String getCode(); 037 /** 038 * Applet class file. See the <code>code</code> attribute for 039 * HTMLAppletElement. 040 */ 041 public void setCode(String code); 042 043 /** 044 * Aligns this object (vertically or horizontally) with respect to its 045 * surrounding text. See the align attribute definition in HTML 4.01. 046 * This attribute is deprecated in HTML 4.01. 047 */ 048 public String getAlign(); 049 /** 050 * Aligns this object (vertically or horizontally) with respect to its 051 * surrounding text. See the align attribute definition in HTML 4.01. 052 * This attribute is deprecated in HTML 4.01. 053 */ 054 public void setAlign(String align); 055 056 /** 057 * Space-separated list of archives. See the archive attribute definition 058 * in HTML 4.01. 059 */ 060 public String getArchive(); 061 /** 062 * Space-separated list of archives. See the archive attribute definition 063 * in HTML 4.01. 064 */ 065 public void setArchive(String archive); 066 067 /** 068 * Width of border around the object. See the border attribute definition 069 * in HTML 4.01. This attribute is deprecated in HTML 4.01. 070 */ 071 public String getBorder(); 072 /** 073 * Width of border around the object. See the border attribute definition 074 * in HTML 4.01. This attribute is deprecated in HTML 4.01. 075 */ 076 public void setBorder(String border); 077 078 /** 079 * Base URI [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] for <code>classid</code>, <code>data</code>, and 080 * <code>archive</code> attributes. See the codebase attribute definition 081 * in HTML 4.01. 082 */ 083 public String getCodeBase(); 084 /** 085 * Base URI [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] for <code>classid</code>, <code>data</code>, and 086 * <code>archive</code> attributes. See the codebase attribute definition 087 * in HTML 4.01. 088 */ 089 public void setCodeBase(String codeBase); 090 091 /** 092 * Content type for data downloaded via <code>classid</code> attribute. 093 * See the codetype attribute definition in HTML 4.01. 094 */ 095 public String getCodeType(); 096 /** 097 * Content type for data downloaded via <code>classid</code> attribute. 098 * See the codetype attribute definition in HTML 4.01. 099 */ 100 public void setCodeType(String codeType); 101 102 /** 103 * A URI [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] specifying the location of the object's data. See the data 104 * attribute definition in HTML 4.01. 105 */ 106 public String getData(); 107 /** 108 * A URI [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] specifying the location of the object's data. See the data 109 * attribute definition in HTML 4.01. 110 */ 111 public void setData(String data); 112 113 /** 114 * Declare (for future reference), but do not instantiate, this object. 115 * See the declare attribute definition in HTML 4.01. 116 */ 117 public boolean getDeclare(); 118 /** 119 * Declare (for future reference), but do not instantiate, this object. 120 * See the declare attribute definition in HTML 4.01. 121 */ 122 public void setDeclare(boolean declare); 123 124 /** 125 * Override height. See the height attribute definition in HTML 4.01. 126 */ 127 public String getHeight(); 128 /** 129 * Override height. See the height attribute definition in HTML 4.01. 130 */ 131 public void setHeight(String height); 132 133 /** 134 * Horizontal space, in pixels, to the left and right of this image, 135 * applet, or object. See the hspace attribute definition in HTML 4.01. 136 * This attribute is deprecated in HTML 4.01. 137 */ 138 public int getHspace(); 139 /** 140 * Horizontal space, in pixels, to the left and right of this image, 141 * applet, or object. See the hspace attribute definition in HTML 4.01. 142 * This attribute is deprecated in HTML 4.01. 143 */ 144 public void setHspace(int hspace); 145 146 /** 147 * Form control or object name when submitted with a form. See the name 148 * attribute definition in HTML 4.01. 149 */ 150 public String getName(); 151 /** 152 * Form control or object name when submitted with a form. See the name 153 * attribute definition in HTML 4.01. 154 */ 155 public void setName(String name); 156 157 /** 158 * Message to render while loading the object. See the standby attribute 159 * definition in HTML 4.01. 160 */ 161 public String getStandby(); 162 /** 163 * Message to render while loading the object. See the standby attribute 164 * definition in HTML 4.01. 165 */ 166 public void setStandby(String standby); 167 168 /** 169 * Index that represents the element's position in the tabbing order. See 170 * the tabindex attribute definition in HTML 4.01. 171 */ 172 public int getTabIndex(); 173 /** 174 * Index that represents the element's position in the tabbing order. See 175 * the tabindex attribute definition in HTML 4.01. 176 */ 177 public void setTabIndex(int tabIndex); 178 179 /** 180 * Content type for data downloaded via <code>data</code> attribute. See 181 * the type attribute definition in HTML 4.01. 182 */ 183 public String getType(); 184 /** 185 * Content type for data downloaded via <code>data</code> attribute. See 186 * the type attribute definition in HTML 4.01. 187 */ 188 public void setType(String type); 189 190 /** 191 * Use client-side image map. See the usemap attribute definition in HTML 192 * 4.01. 193 */ 194 public String getUseMap(); 195 /** 196 * Use client-side image map. See the usemap attribute definition in HTML 197 * 4.01. 198 */ 199 public void setUseMap(String useMap); 200 201 /** 202 * Vertical space, in pixels, above and below this image, applet, or 203 * object. See the vspace attribute definition in HTML 4.01. This 204 * attribute is deprecated in HTML 4.01. 205 */ 206 public int getVspace(); 207 /** 208 * Vertical space, in pixels, above and below this image, applet, or 209 * object. See the vspace attribute definition in HTML 4.01. This 210 * attribute is deprecated in HTML 4.01. 211 */ 212 public void setVspace(int vspace); 213 214 /** 215 * Override width. See the width attribute definition in HTML 4.01. 216 */ 217 public String getWidth(); 218 /** 219 * Override width. See the width attribute definition in HTML 4.01. 220 */ 221 public void setWidth(String width); 222 223 /** 224 * The document this object contains, if there is any and it is available, 225 * or <code>null</code> otherwise. 226 * @since DOM Level 2 227 */ 228 public Document getContentDocument(); 229 230}