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
42package org.w3c.dom.html;
43
44import 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 * @since 1.4, DOM Level 2
54 */
55public interface HTMLObjectElement extends HTMLElement {
56    /**
57     *  Returns the <code>FORM</code> element containing this control. Returns
58     * <code>null</code> if this control is not within the context of a form.
59     */
60    public HTMLFormElement getForm();
61
62    /**
63     *  Applet class file. See the <code>code</code> attribute for
64     * HTMLAppletElement.
65     */
66    public String getCode();
67    public void setCode(String code);
68
69    /**
70     *  Aligns this object (vertically or horizontally)  with respect to its
71     * surrounding text. See the  align attribute definition in HTML 4.0.
72     * This attribute is deprecated in HTML 4.0.
73     */
74    public String getAlign();
75    public void setAlign(String align);
76
77    /**
78     *  Space-separated list of archives. See the  archive attribute definition
79     *  in HTML 4.0.
80     */
81    public String getArchive();
82    public void setArchive(String archive);
83
84    /**
85     *  Width of border around the object. See the  border attribute definition
86     *  in HTML 4.0. This attribute is deprecated in HTML 4.0.
87     */
88    public String getBorder();
89    public void setBorder(String border);
90
91    /**
92     *  Base URI for <code>classid</code> , <code>data</code> , and
93     * <code>archive</code> attributes. See the  codebase attribute definition
94     *  in HTML 4.0.
95     */
96    public String getCodeBase();
97    public void setCodeBase(String codeBase);
98
99    /**
100     *  Content type for data downloaded via <code>classid</code> attribute.
101     * See the  codetype attribute definition in HTML 4.0.
102     */
103    public String getCodeType();
104    public void setCodeType(String codeType);
105
106    /**
107     *  A URI specifying the location of the object's data.  See the  data
108     * attribute definition in HTML 4.0.
109     */
110    public String getData();
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.0.
116     */
117    public boolean getDeclare();
118    public void setDeclare(boolean declare);
119
120    /**
121     *  Override height. See the  height attribute definition in HTML 4.0.
122     */
123    public String getHeight();
124    public void setHeight(String height);
125
126    /**
127     *  Horizontal space to the left and right of this image, applet, or
128     * object. See the  hspace attribute definition in HTML 4.0. This
129     * attribute is deprecated in HTML 4.0.
130     */
131    public String getHspace();
132    public void setHspace(String hspace);
133
134    /**
135     *  Form control or object name when submitted with a form. See the  name
136     * attribute definition in HTML 4.0.
137     */
138    public String getName();
139    public void setName(String name);
140
141    /**
142     *  Message to render while loading the object. See the  standby attribute
143     * definition in HTML 4.0.
144     */
145    public String getStandby();
146    public void setStandby(String standby);
147
148    /**
149     *  Index that represents the element's position in the tabbing order. See
150     * the  tabindex attribute definition in HTML 4.0.
151     */
152    public int getTabIndex();
153    public void setTabIndex(int tabIndex);
154
155    /**
156     *  Content type for data downloaded via <code>data</code> attribute. See
157     * the  type attribute definition in HTML 4.0.
158     */
159    public String getType();
160    public void setType(String type);
161
162    /**
163     *  Use client-side image map. See the  usemap attribute definition in
164     * HTML 4.0.
165     */
166    public String getUseMap();
167    public void setUseMap(String useMap);
168
169    /**
170     *  Vertical space above and below this image, applet, or object. See the
171     * vspace attribute definition in HTML 4.0. This attribute is deprecated
172     * in HTML 4.0.
173     */
174    public String getVspace();
175    public void setVspace(String vspace);
176
177    /**
178     *  Override width. See the  width attribute definition in HTML 4.0.
179     */
180    public String getWidth();
181    public void setWidth(String width);
182
183    /**
184     *  The document this object contains, if there is any and it is
185     * available, or <code>null</code> otherwise.
186     * @since 1.4, DOM Level 2
187     */
188    public Document getContentDocument();
189
190}
191