1 /* 2 * Copyright (c) 2000 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.stylesheets; 14 15 import org.w3c.dom.DOMException; 16 17 /** 18 * The <code>MediaList</code> interface provides the abstraction of an 19 * ordered collection of media, without defining or constraining how this 20 * collection is implemented. An empty list is the same as a list that 21 * contains the medium <code>"all"</code>. 22 * <p> The items in the <code>MediaList</code> are accessible via an integral 23 * index, starting from 0. 24 * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Style-20001113'>Document Object Model (DOM) Level 2 Style Specification</a>. 25 * @since DOM Level 2 26 */ 27 public interface MediaList { 28 /** 29 * The parsable textual representation of the media list. This is a 30 * comma-separated list of media. 31 */ getMediaText()32 public String getMediaText(); 33 /** 34 * The parsable textual representation of the media list. This is a 35 * comma-separated list of media. 36 * @exception DOMException 37 * SYNTAX_ERR: Raised if the specified string value has a syntax error 38 * and is unparsable. 39 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is 40 * readonly. 41 */ setMediaText(String mediaText)42 public void setMediaText(String mediaText) 43 throws DOMException; 44 45 /** 46 * The number of media in the list. The range of valid media is 47 * <code>0</code> to <code>length-1</code> inclusive. 48 */ getLength()49 public int getLength(); 50 51 /** 52 * Returns the <code>index</code>th in the list. If <code>index</code> is 53 * greater than or equal to the number of media in the list, this 54 * returns <code>null</code>. 55 * @param index Index into the collection. 56 * @return The medium at the <code>index</code>th position in the 57 * <code>MediaList</code>, or <code>null</code> if that is not a valid 58 * index. 59 */ item(int index)60 public String item(int index); 61 62 /** 63 * Deletes the medium indicated by <code>oldMedium</code> from the list. 64 * @param oldMedium The medium to delete in the media list. 65 * @exception DOMException 66 * NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly. 67 * <br> NOT_FOUND_ERR: Raised if <code>oldMedium</code> is not in the 68 * list. 69 */ deleteMedium(String oldMedium)70 public void deleteMedium(String oldMedium) 71 throws DOMException; 72 73 /** 74 * Adds the medium <code>newMedium</code> to the end of the list. If the 75 * <code>newMedium</code> is already used, it is first removed. 76 * @param newMedium The new medium to add. 77 * @exception DOMException 78 * INVALID_CHARACTER_ERR: If the medium contains characters that are 79 * invalid in the underlying style language. 80 * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly. 81 */ appendMedium(String newMedium)82 public void appendMedium(String newMedium) 83 throws DOMException; 84 85 } 86