com.gargoylesoftware.css.parser

Interface CSSParser

All Known Implementing Classes:

AbstractCSSParser

public interface CSSParser

Basic interface of the CSS parser.

Author:

Ronald Brill

Method Summary

Modifier and Type	Method and Description
String	getParserVersion()
boolean	isIeStarHackAccepted()
boolean	parsePriority(InputSource source) Parse a CSS priority value (e.g.
LexicalUnit	parsePropertyValue(InputSource source) Parse a CSS property value.
void	parseRule(InputSource source) Parse a CSS rule.
SelectorList	parseSelectors(InputSource source) Parse a comma separated list of selectors.
void	parseStyleDeclaration(InputSource source) Parse a CSS style declaration (without '{' and '}').
void	parseStyleSheet(InputSource source) Parse a CSS document.
void	setDocumentHandler(DocumentHandler handler) Allow an application to register a document event handler.
void	setErrorHandler(CSSErrorHandler handler) Allow an application to register an error event handler.
void	setIeStarHackAccepted(boolean accepted)

Method Detail

setDocumentHandler

void setDocumentHandler(DocumentHandler handler)

Allow an application to register a document event handler.

If the application does not register a document handler, all document events reported by the CSS parser will be silently ignored (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the CSS parser must begin using the new handler immediately.

Parameters:

handler - The document handler.

See Also:

DocumentHandler

setErrorHandler

void setErrorHandler(CSSErrorHandler handler)

Allow an application to register an error event handler.

If the application does not register an error event handler, all error events reported by the CSS parser will be silently ignored, except for fatalError, which will throw a CSSException (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the CSS parser must begin using the new handler immediately.

Parameters:

handler - The error handler.

See Also:

CSSErrorHandler, CSSException

parseStyleSheet

void parseStyleSheet(InputSource source)
              throws CSSException,
                     IOException

Parse a CSS document.

The application can use this method to instruct the CSS parser to begin parsing an CSS document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new Parser instead for each additional CSS document). Once a parse is complete, an application may reuse the same Parser object, possibly with a different input source.

Parameters:

source - The input source for the top-level of the CSS document.

Throws:

CSSException - Any CSS exception, possibly wrapping another exception.

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

See Also:

InputSource, setDocumentHandler(com.gargoylesoftware.css.parser.DocumentHandler), setErrorHandler(com.gargoylesoftware.css.parser.CSSErrorHandler)

parseStyleDeclaration

void parseStyleDeclaration(InputSource source)
                    throws CSSException,
                           IOException

Parse a CSS style declaration (without '{' and '}').

Parameters:

source - source to be parsed

Throws:

CSSException - Any CSS exception, possibly wrapping another exception.

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parseRule

void parseRule(InputSource source)
        throws CSSException,
               IOException

Parse a CSS rule.

Parameters:

source - source to be parsed

Throws:

CSSException - Any CSS exception, possibly wrapping another exception.

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

getParserVersion

String getParserVersion()

Returns:

a string about which CSS language is supported by this parser. For CSS Level 1, it returns "http://www.w3.org/TR/REC-CSS1", for CSS Level 2, it returns "http://www.w3.org/TR/REC-CSS2". Note that a "CSSx" parser can return lexical unit other than those allowed by CSS Level x but this usage is not recommended.

parseSelectors

SelectorList parseSelectors(InputSource source)
                     throws CSSException,
                            IOException

Parse a comma separated list of selectors.

Parameters:

source - source to be parsed

Returns:

a selector list

Throws:

CSSException - Any CSS exception, possibly wrapping another exception.

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parsePropertyValue

LexicalUnit parsePropertyValue(InputSource source)
                        throws CSSException,
                               IOException

Parse a CSS property value.

Parameters:

source - source to be parsed

Returns:

a lexical unit

Throws:

CSSException - Any CSS exception, possibly wrapping another exception.

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parsePriority

boolean parsePriority(InputSource source)
               throws CSSException,
                      IOException

Parse a CSS priority value (e.g. "!important").

Parameters:

source - source to be parsed

Returns:

true or flase

Throws:

CSSException - Any CSS exception, possibly wrapping another exception.

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

setIeStarHackAccepted

void setIeStarHackAccepted(boolean accepted)

Parameters:

accepted - trur if the parser should accept ie star hack

isIeStarHackAccepted

boolean isIeStarHackAccepted()

Returns:

accepted trur if the parser should accept ie star hack