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.css;
43
44 import org.w3c.dom.DOMException;
45 import org.w3c.dom.stylesheets.MediaList;
46
47 /**
48 * The <code>CSSMediaRule</code> interface represents a @media rule in a CSS
49 * style sheet. A <code>@media</code> rule can be used to delimit style
50 * rules for specific media types.
51 * <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>.
52 * @since DOM Level 2
53 */
54 public interface CSSMediaRule extends CSSRule {
55 /**
56 * A list of media types for this rule.
57 */
58 public MediaList getMedia();
59
60 /**
61 * A list of all CSS rules contained within the media block.
62 */
63 public CSSRuleList getCssRules();
64
65 /**
66 * Used to insert a new rule into the media block.
67 * @param rule The parsable text representing the rule. For rule sets
68 * this contains both the selector and the style declaration. For
69 * at-rules, this specifies both the at-identifier and the rule
70 * content.
71 * @param index The index within the media block's rule collection of
72 * the rule before which to insert the specified rule. If the
73 * specified index is equal to the length of the media blocks's rule
74 * collection, the rule will be added to the end of the media block.
75 * @return The index within the media block's rule collection of the
76 * newly inserted rule.
77 * @exception DOMException
78 * HIERARCHY_REQUEST_ERR: Raised if the rule cannot be inserted at the
79 * specified index, e.g., if an <code>@import</code> rule is inserted
80 * after a standard rule set or other at-rule.
81 * <br>INDEX_SIZE_ERR: Raised if the specified index is not a valid
82 * insertion point.
83 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this media rule is
84 * readonly.
85 * <br>SYNTAX_ERR: Raised if the specified rule has a syntax error and
86 * is unparsable.
87 */
88 public int insertRule(String rule,
89 int index)
90 throws DOMException;
91
92 /**
93 * Used to delete a rule from the media block.
94 * @param index The index within the media block's rule collection of
95 * the rule to remove.
96 * @exception DOMException
97 * INDEX_SIZE_ERR: Raised if the specified index does not correspond to
98 * a rule in the media rule list.
99 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this media rule is
100 * readonly.
101 */
102 public void deleteRule(int index)
103 throws DOMException;
104
105 }