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 
46 /**
47  *  The <code>CSSRule</code> interface is the abstract base interface for any
48  * type of CSS statement. This includes both rule sets and at-rules. An
49  * implementation is expected to preserve all rules specified in a CSS style
50  * sheet, even if the rule is not recognized by the parser. Unrecognized
51  * rules are represented using the <code>CSSUnknownRule</code> interface.
52  * <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>.
53  * @since 1.4, DOM Level 2
54  */
55 public interface CSSRule {
56     // RuleType
57     /**
58      * The rule is a <code>CSSUnknownRule</code>.
59      */
60     public static final short UNKNOWN_RULE              = 0;
61     /**
62      * The rule is a <code>CSSStyleRule</code>.
63      */
64     public static final short STYLE_RULE                = 1;
65     /**
66      * The rule is a <code>CSSCharsetRule</code>.
67      */
68     public static final short CHARSET_RULE              = 2;
69     /**
70      * The rule is a <code>CSSImportRule</code>.
71      */
72     public static final short IMPORT_RULE               = 3;
73     /**
74      * The rule is a <code>CSSMediaRule</code>.
75      */
76     public static final short MEDIA_RULE                = 4;
77     /**
78      * The rule is a <code>CSSFontFaceRule</code>.
79      */
80     public static final short FONT_FACE_RULE            = 5;
81     /**
82      * The rule is a <code>CSSPageRule</code>.
83      */
84     public static final short PAGE_RULE                 = 6;
85 
86     /**
87      *  The type of the rule, as defined above. The expectation is that
88      * binding-specific casting methods can be used to cast down from an
89      * instance of the <code>CSSRule</code> interface to the specific
90      * derived interface implied by the <code>type</code>.
91      */
getType()92     public short getType();
93 
94     /**
95      *  The parsable textual representation of the rule. This reflects the
96      * current state of the rule and not its initial value.
97      */
getCssText()98     public String getCssText();
99     /**
100      *  The parsable textual representation of the rule. This reflects the
101      * current state of the rule and not its initial value.
102      * @exception DOMException
103      *   SYNTAX_ERR: Raised if the specified CSS string value has a syntax
104      *   error and is unparsable.
105      *   <br>INVALID_MODIFICATION_ERR: Raised if the specified CSS string
106      *   value represents a different type of rule than the current one.
107      *   <br>HIERARCHY_REQUEST_ERR: Raised if the rule cannot be inserted at
108      *   this point in the style sheet.
109      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if the rule is readonly.
110      */
setCssText(String cssText)111     public void setCssText(String cssText)
112                         throws DOMException;
113 
114     /**
115      *  The style sheet that contains this rule.
116      */
getParentStyleSheet()117     public CSSStyleSheet getParentStyleSheet();
118 
119     /**
120      *  If this rule is contained inside another rule (e.g. a style rule
121      * inside an @media block), this is the containing rule. If this rule is
122      * not nested inside any other rules, this returns <code>null</code>.
123      */
getParentRule()124     public CSSRule getParentRule();
125 
126 }
127