01: /*
02: * Copyright (c) 2000 World Wide Web Consortium,
03: * (Massachusetts Institute of Technology, Institut National de
04: * Recherche en Informatique et en Automatique, Keio University). All
05: * Rights Reserved. This program is distributed under the W3C's Software
06: * Intellectual Property License. This program is distributed in the
07: * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
08: * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
09: * 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: * @exception DOMException
32: * SYNTAX_ERR: Raised if the specified string value has a syntax error
33: * and is unparsable.
34: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is
35: * readonly.
36: */
37: public String getMediaText();
38:
39: /**
40: * The parsable textual representation of the media list. This is a
41: * comma-separated list of media.
42: * @exception DOMException
43: * SYNTAX_ERR: Raised if the specified string value has a syntax error
44: * and is unparsable.
45: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is
46: * readonly.
47: */
48: public void setMediaText(String mediaText) throws DOMException;
49:
50: /**
51: * The number of media in the list. The range of valid media is
52: * <code>0</code> to <code>length-1</code> inclusive.
53: */
54: public int getLength();
55:
56: /**
57: * Returns the <code>index</code>th in the list. If <code>index</code> is
58: * greater than or equal to the number of media in the list, this
59: * returns <code>null</code>.
60: * @param index Index into the collection.
61: * @return The medium at the <code>index</code>th position in the
62: * <code>MediaList</code>, or <code>null</code> if that is not a valid
63: * index.
64: */
65: public String item(int index);
66:
67: /**
68: * Deletes the medium indicated by <code>oldMedium</code> from the list.
69: * @param oldMedium The medium to delete in the media list.
70: * @exception DOMException
71: * NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
72: * <br> NOT_FOUND_ERR: Raised if <code>oldMedium</code> is not in the
73: * list.
74: */
75: public void deleteMedium(String oldMedium) throws DOMException;
76:
77: /**
78: * Adds the medium <code>newMedium</code> to the end of the list. If the
79: * <code>newMedium</code> is already used, it is first removed.
80: * @param newMedium The new medium to add.
81: * @exception DOMException
82: * INVALID_CHARACTER_ERR: If the medium contains characters that are
83: * invalid in the underlying style language.
84: * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
85: */
86: public void appendMedium(String newMedium) throws DOMException;
87:
88: }
|