Component (Reflow Velocity Tools 2.4.0-beta3-SNAPSHOT API)

java.lang.Object
- org.devacfr.maven.skins.reflow.model.Component

Direct Known Subclasses:

BsComponent, Context, ScrollTop
```
public abstract class Component
extends Object
```
The abstract class of all component used in Reflow rendering.

Since:

2.0

Author:

devacfr

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addChildren(Component... components)` Add components to this component.
`protected void`	`addCssOptions(String... cssOptions)` Add cssOption to this component.
`protected String`	`getBodyContent(ISkinConfig skinConfig)`
`String`	`getCssClass()`
`String`	`getCssOptions()` Gets the css options associated to component.
`protected HtmlTool`	`getHtmlTool(ISkinConfig skinConfig)` Gets the tool `HtmlTool`.
`protected String`	`onPreRender(ISkinConfig skinConfig, String bodyContent)` generic pre-rendering method executed on all components of context.
`protected void`	`setCssClass(String cssClass)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Component
```
public Component()
```
- Method Detail
  - getCssClass
```
@Nonnull
public String getCssClass()
```
    Returns:
    
    Returns a String representing the css classes to apply to component.
  - setCssClass
```
protected void setCssClass(String cssClass)
```
    Parameters:
    
    cssClass - the cssClass to set
  - getCssOptions
```
@Nonnull
public final String getCssOptions()
```
    Gets the css options associated to component. A css option is css class that can be set directly on the component or on <body> element as global state.
    Used generally in association with javascript to adapt specific javascript action to current state of component.
    
    Returns:
    
    Returns a String representing the css options associated to component.
  - addChildren
```
protected void addChildren(Component... components)
```
    Add components to this component.
    
    Parameters:
    
    components - list of component
  - addCssOptions
```
protected final void addCssOptions(@Nonnull
                                   String... cssOptions)
```
    Add cssOption to this component.
    
    Parameters:
    
    cssOptions - a css option.
  - onPreRender
```
protected String onPreRender(@Nonnull
                             ISkinConfig skinConfig,
                             @Nonnull
                             String bodyContent)
```
    generic pre-rendering method executed on all components of context.
    
    Parameters:
    
    skinConfig - the current skin config.
    
    bodyContent - the current body content.
    
    Returns:
    
    Returns a String representing the transformed body content on pre-rendering.
  - getHtmlTool
```
protected HtmlTool getHtmlTool(@Nonnull
                               ISkinConfig skinConfig)
```
    Gets the tool HtmlTool.
    
    Parameters:
    
    skinConfig - a config (can not be null).
    
    Returns:
    
    Returns the tool HtmlTool.
    
    Since:
    
    2.1
  - getBodyContent
```
@Nonnull
protected String getBodyContent(@Nonnull
                                         ISkinConfig skinConfig)
```
    Parameters:
    
    skinConfig - a config (can not be null).
    
    Returns:
    
    Returns the html body content stored in velocity context.
    
    Since:
    
    2.1

Class Component

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Component

Method Detail

getCssClass

setCssClass

getCssOptions

addChildren

addCssOptions

onPreRender

getHtmlTool

getBodyContent