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

/*
 * Copyright (C) 2005 by Quentin Anciaux
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 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 Library General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *	@author Quentin Anciaux
 */

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.
     *
     * @return DOCUMENT ME!
     */
    public String getMediaText();

    /**
     * DOCUMENT ME!
     *
     * @param mediaText DOCUMENT ME!
     *
     * @throws DOMException DOCUMENT ME!
     */
    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.
     *
     * @return DOCUMENT ME!
     */
    public int getLength();

    /**
     * Returns the index th 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 index th 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 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 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;
}