senselogic.sitevision.api.webresource.doctype

Interface DocTypeUtil

@Requireable(value="DocTypeUtil")
public interface DocTypeUtil

A utility interface for checking what DOCTYPE a page uses.

An instance of the SiteVision class implementing this interface can be obtained via Utils.getDocTypeUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

SiteVision 3.0

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
DocType	getDocType() Gets the doctype for current page.
DocType	getDocType(Node aPageNode) Gets the doctype for a certain page.
boolean	isDocType(DocType aDocType) Checks if the doctype for current page matches a certain DocType.
boolean	isDocType(Node aPageNode, DocType aDocType) Checks if the doctype for a certain page matches a certain DocType.
boolean	isHtml() Checks if the doctype for current page is HTML 4.01 Transitional or HTML5.
boolean	isHtml(Node aPageNode) Checks if the doctype for a certain page is HTML 4.01 Transitional or HTML5.
boolean	isHtml4() Checks if the doctype for current page is HTML 4.01 Transitional.
boolean	isHtml4(Node aPageNode) Checks if the doctype for a certain page is HTML 4.01 Transitional.
boolean	isHtml5() Checks if the doctype for current page is HTML5.
boolean	isHtml5(Node aPageNode) Checks if the doctype for a certain page is HTML5.
boolean	isXhtml() Checks if the doctype for current page is XHTML 1.0 Transitional or XHTML 1.0 Strict.
boolean	isXhtml(Node aPageNode) Checks if the doctype for a certain page is XHTML 1.0 Transitional or XHTML 1.0 Strict.
boolean	isXhtmlStrict() Checks if the doctype for current page is XHTML 1.0 Strict.
boolean	isXhtmlStrict(Node aPageNode) Checks if the doctype for a certain page is XHTML 1.0 Strict.
boolean	isXhtmlTransitional() Checks if the doctype for current page is XHTML 1.0 Transitional.
boolean	isXhtmlTransitional(Node aPageNode) Checks if the doctype for a certain page is XHTML 1.0 Transitional.

Method Detail

isHtml

boolean isHtml()

Checks if the doctype for current page is HTML 4.01 Transitional or HTML5.

Returns:

true if current page is HTML 4.01 Transitional or HTML5, false otherwise

See Also:

DocType.HTML4_TRANSITIONAL, DocType.HTML5

isHtml

boolean isHtml(Node aPageNode)

Checks if the doctype for a certain page is HTML 4.01 Transitional or HTML5.

Parameters:

aPageNode - the page tree node to check

Returns:

true if aPageNode is HTML 4.01 Transitional or HTML5, false otherwise

See Also:

DocType.HTML4_TRANSITIONAL, DocType.HTML5

isHtml4

boolean isHtml4()

Checks if the doctype for current page is HTML 4.01 Transitional.

Returns:

true if current page is HTML 4.01 Transitional, false otherwise

See Also:

DocType.HTML4_TRANSITIONAL

isHtml4

boolean isHtml4(Node aPageNode)

Checks if the doctype for a certain page is HTML 4.01 Transitional.

Parameters:

aPageNode - the page tree node to check

Returns:

true if aPageNode is HTML 4.01 Transitional, false otherwise

See Also:

DocType.HTML4_TRANSITIONAL

isHtml5

boolean isHtml5()

Checks if the doctype for current page is HTML5.

Returns:

true if current page is HTML5, false otherwise

See Also:

DocType.HTML5

isHtml5

boolean isHtml5(Node aPageNode)

Checks if the doctype for a certain page is HTML5.

Parameters:

aPageNode - the page tree node to check

Returns:

true if aPageNode is HTML5, false otherwise

See Also:

DocType.HTML5

isXhtml

boolean isXhtml()

Checks if the doctype for current page is XHTML 1.0 Transitional or XHTML 1.0 Strict.

Returns:

true if current page is XHTML 1.0 Transitional or XHTML 1.0 Strict, false otherwise

See Also:

DocType.XHTML1_TRANSITIONAL, DocType.XHTML1_STRICT

isXhtml

boolean isXhtml(Node aPageNode)

Checks if the doctype for a certain page is XHTML 1.0 Transitional or XHTML 1.0 Strict.

Parameters:

aPageNode - the page tree node to check

Returns:

true if aPageNode is XHTML 1.0 Transitional or XHTML 1.0 Strict, false otherwise

See Also:

DocType.XHTML1_TRANSITIONAL, DocType.XHTML1_STRICT

isXhtmlTransitional

boolean isXhtmlTransitional()

Checks if the doctype for current page is XHTML 1.0 Transitional.

Returns:

true if current page is XHTML 1.0 Transitional, false otherwise

See Also:

DocType.XHTML1_TRANSITIONAL

isXhtmlTransitional

boolean isXhtmlTransitional(Node aPageNode)

Checks if the doctype for a certain page is XHTML 1.0 Transitional.

Parameters:

aPageNode - the page tree node to check

Returns:

true if aPageNode is XHTML 1.0 Transitional, false otherwise

See Also:

DocType.XHTML1_TRANSITIONAL

isXhtmlStrict

boolean isXhtmlStrict()

Checks if the doctype for current page is XHTML 1.0 Strict.

Returns:

true if current page is XHTML 1.0 Strict, false otherwise

See Also:

DocType.XHTML1_STRICT

isXhtmlStrict

boolean isXhtmlStrict(Node aPageNode)

Checks if the doctype for a certain page is XHTML 1.0 Strict.

Parameters:

aPageNode - the page tree node to check

Returns:

true if aPageNode is XHTML 1.0 Strict, false otherwise

See Also:

DocType.XHTML1_STRICT

getDocType

DocType getDocType()

Gets the doctype for current page.

Returns:

the doctype for current page

getDocType

DocType getDocType(Node aPageNode)

Gets the doctype for a certain page.

Parameters:

aPageNode - the page tree node to get doctype for

Returns:

the doctype for aPageNode

isDocType

boolean isDocType(DocType aDocType)

Checks if the doctype for current page matches a certain DocType.

Parameters:

aDocType - the doctype to check against

Returns:

true if the doctype for current page matches aDocType, false otherwise

isDocType

boolean isDocType(Node aPageNode,
                  DocType aDocType)

Checks if the doctype for a certain page matches a certain DocType.

Parameters:

aPageNode - the page tree node to check

aDocType - the doctype to check against

Returns:

true if the doctype for aPageNode matches aDocType, false otherwise