A B C D E F G H I L M N O P R S T U V W X

A

addAttribute(Attribute) - Method in class org.devacfr.maven.skins.reflow.snippet.Component

addAttributes(Attributes) - Method in class org.devacfr.maven.skins.reflow.snippet.Component

addChild(Component<?>) - Method in class org.devacfr.maven.skins.reflow.snippet.Component

addChildren(Component...) - Method in class org.devacfr.maven.skins.reflow.model.Component

Add components to this component.

addClass(String, String, List<String>, int) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Adds given class names to the elements in HTML.

addClass(String, String, List<String>) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Adds given class names to the elements in HTML.

addClass(String, String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Adds given class to the elements in HTML.

addCssOptions(String...) - Method in class org.devacfr.maven.skins.reflow.model.Component

Add cssOption to this component.

addResourcePath(String) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

appendChildrenToHtml(Node, Appendable) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor

Append child Node in html rendering.

appendChildrenToHtml(Node, Appendable) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor.ShortcodeProcessor

appendChildrenToHtml(Node, Appendable) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor.WebComponentProcessor

Append child Node in html rendering.

B

BodyContext - Class in org.devacfr.maven.skins.reflow.context

BodyContext(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.context.BodyContext

Default constructor.

BsComponent - Class in org.devacfr.maven.skins.reflow.model

Describe a Bootstrap component.

BsComponent(String) - Constructor for class org.devacfr.maven.skins.reflow.model.BsComponent

Default constructor.

buildContext(ISkinConfig) - Static method in class org.devacfr.maven.skins.reflow.context.Context

Build a context depending of current type of page.

C

collect(Element) - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

Collects all (start,end,empty) Element corresponding to a snippet component.

collect(Element, Pattern) - Static method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

Column(ISkinConfig, List<Menu>) - Constructor for class org.devacfr.maven.skins.reflow.model.Footer.Column

Component - Class in org.devacfr.maven.skins.reflow.model

The abstract class of all component used in Reflow rendering.

Component() - Constructor for class org.devacfr.maven.skins.reflow.model.Component

COMPONENT - Static variable in class org.devacfr.maven.skins.reflow.model.Navbar

COMPONENT - Static variable in class org.devacfr.maven.skins.reflow.model.Toc

Component<T extends Component<T>> - Class in org.devacfr.maven.skins.reflow.snippet

Base of Snippet component.

Component(Node) - Constructor for class org.devacfr.maven.skins.reflow.snippet.Component

ComponentResolver - Class in org.devacfr.maven.skins.reflow.snippet

Resolve the type and tag type of component.

ComponentResolver() - Constructor for class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

Default constructor

Components - Class in org.devacfr.maven.skins.reflow.snippet

Components() - Constructor for class org.devacfr.maven.skins.reflow.snippet.Components

ComponentToken - Class in org.devacfr.maven.skins.reflow.snippet

ComponentToken(Element, String, ComponentToken.Tag, ComponentToken.Type) - Constructor for class org.devacfr.maven.skins.reflow.snippet.ComponentToken

ComponentToken.Tag - Enum in org.devacfr.maven.skins.reflow.snippet

ComponentToken.Type - Enum in org.devacfr.maven.skins.reflow.snippet

type of snippet component

concat(List<String>, String, boolean) - Static method in class org.devacfr.maven.skins.reflow.HtmlTool

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

configure(ValueParser) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

configure(ValueParser) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Context<T extends Context<?>> - Class in org.devacfr.maven.skins.reflow.context

The base class of all contexts depending type of page.

Context(ISkinConfig, ContextType) - Constructor for class org.devacfr.maven.skins.reflow.context.Context

Default constructor.

ContextType - Enum in org.devacfr.maven.skins.reflow.context

Type of context depending of type of page.

contextualize(Context) - Method in class org.devacfr.maven.skins.reflow.snippet.PartialTemplateMacro

convertElementToHtml(Element) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor

Converts the snippet element to html format.

convertToHtml(ComponentToken, ComponentToken) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor

Convert the snippet to html.

create(Element) - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

Create a ComponentToken corresponding to the element.

createChildParser() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

createComponent(Node, Component<?>) - Static method in class org.devacfr.maven.skins.reflow.snippet.Component

createSidebar(ISkinConfig) - Static method in class org.devacfr.maven.skins.reflow.model.Toc

createSnippet(Element, Component<?>, ComponentToken.Type) - Static method in class org.devacfr.maven.skins.reflow.snippet.SnippetComponent

createSnippetComponent(ComponentToken, ComponentToken) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor

Create a SnippetComponent.

createToc(ISkinConfig, String) - Static method in class org.devacfr.maven.skins.reflow.model.Toc

createToolManaged() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

createTopBar(ISkinConfig) - Static method in class org.devacfr.maven.skins.reflow.model.Toc

createURLRebaser(String, String) - Static method in class org.devacfr.maven.skins.reflow.URITool

createVelocityContext() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

Creates a Velocity Context with all generic tools configured wit the site rendering context.

currentToken() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

D

DEFAULT_KEY - Static variable in class org.devacfr.maven.skins.reflow.SkinConfigTool

DEFAULT_SLUG_SEPARATOR - Static variable in class org.devacfr.maven.skins.reflow.HtmlTool

Default separator using to generate slug heading name.

document() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

DocumentContext - Class in org.devacfr.maven.skins.reflow.context

The context associate to page of doc page.

DocumentContext(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.context.DocumentContext

Default constructor.

E

empty() - Static method in class org.devacfr.maven.skins.reflow.snippet.Components

ensureHeadingIds(String, String, String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

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

eval(String, Class<T>) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Evaluate a velocity expression in the current context.

eval(String, Class<T>) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Evaluate a velocity expression in the current context.

execute(Sink, MacroRequest) - Method in class org.devacfr.maven.skins.reflow.snippet.PartialTemplateMacro

extract(String, String, int) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Extracts HTML elements from the main HTML content.

extractAttributes(String) - Static method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

F

findAllSideNavMenuItems(ISkinConfig) - Static method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Find all sidenav menu items declared in all document pages.

first() - Method in class org.devacfr.maven.skins.reflow.snippet.Components

Get the first matched element.

fixTableHeads(String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

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

Footer - Class in org.devacfr.maven.skins.reflow.model

Represents the footer component.

Footer(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.Footer

Default constructor.

Footer.Column - Class in org.devacfr.maven.skins.reflow.model

FrameContext - Class in org.devacfr.maven.skins.reflow.context

The context associate to page of frame page.

FrameContext(ISkinConfig, String) - Constructor for class org.devacfr.maven.skins.reflow.context.FrameContext

G

generateSnippetIdentifier() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

get(String) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Default accessor for config properties.

get(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Default accessor for config properties.

get(String) - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getAdditionalMenu() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getAlignMenu() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getAttr(String, String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Retrieves attribute value on elements in HTML.

getAttributeValue(String, String, Class<T>, T) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Gets the attribute value of the given attribute of property.

getAttributeValue(Xpp3Dom, String, Class<T>, T) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Get the value contained in specific attribute of element parameter.

getAttributeValue(String, String, Class<T>, T) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the attribute value of the given attribute of property.

getAttributeValue(Xpp3Dom, String, Class<T>, T) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Get the value contained in specific attribute of element parameter.

getAttrs() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getBackground() - Method in class org.devacfr.maven.skins.reflow.model.BsComponent

getBodyContent(ISkinConfig) - Method in class org.devacfr.maven.skins.reflow.model.Component

getBrandHref() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getBrandName() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getBuildOutputTimestamp() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the reproduce build timestamp whether property 'project.build.outputTimestamp' is fill in.

getChildren(Xpp3Dom) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the list of all children name for the parentNode.

getChildren() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getChildren(String) - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getChildren(Xpp3Dom) - Static method in class org.devacfr.maven.skins.reflow.Xpp3Utils

Gets the list of all children name for the parentNode.

getChildrenNodes(Xpp3Dom, String) - Static method in class org.devacfr.maven.skins.reflow.Xpp3Utils

Gets children list filtered by name of parentNode.

getColumns() - Method in class org.devacfr.maven.skins.reflow.model.Footer

getComponents() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

getConfig() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

getContent() - Method in class org.devacfr.maven.skins.reflow.model.Header

getContext() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getContext() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getContextValue(String, Class<T>) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Gets the associated value to key stored in Velocity context.

getContextValue(String, Class<T>) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the associated value to key stored in Velocity context.

getCssClass() - Method in class org.devacfr.maven.skins.reflow.model.BsComponent

getCssClass() - Method in class org.devacfr.maven.skins.reflow.model.Component

getCssOptions() - Method in class org.devacfr.maven.skins.reflow.model.Component

Gets the css options associated to component.

getCurrentFileLocation() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getCurrentFileName() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

See Doxia Sitetools - Site Renderer for more information.

getDocumentParent() - Method in class org.devacfr.maven.skins.reflow.context.FrameContext

getElement() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getElement() - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentToken

getExtracted() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.ExtractResult

Retrieves the extracted HTML elements.

getFileId() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getFileId() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getFilterMenu() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getFirstChild(Xpp3Dom, String, String) - Static method in class org.devacfr.maven.skins.reflow.Xpp3Utils

Retrieves the child node.

getFooter() - Method in class org.devacfr.maven.skins.reflow.context.Context

getGlobalProperties() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getGlobalProperties() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getHeader() - Method in class org.devacfr.maven.skins.reflow.context.PageContext

Gets the header of page.

getHeadingLevel() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.IdElement

getHeight() - Method in class org.devacfr.maven.skins.reflow.model.Navbar.ImageBrand

getHref() - Method in class org.devacfr.maven.skins.reflow.model.Menu

getHref() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

getHref() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

getHtml() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getHtmlTool(ISkinConfig) - Method in class org.devacfr.maven.skins.reflow.model.Component

Gets the tool HtmlTool.

getIcon() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

getId() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.IdElement

Retrieves the ID of the HTML element (attribute id).

getImage() - Method in class org.devacfr.maven.skins.reflow.model.Menu

getImage() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

getImage() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getInherit() - Method in class org.devacfr.maven.skins.reflow.model.Menu

getInherit() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

getItems() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.IdElement

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

getItems() - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

getItems() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

Gets the list of items.

getKey() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getLevel() - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

getMenuItems() - Method in class org.devacfr.maven.skins.reflow.model.Menu

getMenuItems() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

getMenus() - Method in class org.devacfr.maven.skins.reflow.model.Footer.Column

getMenus() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

getName() - Method in class org.devacfr.maven.skins.reflow.model.Menu

getName() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

getName() - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Gets the name of menu displayed on top of navside menu.

getName() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

getName() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getNamespace() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getNamespace() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getNavbar() - Method in class org.devacfr.maven.skins.reflow.context.Context

getNavSideMenu() - Method in class org.devacfr.maven.skins.reflow.context.DocumentContext

getNewPath() - Method in class org.devacfr.maven.skins.reflow.URITool.URLRebaser

Get the new path.

getNumberItems() - Method in class org.devacfr.maven.skins.reflow.model.TocTopBar

getOldPath() - Method in class org.devacfr.maven.skins.reflow.URITool.URLRebaser

Get the old path.

getOwnHtml() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getPageProperties() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getPageProperties() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getParent() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

getParent() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getParser() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

getProject() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getProject() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getProjectId() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getProjectId() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getProjectLocation() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getPropertyValue(String, Class<T>, T) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Gets the text value of the given property.

getPropertyValue(String, Class<T>, T) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the text value of the given property.

getRemainder() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.ExtractResult

Retrieves the content from which elements were extracted.

getResourcePath() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getResourcePath() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getRootParent() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

getRootParent() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetComponent

getScrollTop() - Method in class org.devacfr.maven.skins.reflow.context.Context

getSiteModel() - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

getSiteModel() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getSlugDocumentParent() - Method in class org.devacfr.maven.skins.reflow.context.FrameContext

getSlugName() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

getSnippetContext() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

getSnippetPaths() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

getSrc() - Method in class org.devacfr.maven.skins.reflow.model.Navbar.ImageBrand

getTagName() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.IdElement

getTarget() - Method in class org.devacfr.maven.skins.reflow.model.Menu

getTarget() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

getText() - Method in interface org.devacfr.maven.skins.reflow.HtmlTool.IdElement

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

getTheme() - Method in class org.devacfr.maven.skins.reflow.model.BsComponent

getToc() - Method in class org.devacfr.maven.skins.reflow.context.FrameContext

getToc() - Method in class org.devacfr.maven.skins.reflow.context.PageContext

getTocItems(ISkinConfig) - Method in class org.devacfr.maven.skins.reflow.model.Toc

getToolbox(String, Class<T>) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Gets the associated tool to name stored in toolbox of Velocity context.

getToolbox(String, Class<T>) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the associated tool to name stored in toolbox of Velocity context.

getType() - Method in class org.devacfr.maven.skins.reflow.context.Context

getType() - Method in class org.devacfr.maven.skins.reflow.model.Header

Gets the type of header.

getType() - Method in class org.devacfr.maven.skins.reflow.model.Toc

getType() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetComponent

getVelocityContext() - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

getWidth() - Method in class org.devacfr.maven.skins.reflow.model.Navbar.ImageBrand

H

hasIncludedSnippetComponent(Element) - Static method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

Header - Class in org.devacfr.maven.skins.reflow.model

Represents the header component.

Header(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.Header

Default constructor.

headingAnchorToId(String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

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

headingTree(String, List<String>) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

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

html() - Method in class org.devacfr.maven.skins.reflow.snippet.Components

html() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

HtmlTool - Class in org.devacfr.maven.skins.reflow

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

HtmlTool() - Constructor for class org.devacfr.maven.skins.reflow.HtmlTool

HtmlTool.ExtractResult - Interface in org.devacfr.maven.skins.reflow

A container to carry element extraction results.

HtmlTool.IdElement - Interface in org.devacfr.maven.skins.reflow

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

HtmlTool.JoinSeparator - Enum in org.devacfr.maven.skins.reflow

Enum indicating separator handling strategy for document partitioning.

I

initialize(ISkinConfig) - Method in class org.devacfr.maven.skins.reflow.context.BodyContext

initialize(ISkinConfig) - Method in class org.devacfr.maven.skins.reflow.context.Context

Allows to initialize the context.

insertResourcePath(String, int) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

is(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

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

isActive() - Method in class org.devacfr.maven.skins.reflow.model.Menu

isActive() - Method in class org.devacfr.maven.skins.reflow.model.MenuItem

isActiveLink(String) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Gets the indicating if the link is active.

isActiveLink(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Gets the indicating if the link is active.

isAutoExpandable() - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Gets the indicating whether is auto-expanded.

isCenter() - Method in class org.devacfr.maven.skins.reflow.model.Navbar

isCloseTagOf(ComponentToken) - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentToken

isEnabled() - Method in class org.devacfr.maven.skins.reflow.model.Header

Gets the indicating whether the header is displayed.

isEnabled() - Method in class org.devacfr.maven.skins.reflow.model.Toc

Gets the indicating whether is enable.

isExpanded() - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Gets the indicating whether is expanded.

isExternalLink(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

isFixed() - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Gets the indicating whether is fixed.

isFlatten() - Method in class org.devacfr.maven.skins.reflow.model.TocTopBar

Gets the indicating whether is flatten.

isHasItems() - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Gets the indicating whether menu contains a least one menu item.

isHasItems() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

Gets the indicating whether has items.

isHtmlTag() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

ISkinConfig - Interface in org.devacfr.maven.skins.reflow

Interface of skin config.

isSelectFirstOnExpand() - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Gets the indicating whether the first sub menu item should be selected when a dropdown menu item is selected and should expand.

isSmooth() - Method in class org.devacfr.maven.skins.reflow.model.ScrollTop

Gets the indicating whether the scrolling is smooth.

isSnippet(Node) - Static method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

isValue(String, String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

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

L

last() - Method in class org.devacfr.maven.skins.reflow.snippet.Components

Get the last matched component.

M

matches(String, Menu) - Static method in class org.devacfr.maven.skins.reflow.model.Menu

Gets indicating whether menu by their ref or name, and returns the matching results.

Menu - Class in org.devacfr.maven.skins.reflow.model

Menu(ISkinConfig, LinkItem) - Constructor for class org.devacfr.maven.skins.reflow.model.Menu

Initialize with LinkItem.

Menu(ISkinConfig, Menu) - Constructor for class org.devacfr.maven.skins.reflow.model.Menu

Initialize with Menu.

MenuItem - Class in org.devacfr.maven.skins.reflow.model

MenuItem(ISkinConfig, MenuItem) - Constructor for class org.devacfr.maven.skins.reflow.model.MenuItem

Initialize with MenuItem.

mergeTemplate(SnippetComponent<?>, Writer) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

N

name() - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentToken

Navbar - Class in org.devacfr.maven.skins.reflow.model

Represents the navbar component.

Navbar(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.Navbar

Default constructor.

Navbar.ImageBrand - Class in org.devacfr.maven.skins.reflow.model

NavSideMenu - Class in org.devacfr.maven.skins.reflow.model

Represents the navside menu component used in document page.

NavSideMenu(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.NavSideMenu

Default constructor.

normalisedBaseUrl(String) - Static method in class org.devacfr.maven.skins.reflow.URITool

remove url path separator ('/') to the end of path.

normaliseWhitespace(String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Normalise the whitespace within this string; multiple spaces collapse to a single, and all whitespace characters (e.g. newline, tab) convert to a simple space

normalize(Document) - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentResolver

Normalise the Document to enclose inline snippet in html element.

not(String) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

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

not(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

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

O

onPreRender(ISkinConfig, String) - Method in class org.devacfr.maven.skins.reflow.context.BodyContext

onPreRender(ISkinConfig, String) - Method in class org.devacfr.maven.skins.reflow.context.Context

onPreRender(ISkinConfig, String) - Method in class org.devacfr.maven.skins.reflow.model.Component

generic pre-rendering method executed on all components of context.

onPreRender(ISkinConfig, String) - Method in class org.devacfr.maven.skins.reflow.model.Toc

org.devacfr.maven.skins.reflow - package org.devacfr.maven.skins.reflow

org.devacfr.maven.skins.reflow.context - package org.devacfr.maven.skins.reflow.context

org.devacfr.maven.skins.reflow.model - package org.devacfr.maven.skins.reflow.model

org.devacfr.maven.skins.reflow.snippet - package org.devacfr.maven.skins.reflow.snippet

P

PageContext - Class in org.devacfr.maven.skins.reflow.context

PageContext(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.context.PageContext

Default constructor.

parse(String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Parses body fragment to the <body> element.

parse(ComponentToken) - Method in class org.devacfr.maven.skins.reflow.snippet.Processor

Specific parsing for each ComponentToken.

parse(ISkinConfig, String) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

parse() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

parse(ComponentToken) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

parser - Variable in class org.devacfr.maven.skins.reflow.snippet.Processor

PartialTemplateMacro - Class in org.devacfr.maven.skins.reflow.snippet

PartialTemplateMacro() - Constructor for class org.devacfr.maven.skins.reflow.snippet.PartialTemplateMacro

pop() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

preRender(ISkinConfig) - Method in class org.devacfr.maven.skins.reflow.context.Context

Allows to execute action before rendering of component.

Processor - Class in org.devacfr.maven.skins.reflow.snippet

Specific process for each type of snippet component.

Processor(SnippetParser) - Constructor for class org.devacfr.maven.skins.reflow.snippet.Processor

Default constructor

Processor.ShortcodeProcessor - Class in org.devacfr.maven.skins.reflow.snippet

Specific process for snippet shortcode component.

Processor.WebComponentProcessor - Class in org.devacfr.maven.skins.reflow.snippet

Specific process for snippet web component.

push(ComponentToken) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetParser

R

rebaseLink(String) - Method in class org.devacfr.maven.skins.reflow.URITool.URLRebaser

Rebase only affects relative links, a relative link wrt an old base gets translated, so it points to the same location as viewed from a new base.

relativeLink(String) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

relativeLink(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

relativizeLink(String, String) - Static method in class org.devacfr.maven.skins.reflow.URITool

Resolves the link as relative to the base dir URI.

remove(String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Removes elements from HTML.

render(SnippetContext) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetComponent

Render the SnippetComponent between the startElement and endElement include.

render(SnippetComponent<?>) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

renderComponent(SnippetComponent<?>) - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

renderSnippets(ISkinConfig, String) - Method in class org.devacfr.maven.skins.reflow.context.Context

reorderToTop(String, String, int) - Method in class org.devacfr.maven.skins.reflow.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 org.devacfr.maven.skins.reflow.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 org.devacfr.maven.skins.reflow.HtmlTool

Replaces elements in HTML.

replaceAll(String, Map<String, String>) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Replaces elements in HTML.

replaceWith(String, String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Replaces All elements in HTML corresponding to selector while preserving the content of this element.

reset() - Method in class org.devacfr.maven.skins.reflow.snippet.SnippetContext

S

ScrollTop - Class in org.devacfr.maven.skins.reflow.model

Represents the scoll top component.

ScrollTop(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.ScrollTop

Default constructor.

self() - Method in class org.devacfr.maven.skins.reflow.context.Context

self() - Method in class org.devacfr.maven.skins.reflow.model.Toc

self() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

setAttr(String, String, String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Sets attribute to the given value on elements in HTML.

setBackground(String) - Method in class org.devacfr.maven.skins.reflow.model.BsComponent

setContextValue(String, Object) - Method in interface org.devacfr.maven.skins.reflow.ISkinConfig

Sets the value in Velocity context associated to key.

setContextValue(String, Object) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Sets the value in Velocity context associated to key.

setCssClass(String) - Method in class org.devacfr.maven.skins.reflow.model.Component

setKey(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Sets the key under which this tool has been configured.

setTheme(String) - Method in class org.devacfr.maven.skins.reflow.model.BsComponent

ShortcodeProcessor(SnippetParser) - Constructor for class org.devacfr.maven.skins.reflow.snippet.Processor.ShortcodeProcessor

Default constructor

SideNavMenuItem - Class in org.devacfr.maven.skins.reflow.model

SideNavMenuItem() - Constructor for class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

Default constructor.

SKIN_KEY - Static variable in class org.devacfr.maven.skins.reflow.SkinConfigTool

By default use Reflow skin configuration tag.

SkinConfigTool - Class in org.devacfr.maven.skins.reflow

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

SkinConfigTool() - Constructor for class org.devacfr.maven.skins.reflow.SkinConfigTool

slug(String) - Static method in class org.devacfr.maven.skins.reflow.HtmlTool

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

slugFilename(String) - Static method in class org.devacfr.maven.skins.reflow.SkinConfigTool

Converts a filename to pageId format.

SnippetComponent<T extends SnippetComponent<T>> - Class in org.devacfr.maven.skins.reflow.snippet

SnippetComponent(Element, ComponentToken.Type) - Constructor for class org.devacfr.maven.skins.reflow.snippet.SnippetComponent

SnippetContext - Class in org.devacfr.maven.skins.reflow.snippet

SnippetContext(SnippetParser) - Constructor for class org.devacfr.maven.skins.reflow.snippet.SnippetContext

SnippetParseException - Exception in org.devacfr.maven.skins.reflow.snippet

SnippetParseException(String) - Constructor for exception org.devacfr.maven.skins.reflow.snippet.SnippetParseException

SnippetParseException(String, Throwable) - Constructor for exception org.devacfr.maven.skins.reflow.snippet.SnippetParseException

SnippetParseException(String, Throwable, boolean, boolean) - Constructor for exception org.devacfr.maven.skins.reflow.snippet.SnippetParseException

SnippetParser - Class in org.devacfr.maven.skins.reflow.snippet

SnippetParser() - Constructor for class org.devacfr.maven.skins.reflow.snippet.SnippetParser

split(String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

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

split(String, String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

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

split(String, String, HtmlTool.JoinSeparator) - Method in class org.devacfr.maven.skins.reflow.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 org.devacfr.maven.skins.reflow.HtmlTool

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

T

tag() - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentToken

text(String, String) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Retrieves text content of the selected elements in HTML.

Toc<T extends Toc<?>> - Class in org.devacfr.maven.skins.reflow.model

Represents the base of Table of content component.

Toc(String, String) - Constructor for class org.devacfr.maven.skins.reflow.model.Toc

TocSidebar - Class in org.devacfr.maven.skins.reflow.model

TocSidebar(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.TocSidebar

Default constructor.

TocTopBar - Class in org.devacfr.maven.skins.reflow.model

TocTopBar(ISkinConfig) - Constructor for class org.devacfr.maven.skins.reflow.model.TocTopBar

Default constructor.

toString() - Method in class org.devacfr.maven.skins.reflow.context.Context

toString() - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

toString() - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

toString() - Method in class org.devacfr.maven.skins.reflow.model.Toc

toString() - Method in class org.devacfr.maven.skins.reflow.snippet.Component

toString() - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentToken

toURI(String) - Static method in class org.devacfr.maven.skins.reflow.URITool

Creates a URI by parsing the given string.

type() - Method in class org.devacfr.maven.skins.reflow.snippet.ComponentToken

U

URITool - Class in org.devacfr.maven.skins.reflow

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

URITool() - Constructor for class org.devacfr.maven.skins.reflow.URITool

URITool.URLRebaser - Class in org.devacfr.maven.skins.reflow

URL rebaser: based on an old and a new path, can rebase a link based on old path to a value based on the new path.

URLRebaser(String, String) - Constructor for class org.devacfr.maven.skins.reflow.URITool.URLRebaser

Construct a URL rebaser.

V

value(String) - Method in class org.devacfr.maven.skins.reflow.SkinConfigTool

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

valueOf(String) - Static method in enum org.devacfr.maven.skins.reflow.context.ContextType

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

valueOf(String) - Static method in enum org.devacfr.maven.skins.reflow.HtmlTool.JoinSeparator

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

valueOf(String) - Static method in enum org.devacfr.maven.skins.reflow.snippet.ComponentToken.Tag

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

valueOf(String) - Static method in enum org.devacfr.maven.skins.reflow.snippet.ComponentToken.Type

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

values() - Static method in enum org.devacfr.maven.skins.reflow.context.ContextType

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

values() - Static method in enum org.devacfr.maven.skins.reflow.HtmlTool.JoinSeparator

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

values() - Static method in enum org.devacfr.maven.skins.reflow.snippet.ComponentToken.Tag

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

values() - Static method in enum org.devacfr.maven.skins.reflow.snippet.ComponentToken.Type

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

W

WebComponentProcessor(SnippetParser) - Constructor for class org.devacfr.maven.skins.reflow.snippet.Processor.WebComponentProcessor

Default constructor

withAutoExpandable(boolean) - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Sets the indicating whether is auto-expanded.

withEnabled(boolean) - Method in class org.devacfr.maven.skins.reflow.model.Toc

Sets the indicating whether is enable.

withExpanded(boolean) - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Sets the indicating whether is expanded.

withFixed(boolean) - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Sets the indicating whether is fixed.

withFlatten(boolean) - Method in class org.devacfr.maven.skins.reflow.model.TocTopBar

Sets the indicating whether is flatten.

withHref(String) - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

withIcon(String) - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

Sets the icon associate to.

withItems(List<SideNavMenuItem>) - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Sets the List of SideNavMenuItem.

withItems(List<SideNavMenuItem>) - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

Sets the items associate.

withLevel(int) - Method in class org.devacfr.maven.skins.reflow.model.TocSidebar

Sets the level limit to display

withName(String) - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Sets the name of menu displayed on top of navside menu.

withName(String) - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

withNumberItems(int) - Method in class org.devacfr.maven.skins.reflow.model.TocTopBar

Sets the number of items to display.

withParent(String) - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

withParent(Component<?>) - Method in class org.devacfr.maven.skins.reflow.snippet.Component

withSelectFirstOnSelect(boolean) - Method in class org.devacfr.maven.skins.reflow.model.NavSideMenu

Sets the indicating whether the first sub menu item should be selected when a dropdown menu item is selected and should expand.

withSlugName(String) - Method in class org.devacfr.maven.skins.reflow.model.SideNavMenuItem

withType(ContextType) - Method in class org.devacfr.maven.skins.reflow.context.Context

Sets the type of context.

wrap(String, String, String, int) - Method in class org.devacfr.maven.skins.reflow.HtmlTool

Wraps elements in HTML with the given HTML.

X

Xpp3Utils - Class in org.devacfr.maven.skins.reflow

Utility class to manipulate Xpp3Dom model.

A B C D E F G H I L M N O P R S T U V W X