Interface DocumentHandler

  • All Known Implementing Classes:
    CSSOMParser.CSSOMHandler, HandlerBase

    public interface DocumentHandler
    This is the main interface that most CSS applications implement: if the application needs to be informed of basic parsing events, it implements this interface and registers an instance with the CSS parser using the setCSSHandler method.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void charset​(java.lang.String characterEncoding, Locator locator)
      Receive notification of a charset at-rule.
      void endDocument​(InputSource source)
      Receive notification of the end of a document.
      void endFontFace()
      Receive notification of the end of a font face statement.
      void endMedia​(MediaQueryList media)
      Receive notification of the end of a media statement.
      void endPage​(java.lang.String name, java.lang.String pseudoPage)
      Receive notification of the end of a media statement.
      void endSelector​(SelectorList selectors)
      Receive notification of the end of a rule statement.
      void ignorableAtRule​(java.lang.String atRule, Locator locator)
      Receive notification of an unknown rule t-rule not supported by this parser.
      void importStyle​(java.lang.String uri, MediaQueryList media, java.lang.String defaultNamespaceURI, Locator locator)
      Receive notification of a import statement in the style sheet.
      void property​(java.lang.String name, LexicalUnit value, boolean important, Locator locator)
      Receive notification of a declaration.
      void startDocument​(InputSource source)
      Receive notification of the beginning of a style sheet.
      void startFontFace​(Locator locator)
      Receive notification of the beginning of a font face statement.
      void startMedia​(MediaQueryList media, Locator locator)
      Receive notification of the beginning of a media statement.
      void startPage​(java.lang.String name, java.lang.String pseudoPage, Locator locator)
      Receive notification of the beginning of a page statement.
      void startSelector​(SelectorList selectors, Locator locator)
      Receive notification of the beginning of a rule statement.
    • Method Detail

      • startDocument

        void startDocument​(InputSource source)
                    throws CSSException
        Receive notification of the beginning of a style sheet. The CSS parser will invoke this method only once, before any other methods in this interface.
        Parameters:
        source - the input source to parse
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • endDocument

        void endDocument​(InputSource source)
                  throws CSSException
        Receive notification of the end of a document. The CSS parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
        Parameters:
        source - the input source to parse
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • endMedia

        void endMedia​(MediaQueryList media)
               throws CSSException
        Receive notification of the end of a media statement.
        Parameters:
        media - The intended destination media for style information.
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • endPage

        void endPage​(java.lang.String name,
                     java.lang.String pseudoPage)
              throws CSSException
        Receive notification of the end of a media statement.
        Parameters:
        name - the name
        pseudoPage - the pseudo page (if any, null otherwise)
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • endFontFace

        void endFontFace()
                  throws CSSException
        Receive notification of the end of a font face statement.
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • endSelector

        void endSelector​(SelectorList selectors)
                  throws CSSException
        Receive notification of the end of a rule statement.
        Parameters:
        selectors - All intended selectors for all declarations.
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • charset

        void charset​(java.lang.String characterEncoding,
                     Locator locator)
              throws CSSException
        Receive notification of a charset at-rule.
        Parameters:
        characterEncoding - the character encoding
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • importStyle

        void importStyle​(java.lang.String uri,
                         MediaQueryList media,
                         java.lang.String defaultNamespaceURI,
                         Locator locator)
                  throws CSSException
        Receive notification of a import statement in the style sheet.
        Parameters:
        uri - The URI of the imported style sheet.
        media - The intended destination media for style information.
        defaultNamespaceURI - The default namespace URI for the imported style sheet.
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • ignorableAtRule

        void ignorableAtRule​(java.lang.String atRule,
                             Locator locator)
                      throws CSSException
        Receive notification of an unknown rule t-rule not supported by this parser.
        Parameters:
        atRule - The complete ignored at-rule.
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • startFontFace

        void startFontFace​(Locator locator)
                    throws CSSException
        Receive notification of the beginning of a font face statement. The Parser will invoke this method at the beginning of every font face statement in the style sheet. there will be a corresponding endFontFace() event for every startFontFace() event.
        Parameters:
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • startPage

        void startPage​(java.lang.String name,
                       java.lang.String pseudoPage,
                       Locator locator)
                throws CSSException
        Receive notification of the beginning of a page statement. The Parser will invoke this method at the beginning of every page statement in the style sheet. there will be a corresponding endPage() event for every startPage() event.
        Parameters:
        name - the name of the page (if any, null otherwise)
        pseudoPage - the pseudo page (if any, null otherwise)
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • startMedia

        void startMedia​(MediaQueryList media,
                        Locator locator)
                 throws CSSException
        Receive notification of the beginning of a media statement. The Parser will invoke this method at the beginning of every media statement in the style sheet. there will be a corresponding endMedia() event for every startElement() event.
        Parameters:
        media - The intended destination media for style information.
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • startSelector

        void startSelector​(SelectorList selectors,
                           Locator locator)
                    throws CSSException
        Receive notification of the beginning of a rule statement.
        Parameters:
        selectors - All intended selectors for all declarations.
        locator - the locator
        Throws:
        CSSException - Any CSS exception, possibly wrapping another exception.
      • property

        void property​(java.lang.String name,
                      LexicalUnit value,
                      boolean important,
                      Locator locator)
        Receive notification of a declaration.
        Parameters:
        name - the name of the property.
        value - the value of the property. All whitespace are stripped.
        important - is this property important ?
        locator - the locator