BsComponent (Reflow Velocity Tools 3.0.0-SNAPSHOT API)

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

Direct Known Subclasses:

Footer, Header, Navbar, NavSideMenu, Toc
```
public abstract class BsComponent
extends Component
```
Describe a Bootstrap component.

Since:

2.0

Author:

devacfr

Field Summary
- Fields inherited from class org.devacfr.maven.skins.reflow.model.Component
  config

Constructor Summary

Constructors
Constructor Description

BsComponent(ISkinConfig config, String component)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getBackground()`
`String`	`getCssClass()`
`String`	`getTheme()`
`protected void`	`setBackground(String background)`
`protected void`	`setTheme(String theme)`

Methods inherited from class org.devacfr.maven.skins.reflow.model.Component
addChildren, addCssOptions, getCssOptions, onPreRender, setCssClass

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

- Constructor Detail
  - BsComponent
```
public BsComponent(@Nonnull
                   ISkinConfig config,
                   String component)
```
    Default constructor.
    
    Parameters:
    
    config - a config (can not be null).
    
    component - the bootstrap component name.
- Method Detail
  - getCssClass
```
@Nonnull
public String getCssClass()
```
    Overrides:
    
    getCssClass in class Component
    
    Returns:
    
    Returns a String representing the css classes to apply to component.
  - getTheme
```
public String getTheme()
```
    Returns:
    
    Returns a String representing the bootstrap theme to apply.
  - setTheme
```
protected void setTheme(@Nullable
                        String theme)
```
    Parameters:
    
    theme - a bootstrap theme to use.
  - getBackground
```
public String getBackground()
```
    Returns:
    
    Returns a String representing the bootstrap background color to apply.
  - setBackground
```
protected void setBackground(@Nullable
                             String background)
```
    Parameters:
    
    background - a bootstrap background colour to use.