org.w3c.dom.css.CSSMediaRule Maven / Gradle / Ivy

/*
 * Copyright (C) 2005 by Quentin Anciaux
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *	@author Quentin Anciaux
 */

package org.w3c.dom.css;

import org.w3c.dom.DOMException;
import org.w3c.dom.stylesheets.MediaList;


/**
 * The CSSMediaRule interface represents a  @media rule in
 * a CSS style sheet. A @media rule can be used to delimit
 * style rules for specific media types.
 * 
 * 
 * See also the Document
 * Object Model (DOM) Level 2 Style Specification .
 * 
 *
 * @since DOM Level 2
 */
public interface CSSMediaRule
    extends CSSRule {
    /**
     * A list of media types for this rule.
     *
     * @return DOCUMENT ME!
     */
    public MediaList getMedia();

    /**
     * A list of all CSS rules contained within the media block.
     *
     * @return DOCUMENT ME!
     */
    public CSSRuleList getCssRules();

    /**
     * Used to insert a new rule into the media block.
     *
     * @param rule The parsable text representing the rule. For rule sets this
     *        contains both the selector and the style declaration. For
     *        at-rules, this specifies both the at-identifier and the rule
     *        content.
     * @param index The index within the media block's rule collection of the
     *        rule before which to insert the specified rule. If the specified
     *        index is equal to the length of the media blocks's rule
     *        collection, the rule will be added to the end of the media
     *        block.
     *
     * @return The index within the media block's rule collection of the newly
     *         inserted rule.
     *
     * @exception DOMException HIERARCHY_REQUEST_ERR: Raised if the rule cannot
     *            be inserted at the specified index, e.g., if an
     *            @import rule is inserted after a
     *            standard rule set or other at-rule. 

     *            INDEX_SIZE_ERR: Raised if the specified index is not a valid
     *            insertion point. 

     *            NO_MODIFICATION_ALLOWED_ERR: Raised if this media rule is
     *            readonly. 

     *            SYNTAX_ERR: Raised if the specified rule has a syntax error
     *            and is unparsable.
     */
    public int insertRule(
        String rule,
        int index
    )
        throws DOMException;

    /**
     * Used to delete a rule from the media block.
     *
     * @param index The index within the media block's rule collection of the
     *        rule to remove.
     *
     * @exception DOMException INDEX_SIZE_ERR: Raised if the specified index
     *            does not correspond to a rule in the media rule list. 

     *            NO_MODIFICATION_ALLOWED_ERR: Raised if this media rule is
     *            readonly.
     */
    public void deleteRule(int index)
        throws DOMException;
}