2 * Copyright (c) 2003 World Wide Web Consortium,
3 * (Massachusetts Institute of Technology, Institut National de
4 * Recherche en Informatique et en Automatique, Keio University). All
5 * Rights Reserved. This program is distributed under the W3C's Software
6 * Intellectual Property License. This program is distributed in the
7 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
8 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
10 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
13 package org
.w3c
.dom
.html2
;
15 import org
.w3c
.dom
.Document
;
18 * Generic embedded object.In principle, all properties on the object element
19 * are read-write but in some environments some properties may be read-only
20 * once the underlying object is instantiated. See the OBJECT element
21 * definition in [<a href='http://www.w3.org/TR/1999/REC-html401-19991224'>HTML 4.01</a>].
22 * <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>.
24 public interface HTMLObjectElement
extends HTMLElement
{
26 * Returns the <code>FORM</code> element containing this control. Returns
27 * <code>null</code> if this control is not within the context of a
30 public HTMLFormElement
getForm();
33 * Applet class file. See the <code>code</code> attribute for
36 public String
getCode();
38 * Applet class file. See the <code>code</code> attribute for
41 public void setCode(String code
);
44 * Aligns this object (vertically or horizontally) with respect to its
45 * surrounding text. See the align attribute definition in HTML 4.01.
46 * This attribute is deprecated in HTML 4.01.
48 public String
getAlign();
50 * Aligns this object (vertically or horizontally) with respect to its
51 * surrounding text. See the align attribute definition in HTML 4.01.
52 * This attribute is deprecated in HTML 4.01.
54 public void setAlign(String align
);
57 * Space-separated list of archives. See the archive attribute definition
60 public String
getArchive();
62 * Space-separated list of archives. See the archive attribute definition
65 public void setArchive(String archive
);
68 * Width of border around the object. See the border attribute definition
69 * in HTML 4.01. This attribute is deprecated in HTML 4.01.
71 public String
getBorder();
73 * Width of border around the object. See the border attribute definition
74 * in HTML 4.01. This attribute is deprecated in HTML 4.01.
76 public void setBorder(String border
);
79 * Base URI [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] for <code>classid</code>, <code>data</code>, and
80 * <code>archive</code> attributes. See the codebase attribute definition
83 public String
getCodeBase();
85 * Base URI [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] for <code>classid</code>, <code>data</code>, and
86 * <code>archive</code> attributes. See the codebase attribute definition
89 public void setCodeBase(String codeBase
);
92 * Content type for data downloaded via <code>classid</code> attribute.
93 * See the codetype attribute definition in HTML 4.01.
95 public String
getCodeType();
97 * Content type for data downloaded via <code>classid</code> attribute.
98 * See the codetype attribute definition in HTML 4.01.
100 public void setCodeType(String codeType
);
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.
106 public String
getData();
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.
111 public void setData(String data
);
114 * Declare (for future reference), but do not instantiate, this object.
115 * See the declare attribute definition in HTML 4.01.
117 public boolean getDeclare();
119 * Declare (for future reference), but do not instantiate, this object.
120 * See the declare attribute definition in HTML 4.01.
122 public void setDeclare(boolean declare
);
125 * Override height. See the height attribute definition in HTML 4.01.
127 public String
getHeight();
129 * Override height. See the height attribute definition in HTML 4.01.
131 public void setHeight(String height
);
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.
138 public int getHspace();
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.
144 public void setHspace(int hspace
);
147 * Form control or object name when submitted with a form. See the name
148 * attribute definition in HTML 4.01.
150 public String
getName();
152 * Form control or object name when submitted with a form. See the name
153 * attribute definition in HTML 4.01.
155 public void setName(String name
);
158 * Message to render while loading the object. See the standby attribute
159 * definition in HTML 4.01.
161 public String
getStandby();
163 * Message to render while loading the object. See the standby attribute
164 * definition in HTML 4.01.
166 public void setStandby(String standby
);
169 * Index that represents the element's position in the tabbing order. See
170 * the tabindex attribute definition in HTML 4.01.
172 public int getTabIndex();
174 * Index that represents the element's position in the tabbing order. See
175 * the tabindex attribute definition in HTML 4.01.
177 public void setTabIndex(int tabIndex
);
180 * Content type for data downloaded via <code>data</code> attribute. See
181 * the type attribute definition in HTML 4.01.
183 public String
getType();
185 * Content type for data downloaded via <code>data</code> attribute. See
186 * the type attribute definition in HTML 4.01.
188 public void setType(String type
);
191 * Use client-side image map. See the usemap attribute definition in HTML
194 public String
getUseMap();
196 * Use client-side image map. See the usemap attribute definition in HTML
199 public void setUseMap(String useMap
);
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.
206 public int getVspace();
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.
212 public void setVspace(int vspace
);
215 * Override width. See the width attribute definition in HTML 4.01.
217 public String
getWidth();
219 * Override width. See the width attribute definition in HTML 4.01.
221 public void setWidth(String width
);
224 * The document this object contains, if there is any and it is available,
225 * or <code>null</code> otherwise.
228 public Document
getContentDocument();