org.w3c.dom.stylesheets.StyleSheet 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.stylesheets;

import org.w3c.dom.Node;


/**
 * The StyleSheet interface is the abstract base interface for any
 * type of style sheet. It represents a single style sheet associated with a
 * structured document. In HTML, the StyleSheet interface represents either an
 * external style sheet, included via the HTML LINK element, or an inline
 * STYLE element. In XML, this interface represents an external style sheet,
 * included via a style sheet processing instruction.
 * 
 * 
 * See also the Document
 * Object Model (DOM) Level 2 Style Specification .
 * 
 *
 * @since DOM Level 2
 */
public interface StyleSheet {
    /**
     * This specifies the style sheet language for this style sheet. The style
     * sheet language is specified as a content type (e.g. "text/css"). The
     * content type is often specified in the ownerNode. Also see
     * the type attribute definition for the LINK element in HTML
     * 4.0, and the type pseudo-attribute for the XML style sheet processing
     * instruction.
     *
     * @return DOCUMENT ME!
     */
    public String getType();

    /**
     * false if the style sheet is applied to the document.
     * true if it is not. Modifying this attribute may cause a
     * new resolution of style for the document. A stylesheet only applies if
     * both an appropriate medium definition is present and the disabled
     * attribute is false. So, if the media doesn't apply to the current user
     * agent, the disabled attribute is ignored.
     *
     * @return DOCUMENT ME!
     */
    public boolean getDisabled();

    /**
     * DOCUMENT ME!
     *
     * @param disabled DOCUMENT ME!
     */
    public void setDisabled(boolean disabled);

    /**
     * The node that associates this style sheet with the document. For HTML,
     * this may be the corresponding LINK or STYLE
     * element. For XML, it may be the linking processing instruction. For
     * style sheets that are included by other style sheets, the value of this
     * attribute is null.
     *
     * @return DOCUMENT ME!
     */
    public Node getOwnerNode();

    /**
     * For style sheet languages that support the concept of style sheet
     * inclusion, this attribute represents the including style sheet, if one
     * exists. If the style sheet is a top-level style sheet, or the style
     * sheet language does not support inclusion, the value of this attribute
     * is null.
     *
     * @return DOCUMENT ME!
     */
    public StyleSheet getParentStyleSheet();

    /**
     * If the style sheet is a linked style sheet, the value of its attribute
     * is its location. For inline style sheets, the value of this attribute
     * is null. See the href attribute definition for the
     * LINK element in HTML 4.0, and the href pseudo-attribute
     * for the XML style sheet processing instruction.
     *
     * @return DOCUMENT ME!
     */
    public String getHref();

    /**
     * The advisory title. The title is often specified in the
     * ownerNode. See the title attribute definition for the
     * LINK element in HTML 4.0, and the title pseudo-attribute
     * for the XML style sheet processing instruction.
     *
     * @return DOCUMENT ME!
     */
    public String getTitle();

    /**
     * The intended destination media for style information. The media is often
     * specified in the ownerNode. If no media has been
     * specified, the MediaList will be empty. See the media
     * attribute definition for the LINK element in HTML 4.0, and
     * the media pseudo-attribute for the XML style sheet processing
     * instruction . Modifying the media list may cause a change to the
     * attribute disabled.
     *
     * @return DOCUMENT ME!
     */
    public MediaList getMedia();
}