cz.vutbr.web.css

Class CSSFactory

java.lang.Object

cz.vutbr.web.css.CSSFactory

public final class CSSFactory
extends Object

This class is abstract factory for other factories used during CSS parsing. Use it, for example, to retrieve current(default) TermFactory, current(default) SupportedCSS implementation and so on. Factories need to be registered first. By default, CSSFactory uses automatically for implementations: cz.vutbr.web.csskit.TermFactoryImpl cz.vutbr.web.domassign.SupportedCSS3 cz.vutbr.web.csskit.RuleFactoryImpl cz.vutbr.web.domassign.SingleMapNodeData cz.vutbr.web.csskit.ElementMatcherSafeStd Other usage of this factory is to parse either string or file into StyleSheet. Whole conversion between DOM tree and mapping of CSS to DOM tree elements could be done by invoking method assignDOM()

Author:

kapy

Constructor Summary

Constructors

Constructor and Description
CSSFactory()

Method Summary

Modifier and Type	Method and Description
static StyleMap	assignDOM(Document doc, String encoding, NetworkProcessor network, URL base, MediaSpec media, boolean useInheritance, MatchCondition matchCond) This is the same as assignDOM(Document, String, URL, MediaSpec, boolean) with the possibility of specifying a custom network processor for obtaining data from URL resources.
static StyleMap	assignDOM(Document doc, String encoding, URL base, MediaSpec media, boolean useInheritance) Goes through a DOM tree and assigns the CSS declarations to the DOM elements.
static StyleMap	assignDOM(Document doc, String encoding, URL base, MediaSpec media, boolean useInheritance, MatchCondition matchCond) Goes through a DOM tree and assigns the CSS declarations to the DOM elements.
static StyleMap	assignDOM(Document doc, String encoding, URL base, String media, boolean useInheritance) This is the same as assignDOM(Document, String, URL, MediaSpec, boolean) but only the media type is provided instead of the complete media specification.
static StyleMap	assignDOM(Document doc, String encoding, URL base, String media, boolean useInheritance, MatchCondition matchCond) This is the same as assignDOM(Document, String, URL, MediaSpec, boolean) but only the media type is provided instead of the complete media specification.
static StyleMap	assignDOM(Document doc, URL base, String media, boolean useInheritance) Deprecated.
static NodeData	createNodeData() Creates instance of NodeData
static MediaSpec	getAutoImportMedia() Obtains the media specification used for automatical style import.
static DeclarationTransformer	getDeclarationTransformer() Returns the registered DeclarationTransformer
static MatchCondition	getDefaultMatchCondition() Obtains the default match condition to be used for matching the elements and selector parts.
static ElementMatcher	getElementMatcher()
static boolean	getImplyPixelLength() Says whether to allow lengths with no units and interpret them as pixels.
static NetworkProcessor	getNetworkProcessor()
static RuleFactory	getRuleFactory() Returns registered RuleFactory
static SupportedCSS	getSupportedCSS() Returns registered SupportedCSS
static TermFactory	getTermFactory() Returns TermFactory registered in step above
static StyleSheet	getUsedStyles(Document doc, String encoding, URL base, MediaSpec media) This is the same as getUsedStyles(Document, String, URL, MediaSpec) with the possibility of specifying a custom network processor.
static StyleSheet	getUsedStyles(Document doc, String encoding, URL base, MediaSpec media, NetworkProcessor network) Loads all the style sheets used from the specified DOM tree.
static StyleSheet	getUsedStyles(Document doc, String encoding, URL base, String media) This is the same as getUsedStyles(Document, String, URL, MediaSpec) but only the media type is provided instead of the complete media specification.
static StyleSheet	getUsedStyles(Document doc, URL base, String media) Deprecated.
static StyleSheet	parse(String css) Deprecated. This function does not specify the base URL. parseString(String, URL) should be used instead.
static StyleSheet	parse(String fileName, String encoding) Parses file into StyleSheet.
static StyleSheet	parse(URL url, NetworkProcessor network, String encoding) Parses URL into StyleSheet
static StyleSheet	parse(URL url, String encoding) Parses URL into StyleSheet
static StyleSheet	parseString(String css, URL base) Parses text into a StyleSheet
static StyleSheet	parseString(String css, URL base, NetworkProcessor network) Parses text into a StyleSheet
static void	registerCSSParserFactory(CSSParserFactory factory) Registers new CSSParserFactory instance
static void	registerDeclarationTransformer(DeclarationTransformer newDeclarationTransformer) Registers new DeclarationTransformer
static void	registerDefaultMatchCondition(MatchCondition newMatchCondition) Registers a new default match condition to be used for matching the elements and selector parts.
static void	registerElementMatcher(ElementMatcher newElementMatcher)
static void	registerNodeDataInstance(Class<? extends NodeData> clazz) Registers node data instance.
static void	registerRuleFactory(RuleFactory newRuleFactory) Registers new RuleFactory
static void	registerSupportedCSS(SupportedCSS newCSS) Registers new SupportedCSS instance
static void	registerTermFactory(TermFactory newFactory) Registers new TermFactory instance
static void	setAutoImportMedia(MediaSpec autoImportMedia) Sets the media specification used for automatical style import.
static void	setImplyPixelLength(boolean b) Sets whether to allow lengths with no units and interpret them as pixels.
static void	setNetworkProcessor(NetworkProcessor networkProcessor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSSFactory

public CSSFactory()

Method Detail

setImplyPixelLength

public static final void setImplyPixelLength(boolean b)

Sets whether to allow lengths with no units and interpret them as pixels. The default value is false.

Parameters:

b - true when the lengths with no units should be allowed.

getImplyPixelLength

public static final boolean getImplyPixelLength()

Says whether to allow lengths with no units and interpret them as pixels.

Returns:

true if the lengths with no units are allowed

getAutoImportMedia

public static MediaSpec getAutoImportMedia()

Obtains the media specification used for automatical style import. The parser will automatically download the style sheets imported using the @import rules when they corespond to the given media specification.

Returns:

The media specification.

setAutoImportMedia

public static void setAutoImportMedia(MediaSpec autoImportMedia)

Sets the media specification used for automatical style import. The parser will automatically download the style sheets imported using the @import rules when they corespond to the given media specification. The default is "all" i.e. all the imported style sheets are automatically parsed.

Parameters:

autoImportMedia - The media specification for checking the imports.

getNetworkProcessor

public static NetworkProcessor getNetworkProcessor()

setNetworkProcessor

public static void setNetworkProcessor(NetworkProcessor networkProcessor)

registerCSSParserFactory

public static final void registerCSSParserFactory(CSSParserFactory factory)

Registers new CSSParserFactory instance

Parameters:

factory - New CSSParserFactory

registerTermFactory

public static final void registerTermFactory(TermFactory newFactory)

Registers new TermFactory instance

Parameters:

newFactory - New TermFactory

getTermFactory

public static final TermFactory getTermFactory()

Returns TermFactory registered in step above

Returns:

TermFactory registered

registerSupportedCSS

public static final void registerSupportedCSS(SupportedCSS newCSS)

Registers new SupportedCSS instance

Parameters:

newCSS - new SupportedCSS

getSupportedCSS

public static final SupportedCSS getSupportedCSS()

Returns registered SupportedCSS

Returns:

SupportedCSS instance

registerRuleFactory

public static final void registerRuleFactory(RuleFactory newRuleFactory)

Registers new RuleFactory

Parameters:

newRuleFactory - New RuleFactory instance

getRuleFactory

public static final RuleFactory getRuleFactory()

Returns registered RuleFactory

Returns:

RuleFactory instance

registerDeclarationTransformer

public static final void registerDeclarationTransformer(DeclarationTransformer newDeclarationTransformer)

Registers new DeclarationTransformer

Parameters:

newDeclarationTransformer - New DeclarationTransformer instance

getDeclarationTransformer

public static final DeclarationTransformer getDeclarationTransformer()

Returns the registered DeclarationTransformer

Returns:

DeclarationTransformer instance

registerElementMatcher

public static final void registerElementMatcher(ElementMatcher newElementMatcher)

getElementMatcher

public static final ElementMatcher getElementMatcher()

registerDefaultMatchCondition

public static final void registerDefaultMatchCondition(MatchCondition newMatchCondition)

Registers a new default match condition to be used for matching the elements and selector parts.

Parameters:

newMatchCondition - the new match condition

getDefaultMatchCondition

public static final MatchCondition getDefaultMatchCondition()

Obtains the default match condition to be used for matching the elements and selector parts.

Returns:

the default match condition used by this factory.

registerNodeDataInstance

public static final void registerNodeDataInstance(Class<? extends NodeData> clazz)

Registers node data instance. Instance must provide no-argument Constructor

Parameters:

clazz - Instance class

createNodeData

public static final NodeData createNodeData()

Creates instance of NodeData

Returns:

Instance of NodeData

parse

public static final StyleSheet parse(URL url,
                                     String encoding)
                              throws CSSException,
                                     IOException

Parses URL into StyleSheet

Parameters:

url - URL of file to be parsed

encoding - Encoding of file

Returns:

Parsed StyleSheet

Throws:

CSSException - When exception during parse occurs

IOException - When file not found

parse

public static final StyleSheet parse(URL url,
                                     NetworkProcessor network,
                                     String encoding)
                              throws CSSException,
                                     IOException

Parses URL into StyleSheet

Parameters:

url - URL of file to be parsed

network - Network processor used for handling the URL connections

encoding - Encoding of file

Returns:

Parsed StyleSheet

Throws:

CSSException - When exception during parse occurs

IOException - When file not found

parse

public static final StyleSheet parse(String fileName,
                                     String encoding)
                              throws CSSException,
                                     IOException

Parses file into StyleSheet. Internally transforms file to URL

Parameters:

fileName - Name of file

encoding - Encoding used to parse input

Returns:

Parsed style sheet

Throws:

CSSException - In case that parsing error occurs

IOException - If file is not found or not readable

parse

@Deprecated
public static final StyleSheet parse(String css)
                                          throws IOException,
                                                 CSSException

Deprecated. This function does not specify the base URL. parseString(String, URL) should be used instead.

Parses text into StyleSheet

Parameters:

css - Text with CSS declarations

Returns:

Parsed StyleSheet

Throws:

IOException - When exception during read occurs

CSSException - When exception during parse occurs

parseString

public static final StyleSheet parseString(String css,
                                           URL base)
                                    throws IOException,
                                           CSSException

Parses text into a StyleSheet

Parameters:

css - Text with CSS declarations

base - The URL to be used as a base for loading external resources. Base URL may be null if there are no external resources in the CSS string referenced by relative URLs.

Returns:

Parsed StyleSheet

Throws:

IOException - When exception during read occurs

CSSException - When exception during parse occurs

parseString

public static final StyleSheet parseString(String css,
                                           URL base,
                                           NetworkProcessor network)
                                    throws IOException,
                                           CSSException

Parses text into a StyleSheet

Parameters:

css - Text with CSS declarations

base - The URL to be used as a base for loading external resources. Base URL may be null if there are no external resources in the CSS string referenced by relative URLs.

network - Network processor for retrieving the URL resources

Returns:

Parsed StyleSheet

Throws:

IOException - When exception during read occurs

CSSException - When exception during parse occurs

getUsedStyles

public static final StyleSheet getUsedStyles(Document doc,
                                             String encoding,
                                             URL base,
                                             MediaSpec media,
                                             NetworkProcessor network)

Loads all the style sheets used from the specified DOM tree. The following style specifications are evaluated:

• The style sheets included using the link and style tags.
• Inline styles specified using the style element attribute.
• Proprietary extension: Default styles defined using the XDefaultStyle element attribute. These styles behave the same way as the inline styles but they have the lowest priority (the values are used only when not redefined by any other way)

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Selected media for style sheet

Returns:

the rules of all the style sheets used in the document including the inline styles

getUsedStyles

public static final StyleSheet getUsedStyles(Document doc,
                                             String encoding,
                                             URL base,
                                             MediaSpec media)

This is the same as getUsedStyles(Document, String, URL, MediaSpec) with the possibility of specifying a custom network processor.

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Selected media for style sheet

Returns:

the rules of all the style sheets used in the document including the inline styles

getUsedStyles

public static final StyleSheet getUsedStyles(Document doc,
                                             String encoding,
                                             URL base,
                                             String media)

This is the same as getUsedStyles(Document, String, URL, MediaSpec) but only the media type is provided instead of the complete media specification.

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Selected media for style sheet

Returns:

the rules of all the style sheets used in the document including the inline styles

getUsedStyles

@Deprecated
public static final StyleSheet getUsedStyles(Document doc,
                                                         URL base,
                                                         String media)

Deprecated.

assignDOM

public static final StyleMap assignDOM(Document doc,
                                       String encoding,
                                       URL base,
                                       MediaSpec media,
                                       boolean useInheritance)

Goes through a DOM tree and assigns the CSS declarations to the DOM elements. The following style specifications are evaluated:

• The style sheets included using the link and style tags.
• Inline styles specified using the style element attribute.
• Proprietary extension: Default styles defined using the XDefaultStyle element attribute. These styles behave the same way as the inline styles but they have the lowest priority (the values are used only when not redefined by any other way)

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Current media specification used for evaluating the media queries

useInheritance - Whether inheritance will be used to determine values

Returns:

Map between DOM element nodes and data structure containing CSS information

assignDOM

public static final StyleMap assignDOM(Document doc,
                                       String encoding,
                                       URL base,
                                       String media,
                                       boolean useInheritance)

This is the same as assignDOM(Document, String, URL, MediaSpec, boolean) but only the media type is provided instead of the complete media specification.

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Selected media type for style sheet

useInheritance - Whether inheritance will be used to determine values

Returns:

Map between DOM element nodes and data structure containing CSS information

assignDOM

public static final StyleMap assignDOM(Document doc,
                                       String encoding,
                                       URL base,
                                       MediaSpec media,
                                       boolean useInheritance,
                                       MatchCondition matchCond)

Goes through a DOM tree and assigns the CSS declarations to the DOM elements. The following style specifications are evaluated:

• The style sheets included using the link and style tags.
• Inline styles specified using the style element attribute.
• Proprietary extension: Default styles defined using the XDefaultStyle element attribute. These styles behave the same way as the inline styles but they have the lowest priority (the values are used only when not redefined by any other way)

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Current media specification used for evaluating the media queries

useInheritance - Whether inheritance will be used to determine values

matchCond - The match condition to match the against.

Returns:

Map between DOM element nodes and data structure containing CSS information

assignDOM

public static final StyleMap assignDOM(Document doc,
                                       String encoding,
                                       NetworkProcessor network,
                                       URL base,
                                       MediaSpec media,
                                       boolean useInheritance,
                                       MatchCondition matchCond)

This is the same as assignDOM(Document, String, URL, MediaSpec, boolean) with the possibility of specifying a custom network processor for obtaining data from URL resources.

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

network - Custom network processor

base - Base URL against which all files are searched

media - Current media specification used for evaluating the media queries

useInheritance - Whether inheritance will be used to determine values

matchCond - The match condition to match the against.

Returns:

Map between DOM element nodes and data structure containing CSS information

assignDOM

public static final StyleMap assignDOM(Document doc,
                                       String encoding,
                                       URL base,
                                       String media,
                                       boolean useInheritance,
                                       MatchCondition matchCond)

This is the same as assignDOM(Document, String, URL, MediaSpec, boolean) but only the media type is provided instead of the complete media specification.

Parameters:

doc - DOM tree

encoding - The default encoding used for the referenced style sheets

base - Base URL against which all files are searched

media - Selected media type for style sheet

useInheritance - Whether inheritance will be used to determine values

matchCond - The match condition to match the against.

Returns:

Map between DOM element nodes and data structure containing CSS information

assignDOM

@Deprecated
public static final StyleMap assignDOM(Document doc,
                                                   URL base,
                                                   String media,
                                                   boolean useInheritance)

Deprecated.