KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > w3c > dom > html2 > HTMLObjectElement


1 /*
2     GNU LESSER GENERAL PUBLIC LICENSE
3     Copyright (C) 2006 The Lobo Project
4
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Lesser General Public
7     License as published by the Free Software Foundation; either
8     version 2.1 of the License, or (at your option) any later version.
9
10     This library is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13     Lesser General Public License for more details.
14
15     You should have received a copy of the GNU Lesser General Public
16     License along with this library; if not, write to the Free Software
17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19     Contact info: xamjadmin@users.sourceforge.net
20 */

21 /*
22  * Copyright (c) 2003 World Wide Web Consortium,
23  * (Massachusetts Institute of Technology, Institut National de
24  * Recherche en Informatique et en Automatique, Keio University). All
25  * Rights Reserved. This program is distributed under the W3C's Software
26  * Intellectual Property License. This program is distributed in the
27  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
28  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
29  * PURPOSE.
30  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
31  */

32
33 package org.w3c.dom.html2;
34
35 import org.w3c.dom.Document JavaDoc;
36
37 /**
38  * Generic embedded object.In principle, all properties on the object element
39  * are read-write but in some environments some properties may be read-only
40  * once the underlying object is instantiated. See the OBJECT element
41  * definition in [<a HREF='http://www.w3.org/TR/1999/REC-html401-19991224'>HTML 4.01</a>].
42  * <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>.
43  */

