org.w3c.dom.html.HTMLOptionsCollection Maven / Gradle / Ivy
Show all versions of dragome-js-jre Show documentation
/*
GNU LESSER GENERAL PUBLIC LICENSE
Copyright (C) 2006 The Lobo Project
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Contact info: [email protected]
*/
/*
* Copyright (c) 2003 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.DOMException;
import org.w3c.dom.Node;
/**
* An HTMLOptionsCollection is a list of nodes representing HTML
* option element. An individual node may be accessed by either ordinal
* index or the node's name or id attributes.
* Collections in the HTML DOM are assumed to be live meaning that they are
* automatically updated when the underlying document is changed.
* See also the Document Object Model (DOM) Level 2 HTML Specification.
* @since DOM Level 2
*/
public interface HTMLOptionsCollection
{
/**
* This attribute specifies the length or size of the list.
*/
public int getLength();
/**
* This attribute specifies the length or size of the list.
* @exception DOMException
* NOT_SUPPORTED_ERR: if setting the length is not allowed by the
* implementation.
*/
public void setLength(int length) throws DOMException;
/**
* This method retrieves a node specified by ordinal index. Nodes are
* numbered in tree order (depth-first traversal order).
* @param index The index of the node to be fetched. The index origin is
* 0.
* @return The Node at the corresponding position upon
* success. A value of null is returned if the index is
* out of range.
*/
public Node item(int index);
/**
* This method retrieves a Node using a name. It first
* searches for a Node with a matching id
* attribute. If it doesn't find one, it then searches for a
* Node with a matching name attribute, but
* only on those elements that are allowed a name attribute. This method
* is case insensitive in HTML documents and case sensitive in XHTML
* documents.
* @param name The name of the Node to be fetched.
* @return The Node with a name or
* id attribute whose value corresponds to the specified
* string. Upon failure (e.g., no node with this name exists), returns
* null.
*/
public Node namedItem(String name);
}