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. 39 * See W3C License http://www.w3.org/Consortium/Legal/ for more details. 40 */ 41 42 package org.w3c.dom.stylesheets; 43 44 import org.w3c.dom.DOMException; 45 46 /** 47 * The <code>MediaList</code> interface provides the abstraction of an 48 * ordered collection of media, without defining or constraining how this 49 * collection is implemented. An empty list is the same as a list that 50 * contains the medium <code>"all"</code>. 51 * <p> The items in the <code>MediaList</code> are accessible via an integral 52 * index, starting from 0. 53 * <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>. 54 * @since 1.4, DOM Level 2 55 */ 56 public interface MediaList { 57 /** 58 * The parsable textual representation of the media list. This is a 59 * comma-separated list of media. 60 */ getMediaText()61 public String getMediaText(); 62 /** 63 * The parsable textual representation of the media list. This is a 64 * comma-separated list of media. 65 * @exception DOMException 66 * SYNTAX_ERR: Raised if the specified string value has a syntax error 67 * and is unparsable. 68 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is 69 * readonly. 70 */ setMediaText(String mediaText)71 public void setMediaText(String mediaText) 72 throws DOMException; 73 74 /** 75 * The number of media in the list. The range of valid media is 76 * <code>0</code> to <code>length-1</code> inclusive. 77 */ getLength()78 public int getLength(); 79 80 /** 81 * Returns the <code>index</code>th in the list. If <code>index</code> is 82 * greater than or equal to the number of media in the list, this 83 * returns <code>null</code>. 84 * @param index Index into the collection. 85 * @return The medium at the <code>index</code>th position in the 86 * <code>MediaList</code>, or <code>null</code> if that is not a valid 87 * index. 88 */ item(int index)89 public String item(int index); 90 91 /** 92 * Deletes the medium indicated by <code>oldMedium</code> from the list. 93 * @param oldMedium The medium to delete in the media list. 94 * @exception DOMException 95 * NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly. 96 * <br> NOT_FOUND_ERR: Raised if <code>oldMedium</code> is not in the 97 * list. 98 */ deleteMedium(String oldMedium)99 public void deleteMedium(String oldMedium) 100 throws DOMException; 101 102 /** 103 * Adds the medium <code>newMedium</code> to the end of the list. If the 104 * <code>newMedium</code> is already used, it is first removed. 105 * @param newMedium The new medium to add. 106 * @exception DOMException 107 * INVALID_CHARACTER_ERR: If the medium contains characters that are 108 * invalid in the underlying style language. 109 * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly. 110 */ appendMedium(String newMedium)111 public void appendMedium(String newMedium) 112 throws DOMException; 113 114 } 115