/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

/*

 * This file is available under and governed by the GNU General Public

 * License version 2 only, as published by the Free Software Foundation.

 * However, the following notice accompanied the original version of this

 * file and, per its terms, should not be removed:

 *

 * Copyright (c) 2000 World Wide Web Consortium,

 * (Massachusetts Institute of Technology, Institut National de

 * Recherche en Informatique et en Automatique, Keio University). All

 * Rights Reserved. This program is distributed under the W3C's Software

 * Intellectual Property License. This program is distributed in the

 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even

 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more

 * details.

 */

package org.w3c.dom.html;

import org.w3c.dom.Document;

/**

 *  Generic embedded object.  Note. In principle, all properties on the object

 * element are read-write but in some environments some properties may be

 * read-only once the underlying object is instantiated. See the  OBJECT

 * element definition in HTML 4.0.

 * <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>.

 */

public interface HTMLObjectElement extends HTMLElement {

    /**

     *  Returns the <code>FORM</code> element containing this control. Returns

     * <code>null</code> if this control is not within the context of a form.

     */

    public HTMLFormElement getForm();

    /**

     *  Applet class file. See the <code>code</code> attribute for

     * HTMLAppletElement.

     */

    public String getCode();

    public void setCode(String code);

    /**

     *  Aligns this object (vertically or horizontally)  with respect to its

     * surrounding text. See the  align attribute definition in HTML 4.0.

     * This attribute is deprecated in HTML 4.0.

     */

    public String getAlign();

    public void setAlign(String align);

    /**

     *  Space-separated list of archives. See the  archive attribute definition

     *  in HTML 4.0.

     */

    public String getArchive();

    public void setArchive(String archive);

    /**

     *  Width of border around the object. See the  border attribute definition

     *  in HTML 4.0. This attribute is deprecated in HTML 4.0.

     */

    public String getBorder();

    public void setBorder(String border);

    /**

     *  Base URI for <code>classid</code> , <code>data</code> , and

     * <code>archive</code> attributes. See the  codebase attribute definition

     *  in HTML 4.0.

     */

    public String getCodeBase();

    public void setCodeBase(String codeBase);

    /**

     *  Content type for data downloaded via <code>classid</code> attribute.

     * See the  codetype attribute definition in HTML 4.0.

     */

    public String getCodeType();

    public void setCodeType(String codeType);

    /**

     *  A URI specifying the location of the object's data.  See the  data

     * attribute definition in HTML 4.0.

     */

    public String getData();

    public void setData(String data);

    /**

     *  Declare (for future reference), but do not instantiate, this object.

     * See the  declare attribute definition in HTML 4.0.

     */

    public boolean getDeclare();

    public void setDeclare(boolean declare);

    /**

     *  Override height. See the  height attribute definition in HTML 4.0.

     */

    public String getHeight();

    public void setHeight(String height);

    /**

     *  Horizontal space to the left and right of this image, applet, or

     * object. See the  hspace attribute definition in HTML 4.0. This

     * attribute is deprecated in HTML 4.0.

     */

    public String getHspace();

    public void setHspace(String hspace);

    /**

     *  Form control or object name when submitted with a form. See the  name

     * attribute definition in HTML 4.0.

     */

    public String getName();

    public void setName(String name);

    /**

     *  Message to render while loading the object. See the  standby attribute

     * definition in HTML 4.0.

     */

    public String getStandby();

    public void setStandby(String standby);

    /**

     *  Index that represents the element's position in the tabbing order. See

     * the  tabindex attribute definition in HTML 4.0.

     */

    public int getTabIndex();

    public void setTabIndex(int tabIndex);

    /**

     *  Content type for data downloaded via <code>data</code> attribute. See

     * the  type attribute definition in HTML 4.0.

     */

    public String getType();

    public void setType(String type);

    /**

     *  Use client-side image map. See the  usemap attribute definition in

     * HTML 4.0.

     */

    public String getUseMap();

    public void setUseMap(String useMap);

    /**

     *  Vertical space above and below this image, applet, or object. See the

     * vspace attribute definition in HTML 4.0. This attribute is deprecated

     * in HTML 4.0.

     */

    public String getVspace();

    public void setVspace(String vspace);

    /**

     *  Override width. See the  width attribute definition in HTML 4.0.

     */

    public String getWidth();

    public void setWidth(String width);

    /**

     *  The document this object contains, if there is any and it is

     * available, or <code>null</code> otherwise.

     * @since DOM Level 2

     */

    public Document getContentDocument();

}