1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2000 World Wide Web Consortium,
32 * (Massachusetts Institute of Technology, Institut National de
33 * Recherche en Informatique et en Automatique, Keio University). All
34 * Rights Reserved. This program is distributed under the W3C's Software
35 * Intellectual Property License. This program is distributed in the
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
38 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
39 * details.
40 */
41
42 package org.w3c.dom.html;
43
44 import org.w3c.dom.Document;
45
46 /**
47 * Generic embedded object. Note. In principle, all properties on the object
48 * element are read-write but in some environments some properties may be
49 * read-only once the underlying object is instantiated. See the OBJECT
50 * element definition in HTML 4.0.
51 * <p>See also the <a href='http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510'>Document Object Model (DOM) Level 2 Specification</a>.
52 */
53 public interface HTMLObjectElement extends HTMLElement {
54 /**
55 * Returns the <code>FORM</code> element containing this control. Returns
56 * <code>null</code> if this control is not within the context of a form.
57 */
58 public HTMLFormElement getForm();
59
60 /**
61 * Applet class file. See the <code>code</code> attribute for
62 * HTMLAppletElement.
63 */
64 public String getCode();
65 public void setCode(String code);
66
67 /**
68 * Aligns this object (vertically or horizontally) with respect to its
69 * surrounding text. See the align attribute definition in HTML 4.0.
70 * This attribute is deprecated in HTML 4.0.
71 */
72 public String getAlign();
73 public void setAlign(String align);
74
75 /**
76 * Space-separated list of archives. See the archive attribute definition
77 * in HTML 4.0.
78 */
79 public String getArchive();
80 public void setArchive(String archive);
81
82 /**
83 * Width of border around the object. See the border attribute definition
84 * in HTML 4.0. This attribute is deprecated in HTML 4.0.
85 */
86 public String getBorder();
87 public void setBorder(String border);
88
89 /**
90 * Base URI for <code>classid</code> , <code>data</code> , and
91 * <code>archive</code> attributes. See the codebase attribute definition
92 * in HTML 4.0.
93 */
94 public String getCodeBase();
95 public void setCodeBase(String codeBase);
96
97 /**
98 * Content type for data downloaded via <code>classid</code> attribute.
99 * See the codetype attribute definition in HTML 4.0.
100 */
101 public String getCodeType();
102 public void setCodeType(String codeType);
103
104 /**
105 * A URI specifying the location of the object's data. See the data
106 * attribute definition in HTML 4.0.
107 */
108 public String getData();
109 public void setData(String data);
110
111 /**
112 * Declare (for future reference), but do not instantiate, this object.
113 * See the declare attribute definition in HTML 4.0.
114 */
115 public boolean getDeclare();
116 public void setDeclare(boolean declare);
117
118 /**
119 * Override height. See the height attribute definition in HTML 4.0.
120 */
121 public String getHeight();
122 public void setHeight(String height);
123
124 /**
125 * Horizontal space to the left and right of this image, applet, or
126 * object. See the hspace attribute definition in HTML 4.0. This
127 * attribute is deprecated in HTML 4.0.
128 */
129 public String getHspace();
130 public void setHspace(String hspace);
131
132 /**
133 * Form control or object name when submitted with a form. See the name
134 * attribute definition in HTML 4.0.
135 */
136 public String getName();
137 public void setName(String name);
138
139 /**
140 * Message to render while loading the object. See the standby attribute
141 * definition in HTML 4.0.
142 */
143 public String getStandby();
144 public void setStandby(String standby);
145
146 /**
147 * Index that represents the element's position in the tabbing order. See
148 * the tabindex attribute definition in HTML 4.0.
149 */
150 public int getTabIndex();
151 public void setTabIndex(int tabIndex);
152
153 /**
154 * Content type for data downloaded via <code>data</code> attribute. See
155 * the type attribute definition in HTML 4.0.
156 */
157 public String getType();
158 public void setType(String type);
159
160 /**
161 * Use client-side image map. See the usemap attribute definition in
162 * HTML 4.0.
163 */
164 public String getUseMap();
165 public void setUseMap(String useMap);
166
167 /**
168 * Vertical space above and below this image, applet, or object. See the
169 * vspace attribute definition in HTML 4.0. This attribute is deprecated
170 * in HTML 4.0.
171 */
172 public String getVspace();
173 public void setVspace(String vspace);
174
175 /**
176 * Override width. See the width attribute definition in HTML 4.0.
177 */
178 public String getWidth();
179 public void setWidth(String width);
180
181 /**
182 * The document this object contains, if there is any and it is
183 * available, or <code>null</code> otherwise.
184 * @since DOM Level 2
185 */
186 public Document getContentDocument();
187
188 }