HTMLOptionElement.java revision 723:e6268235b2db 
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
44/**
45 *  A selectable choice. See the  OPTION element definition in HTML 4.0.
46 * <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>.
47 */
48public interface HTMLOptionElement extends HTMLElement {
49    /**
50     *  Returns the <code>FORM</code> element containing this control. Returns
51     * <code>null</code> if this control is not within the context of a form.
52     */
53    public HTMLFormElement getForm();
54
55    /**
56     *  Represents the value of the HTML selected attribute. The value of this
57     * attribute does not change if the state of the corresponding form
58     * control, in an interactive user agent, changes. Changing
59     * <code>defaultSelected</code> , however, resets the state of the form
60     * control. See the  selected attribute definition in HTML 4.0.
61     */
62    public boolean getDefaultSelected();
63    public void setDefaultSelected(boolean defaultSelected);
64
65    /**
66     *  The text contained within the option element.
67     */
68    public String getText();
69
70    /**
71     *  The index of this <code>OPTION</code> in its parent <code>SELECT</code>
72     *  , starting from 0.
73     */
74    public int getIndex();
75
76    /**
77     *  The control is unavailable in this context. See the  disabled
78     * attribute definition in HTML 4.0.
79     */
80    public boolean getDisabled();
81    public void setDisabled(boolean disabled);
82
83    /**
84     *  Option label for use in hierarchical menus. See the  label attribute
85     * definition in HTML 4.0.
86     */
87    public String getLabel();
88    public void setLabel(String label);
89
90    /**
91     *  Represents the current state of the corresponding form control, in an
92     * interactive user agent. Changing this attribute changes the state of
93     * the form control, but does not change the value of the HTML selected
94     * attribute of the element.
95     */
96    public boolean getSelected();
97    public void setSelected(boolean selected);
98
99    /**
100     *  The current form control value. See the  value attribute definition in
101     * HTML 4.0.
102     */
103    public String getValue();
104    public void setValue(String value);
105
106}
107