org.w3c.dom.stylesheets.MediaList Maven / Gradle / Ivy

/*
 * 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.stylesheets;

import org.w3c.dom.DOMException;

/**
 *  The MediaList interface provides the abstraction of an 
 * ordered collection of media, without defining or constraining how this 
 * collection is implemented. An empty list is the same as a list that 
 * contains the medium "all". 
 *  The items in the MediaList are accessible via an integral 
 * index, starting from 0. 
 * See also the Document Object Model (DOM) Level 2 Style Specification.
 * @since DOM Level 2
 */
public interface MediaList {
    /**
     *  The parsable textual representation of the media list. This is a 
     * comma-separated list of media. 
     */
    public String getMediaText();
    /**
     *  The parsable textual representation of the media list. This is a 
     * comma-separated list of media. 
     * @exception DOMException
     *   SYNTAX_ERR: Raised if the specified string value has a syntax error 
     *   and is unparsable.
     *   
NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is 
     *   readonly.
     */
    public void setMediaText(String mediaText)
                             throws DOMException;

    /**
     *  The number of media in the list. The range of valid media is 
     * 0 to length-1 inclusive. 
     */
    public int getLength();

    /**
     *  Returns the indexth in the list. If index is 
     * greater than or equal to the number of media in the list, this 
     * returns null. 
     * @param index  Index into the collection. 
     * @return  The medium at the indexth position in the 
     *   MediaList, or null if that is not a valid 
     *   index. 
     */
    public String item(int index);

    /**
     *  Deletes the medium indicated by oldMedium from the list. 
     * @param oldMedium The medium to delete in the media list.
     * @exception DOMException
     *    NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly. 
     *   
 NOT_FOUND_ERR: Raised if oldMedium is not in the 
     *   list. 
     */
    public void deleteMedium(String oldMedium)
                             throws DOMException;

    /**
     *  Adds the medium newMedium to the end of the list. If the 
     * newMedium is already used, it is first removed. 
     * @param newMedium The new medium to add.
     * @exception DOMException
     *    INVALID_CHARACTER_ERR: If the medium contains characters that are 
     *   invalid in the underlying style language. 
     *   
 NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly. 
     */
    public void appendMedium(String newMedium)
                             throws DOMException;

}