44 public interface HTMLObjectElement extends HTMLElement {
45     /**
46      * Returns the <code>FORM</code> element containing this control. Returns
47      * <code>null</code> if this control is not within the context of a
48      * form.
49      */

50     public HTMLFormElement getForm();
51
52     /**
53      * Applet class file. See the <code>code</code> attribute for
54      * HTMLAppletElement.
55      */

56     public String JavaDoc getCode();
57     /**
58      * Applet class file. See the <code>code</code> attribute for
59      * HTMLAppletElement.
60      */

61     public void setCode(String JavaDoc code);
62
63     /**
64      * Aligns this object (vertically or horizontally) with respect to its
65      * surrounding text. See the align attribute definition in HTML 4.01.
66      * This attribute is deprecated in HTML 4.01.
67      */

68     public String JavaDoc getAlign();
69     /**
70      * Aligns this object (vertically or horizontally) with respect to its
71      * surrounding text. See the align attribute definition in HTML 4.01.
72      * This attribute is deprecated in HTML 4.01.
73      */

74     public void setAlign(String JavaDoc align);
75
76     /**
77      * Space-separated list of archives. See the archive attribute definition
78      * in HTML 4.01.
79      */

80     public String JavaDoc getArchive();
81     /**
82      * Space-separated list of archives. See the archive attribute definition
83      * in HTML 4.01.
84      */

85     public void setArchive(String JavaDoc archive);
86
87     /**
88      * Width of border around the object. See the border attribute definition
89      * in HTML 4.01. This attribute is deprecated in HTML 4.01.
90      */

91     public String JavaDoc getBorder();
92     /**
93      * Width of border around the object. See the border attribute definition
94      * in HTML 4.01. This attribute is deprecated in HTML 4.01.
95      */

96     public void setBorder(String JavaDoc border);
97
98     /**
99      * Base URI [<a HREF='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] for <code>classid</code>, <code>data</code>, and
100      * <code>archive</code> attributes. See the codebase attribute definition
101      * in HTML 4.01.
102      */

103     public String JavaDoc getCodeBase();
104     /**
105      * Base URI [<a HREF='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>] for <code>classid</code>, <code>data</code>, and
106      * <code>archive</code> attributes. See the codebase attribute definition
107      * in HTML 4.01.
108      */

109     public void setCodeBase(String JavaDoc codeBase);
110
111     /**
112      * Content type for data downloaded via <code>classid</code> attribute.
113      * See the codetype attribute definition in HTML 4.01.
114      */

115     public String JavaDoc getCodeType();
116     /**
117      * Content type for data downloaded via <code>classid</code> attribute.
118      * See the codetype attribute definition in HTML 4.01.
119      */

120     public void setCodeType(String JavaDoc codeType);
121
122     /**
123      * 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
124      * attribute definition in HTML 4.01.
125      */

126     public String JavaDoc getData();
127     /**
128      * 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
129      * attribute definition in HTML 4.01.
130      */

131     public void setData(String JavaDoc data);
132
133     /**
134      * Declare (for future reference), but do not instantiate, this object.
135      * See the declare attribute definition in HTML 4.01.
136      */

137     public boolean getDeclare();
138     /**
139      * Declare (for future reference), but do not instantiate, this object.
140      * See the declare attribute definition in HTML 4.01.
141      */

142     public void setDeclare(boolean declare);
143
144     /**
145      * Override height. See the height attribute definition in HTML 4.01.
146      */

147     public String JavaDoc getHeight();
148     /**
149      * Override height. See the height attribute definition in HTML 4.01.
150      */

151     public void setHeight(String JavaDoc height);
152
153     /**
154      * Horizontal space, in pixels, to the left and right of this image,
155      * applet, or object. See the hspace attribute definition in HTML 4.01.
156      * This attribute is deprecated in HTML 4.01.
157      */

158     public int getHspace();
159     /**
160      * Horizontal space, in pixels, to the left and right of this image,
161      * applet, or object. See the hspace attribute definition in HTML 4.01.
162      * This attribute is deprecated in HTML 4.01.
163      */

164     public void setHspace(int hspace);
165
166     /**
167      * Form control or object name when submitted with a form. See the name
168      * attribute definition in HTML 4.01.
169      */

170     public String JavaDoc getName();
171     /**
172      * Form control or object name when submitted with a form. See the name
173      * attribute definition in HTML 4.01.
174      */

175     public void setName(String JavaDoc name);
176
177     /**
178      * Message to render while loading the object. See the standby attribute
179      * definition in HTML 4.01.
180      */

181     public String JavaDoc getStandby();
182     /**
183      * Message to render while loading the object. See the standby attribute
184      * definition in HTML 4.01.
185      */

186     public void setStandby(String JavaDoc standby);
187
188     /**
189      * Index that represents the element's position in the tabbing order. See
190      * the tabindex attribute definition in HTML 4.01.
191      */

192     public int getTabIndex();
193     /**
194      * Index that represents the element's position in the tabbing order. See
195      * the tabindex attribute definition in HTML 4.01.
196      */

197     public void setTabIndex(int tabIndex);
198
199     /**
200      * Content type for data downloaded via <code>data</code> attribute. See
201      * the type attribute definition in HTML 4.01.
202      */

203     public String JavaDoc getType();
204     /**
205      * Content type for data downloaded via <code>data</code> attribute. See
206      * the type attribute definition in HTML 4.01.
207      */

208     public void setType(String JavaDoc type);
209
210     /**
211      * Use client-side image map. See the usemap attribute definition in HTML
212      * 4.01.
213      */

214     public String JavaDoc getUseMap();
215     /**
216      * Use client-side image map. See the usemap attribute definition in HTML
217      * 4.01.
218      */

219     public void setUseMap(String JavaDoc useMap);
220
221     /**
222      * Vertical space, in pixels, above and below this image, applet, or
223      * object. See the vspace attribute definition in HTML 4.01. This
224      * attribute is deprecated in HTML 4.01.
225      */

226     public int getVspace();
227     /**
228      * Vertical space, in pixels, above and below this image, applet, or
229      * object. See the vspace attribute definition in HTML 4.01. This
230      * attribute is deprecated in HTML 4.01.
231      */

232     public void setVspace(int vspace);
233
234     /**
235      * Override width. See the width attribute definition in HTML 4.01.
236      */

237     public String JavaDoc getWidth();
238     /**
239      * Override width. See the width attribute definition in HTML 4.01.
240      */

241     public void setWidth(String JavaDoc width);
242
243     /**
244      * The document this object contains, if there is any and it is available,
245      * or <code>null</code> otherwise.
246      * @since DOM Level 2
247      */

248     public Document JavaDoc getContentDocument();
249
250 }
251
Popular Tags