001/*
002 * Copyright (c) 2000 World Wide Web Consortium,
003 * (Massachusetts Institute of Technology, Institut National de
004 * Recherche en Informatique et en Automatique, Keio University). All
005 * Rights Reserved. This program is distributed under the W3C's Software
006 * Intellectual Property License. This program is distributed in the
007 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
008 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
009 * PURPOSE.
010 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
011 */
012
013package org.w3c.dom.css;
014
015import org.w3c.dom.DOMException;
016import org.w3c.dom.stylesheets.StyleSheet;
017
018/**
019 *  The <code>CSSStyleSheet</code> interface is a concrete interface used to
020 * represent a CSS style sheet i.e., a style sheet whose content type is
021 * "text/css".
022 * <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>.
023 * @since DOM Level 2
024 */
025public interface CSSStyleSheet extends StyleSheet {
026    /**
027     *  If this style sheet comes from an <code>@import</code> rule, the
028     * <code>ownerRule</code> attribute will contain the
029     * <code>CSSImportRule</code>. In that case, the <code>ownerNode</code>
030     * attribute in the <code>StyleSheet</code> interface will be
031     * <code>null</code>. If the style sheet comes from an element or a
032     * processing instruction, the <code>ownerRule</code> attribute will be
033     * <code>null</code> and the <code>ownerNode</code> attribute will
034     * contain the <code>Node</code>.
035     */
036    public CSSRule getOwnerRule();
037
038    /**
039     *  The list of all CSS rules contained within the style sheet. This
040     * includes both rule sets and at-rules.
041     */
042    public CSSRuleList getCssRules();
043
044    /**
045     *  Used to insert a new rule into the style sheet. The new rule now
046     * becomes part of the cascade.
047     * @param rule  The parsable text representing the rule. For rule sets
048     *   this contains both the selector and the style declaration. For
049     *   at-rules, this specifies both the at-identifier and the rule
050     *   content.
051     * @param index  The index within the style sheet's rule list of the rule
052     *   before which to insert the specified rule. If the specified index
053     *   is equal to the length of the style sheet's rule collection, the
054     *   rule will be added to the end of the style sheet.
055     * @return  The index within the style sheet's rule collection of the
056     *   newly inserted rule.
057     * @exception DOMException
058     *   HIERARCHY_REQUEST_ERR: Raised if the rule cannot be inserted at the
059     *   specified index e.g. if an <code>@import</code> rule is inserted
060     *   after a standard rule set or other at-rule.
061     *   <br>INDEX_SIZE_ERR: Raised if the specified index is not a valid
062     *   insertion point.
063     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this style sheet is
064     *   readonly.
065     *   <br>SYNTAX_ERR: Raised if the specified rule has a syntax error and
066     *   is unparsable.
067     */
068    public int insertRule(String rule,
069                          int index)
070                          throws DOMException;
071
072    /**
073     *  Used to delete a rule from the style sheet.
074     * @param index  The index within the style sheet's rule list of the rule
075     *   to remove.
076     * @exception DOMException
077     *   INDEX_SIZE_ERR: Raised if the specified index does not correspond to
078     *   a rule in the style sheet's rule list.
079     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this style sheet is
080     *   readonly.
081     */
082    public void deleteRule(int index)
083                           throws DOMException;
084
085}