Source for org.w3c.dom.html2.HTMLObjectElement

   1: /*
   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
   9:  * PURPOSE.
  10:  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11:  */
  12: 
  13: package org.w3c.dom.html2;
  14: 
  15: import org.w3c.dom.Document;
  16: 
  17: /**
  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>.
  23:  */
  24: public interface HTMLObjectElement extends HTMLElement {
  25:     /**
  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
  28:      * form.
  29:      */
  30:     public HTMLFormElement getForm();
  31: 
  32:     /**
  33:      * Applet class file. See the <code>code</code> attribute for
  34:      * HTMLAppletElement.
  35:      */
  36:     public String getCode();
  37:     /**
  38:      * Applet class file. See the <code>code</code> attribute for
  39:      * HTMLAppletElement.
  40:      */
  41:     public void setCode(String code);
  42: 
  43:     /**
  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.
  47:      */
  48:     public String getAlign();
  49:     /**
  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.
  53:      */
  54:     public void setAlign(String align);
  55: 
  56:     /**
  57:      * Space-separated list of archives. See the archive attribute definition
  58:      * in HTML 4.01.
  59:      */
  60:     public String getArchive();
  61:     /**
  62:      * Space-separated list of archives. See the archive attribute definition
  63:      * in HTML 4.01.
  64:      */
  65:     public void setArchive(String archive);
  66: 
  67:     /**
  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.
  70:      */
  71:     public String getBorder();
  72:     /**
  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.
  75:      */
  76:     public void setBorder(String border);
  77: 
  78:     /**
  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
  81:      *  in HTML 4.01.
  82:      */
  83:     public String getCodeBase();
  84:     /**
  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
  87:      *  in HTML 4.01.
  88:      */
  89:     public void setCodeBase(String codeBase);
  90: 
  91:     /**
  92:      * Content type for data downloaded via <code>classid</code> attribute.
  93:      * See the codetype attribute definition in HTML 4.01.
  94:      */
  95:     public String getCodeType();
  96:     /**
  97:      * Content type for data downloaded via <code>classid</code> attribute.
  98:      * See the codetype attribute definition in HTML 4.01.
  99:      */
 100:     public void setCodeType(String codeType);
 101: 
 102:     /**
 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.
 105:      */
 106:     public String getData();
 107:     /**
 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.
 110:      */
 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.01.
 116:      */
 117:     public boolean getDeclare();
 118:     /**
 119:      * Declare (for future reference), but do not instantiate, this object.
 120:      * See the declare attribute definition in HTML 4.01.
 121:      */
 122:     public void setDeclare(boolean declare);
 123: 
 124:     /**
 125:      * Override height. See the height attribute definition in HTML 4.01.
 126:      */
 127:     public String getHeight();
 128:     /**
 129:      * Override height. See the height attribute definition in HTML 4.01.
 130:      */
 131:     public void setHeight(String height);
 132: 
 133:     /**
 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.
 137:      */
 138:     public int getHspace();
 139:     /**
 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.
 143:      */
 144:     public void setHspace(int hspace);
 145: 
 146:     /**
 147:      * Form control or object name when submitted with a form. See the name
 148:      * attribute definition in HTML 4.01.
 149:      */
 150:     public String getName();
 151:     /**
 152:      * Form control or object name when submitted with a form. See the name
 153:      * attribute definition in HTML 4.01.
 154:      */
 155:     public void setName(String name);
 156: 
 157:     /**
 158:      * Message to render while loading the object. See the standby attribute
 159:      * definition in HTML 4.01.
 160:      */
 161:     public String getStandby();
 162:     /**
 163:      * Message to render while loading the object. See the standby attribute
 164:      * definition in HTML 4.01.
 165:      */
 166:     public void setStandby(String standby);
 167: 
 168:     /**
 169:      * Index that represents the element's position in the tabbing order. See
 170:      * the tabindex attribute definition in HTML 4.01.
 171:      */
 172:     public int getTabIndex();
 173:     /**
 174:      * Index that represents the element's position in the tabbing order. See
 175:      * the tabindex attribute definition in HTML 4.01.
 176:      */
 177:     public void setTabIndex(int tabIndex);
 178: 
 179:     /**
 180:      * Content type for data downloaded via <code>data</code> attribute. See
 181:      * the type attribute definition in HTML 4.01.
 182:      */
 183:     public String getType();
 184:     /**
 185:      * Content type for data downloaded via <code>data</code> attribute. See
 186:      * the type attribute definition in HTML 4.01.
 187:      */
 188:     public void setType(String type);
 189: 
 190:     /**
 191:      * Use client-side image map. See the usemap attribute definition in HTML
 192:      * 4.01.
 193:      */
 194:     public String getUseMap();
 195:     /**
 196:      * Use client-side image map. See the usemap attribute definition in HTML
 197:      * 4.01.
 198:      */
 199:     public void setUseMap(String useMap);
 200: 
 201:     /**
 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.
 205:      */
 206:     public int getVspace();
 207:     /**
 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.
 211:      */
 212:     public void setVspace(int vspace);
 213: 
 214:     /**
 215:      * Override width. See the width attribute definition in HTML 4.01.
 216:      */
 217:     public String getWidth();
 218:     /**
 219:      * Override width. See the width attribute definition in HTML 4.01.
 220:      */
 221:     public void setWidth(String width);
 222: 
 223:     /**
 224:      * The document this object contains, if there is any and it is available,
 225:      * or <code>null</code> otherwise.
 226:      * @since DOM Level 2
 227:      */
 228:     public Document getContentDocument();
 229: 
 230: }