A C D E F G H I N P R S T U V W

A

addClass(String, String, List<String>, int) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Adds given class names to the elements in HTML.

addClass(String, String, List<String>) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Adds given class names to the elements in HTML.

addClass(String, String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Adds given class to the elements in HTML.

C

concat(List<String>, String, boolean) - Static method in class pl.matsuo.maven.skins.msb3.HtmlTool

Utility method to concatenate a String to a list of Strings.

configure(ValueParser) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

configure(ValueParser) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

D

DEFAULT_KEY - Static variable in class pl.matsuo.maven.skins.msb3.SkinConfigTool

E

ensureHeadingIds(String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Transforms the given HTML content by adding IDs to all heading elements (h1-6) that do not have one.

extract(String, String, int) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Extracts HTML elements from the main HTML content.

F

fixTableHeads(String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Fixes table heads: wraps rows with <th> (table heading) elements into <thead> element if they are currently in <tbody>.

G

get(String) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

Default accessor for config properties.

getAttr(String, String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Retrieves attribute value on elements in HTML.

getExtracted() - Method in interface pl.matsuo.maven.skins.msb3.HtmlTool.ExtractResult

Retrieves the extracted HTML elements.

getFileId() - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

getId() - Method in interface pl.matsuo.maven.skins.msb3.HtmlTool.IdElement

Retrieves the ID of the HTML element (attribute id)

getItems() - Method in interface pl.matsuo.maven.skins.msb3.HtmlTool.IdElement

Retrieves the children of the HTML element (nested within the element)

getKey() - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

Should return the key under which this tool has been configured.

getProjectId() - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

getRemainder() - Method in interface pl.matsuo.maven.skins.msb3.HtmlTool.ExtractResult

Retrieves the content from which elements were extracted.

getText() - Method in interface pl.matsuo.maven.skins.msb3.HtmlTool.IdElement

Retrieves the text contents of the HTML element (rendered for display)

H

headingAnchorToId(String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Transforms the given HTML content by moving anchor (<a name="myheading">) names to IDs for heading elements.

headingTree(String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Reads all headings in the given HTML content as a hierarchy.

HtmlTool - Class in pl.matsuo.maven.skins.msb3

An Apache Velocity tool that provides utility methods to manipulate HTML code using jsoup HTML5 parser.

HtmlTool() - Constructor for class pl.matsuo.maven.skins.msb3.HtmlTool

HtmlTool.ExtractResult - Interface in pl.matsuo.maven.skins.msb3

A container to carry element extraction results.

HtmlTool.IdElement - Interface in pl.matsuo.maven.skins.msb3

Representation of a HTML element with ID and a text content.

HtmlTool.JoinSeparator - Enum in pl.matsuo.maven.skins.msb3

Enum indicating separator handling strategy for document partitioning.

I

is(String) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

A convenience method to check if the value of the property is "true".

isValue(String, String) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

A convenience method to check if the property is set to a specific value.

N

not(String) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

A convenience method to check if the value of the property is "false".

P

parseBodyFragment(String) - Static method in class pl.matsuo.maven.skins.msb3.HtmlTool

A generic method to use jsoup parser on an arbitrary HTML body fragment.

pl.matsuo.maven.skins.msb3 - package pl.matsuo.maven.skins.msb3

R

relativizeLink(String, String) - Static method in class pl.matsuo.maven.skins.msb3.URITool

Resolves the link as relative to the base dir URI.

remove(String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Removes elements from HTML.

reorderToTop(String, String, int) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Reorders elements in HTML content so that selected elements are found at the top of the content.

reorderToTop(String, String, int, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Reorders elements in HTML content so that selected elements are found at the top of the content.

replace(String, String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Replaces elements in HTML.

replaceAll(String, Map<String, String>) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Replaces elements in HTML.

S

setAttr(String, String, String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Sets attribute to the given value on elements in HTML.

setKey(String) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

Sets the key under which this tool has been configured.

SKIN_KEY - Static variable in class pl.matsuo.maven.skins.msb3.SkinConfigTool

By default use Msb3 skin configuration tag

SkinConfigTool - Class in pl.matsuo.maven.skins.msb3

An Apache Velocity tool that simplifies retrieval of custom configuration values for a Maven Site.

SkinConfigTool() - Constructor for class pl.matsuo.maven.skins.msb3.SkinConfigTool

slug(String, String) - Static method in class pl.matsuo.maven.skins.msb3.HtmlTool

Creates a slug (latin text with no whitespace or other symbols) for a longer text (i.e. to use in URLs).

slug(String) - Static method in class pl.matsuo.maven.skins.msb3.HtmlTool

Creates a slug (latin text with no whitespace or other symbols) for a longer text (i.e. to use in URLs).

split(String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Splits the given HTML content into partitions based on the given separator selector.

split(String, String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Splits the given HTML content into partitions based on the given separator selector.

split(String, String, HtmlTool.JoinSeparator) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Splits the given HTML content into partitions based on the given separator selector.The separators are either dropped or joined with before/after depending on the indicated separator strategy.

splitOnStarts(String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Splits the given HTML content into partitions based on the given separator selector.

T

text(String, String) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Retrieves text content of the selected elements in HTML.

toURI(String) - Static method in class pl.matsuo.maven.skins.msb3.URITool

U

URITool - Class in pl.matsuo.maven.skins.msb3

An Apache Velocity tool that provides utility methods to work with URIs/URLs and links.

URITool() - Constructor for class pl.matsuo.maven.skins.msb3.URITool

V

value(String) - Method in class pl.matsuo.maven.skins.msb3.SkinConfigTool

Retrieves the text value of the given property, e.g. as in <myprop>value</myprop>.

valueOf(String) - Static method in enum pl.matsuo.maven.skins.msb3.HtmlTool.JoinSeparator

Returns the enum constant of this type with the specified name.

values() - Static method in enum pl.matsuo.maven.skins.msb3.HtmlTool.JoinSeparator

Returns an array containing the constants of this enum type, in the order they are declared.

W

wrap(String, String, String, int) - Method in class pl.matsuo.maven.skins.msb3.HtmlTool

Wraps elements in HTML with the given HTML.

A C D E F G H I N P R S T U V W