StyleSetter (Fastexcel Writer 0.16.0 API)

java.lang.Object
- org.dhatim.fastexcel.StyleSetter

public class StyleSetter
extends Object

Helper class to set style elements on a cell or range of cells. This class implements the builder pattern to easily modify a bunch of attributes.

For example:

  Worksheet ws = ...
  ws.range(1, 1, 1, 10).style().borderStyle("thin").bold().fillColor(Color.GRAY4).horizontalAlignment("center").set();

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StyleSetter`	`bold()` Use bold text.
`StyleSetter`	`borderColor(BorderSide side, String borderColor)` Set cell border color.
`StyleSetter`	`borderColor(String borderColor)` Set cell border color.
`StyleSetter`	`borderStyle(BorderSide side, BorderStyle borderStyle)` Apply cell border style on a side.
`StyleSetter`	`borderStyle(BorderSide side, String borderStyle)` Apply cell border style on a side.
`StyleSetter`	`borderStyle(BorderStyle borderStyle)` Apply cell border style on all sides, except diagonal.
`StyleSetter`	`borderStyle(String borderStyle)` Apply cell border style on all sides, except diagonal.
`StyleSetter`	`diagonalProperty(DiagonalProperty diagonalProperty)` Set cell diagonal property.
`StyleSetter`	`fillColor(String rgb)` Set fill color.
`StyleSetter`	`fontColor(String rgb)` Set font color.
`StyleSetter`	`fontName(String name)` Set font name.
`StyleSetter`	`fontSize(BigDecimal size)` Set font size.
`StyleSetter`	`fontSize(int size)` Set font size.
`StyleSetter`	`format(String numberingFormat)` Set numbering format.
`StyleSetter`	`horizontalAlignment(String alignment)` Define horizontal alignment.
`StyleSetter`	`indent(int indent)` Set cell text indentation.
`StyleSetter`	`italic()` Use italic text.
`StyleSetter`	`merge()` Merge cells in this style setter's range.
`StyleSetter`	`protectionOption(ProtectionOption option, Boolean value)` Sets the value for a protection option.
`StyleSetter`	`rotation(int degrees)` Set cell text rotation in degrees.
`void`	`set()` Apply style elements.
`void`	`set(ConditionalFormattingRule conditionalFormattingRule)` Apply style elements conditionally
`StyleSetter`	`shadeAlternateRows(String rgb)` Shade alternate rows.
`StyleSetter`	`shadeRows(String rgb, int eachNRows)` Shade Nth rows.
`StyleSetter`	`underlined()` Use underlined text.
`StyleSetter`	`verticalAlignment(String alignment)` Define vertical alignment.
`StyleSetter`	`wrapText(boolean wrapText)` Enable or disable text wrapping in cells.

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

- Method Detail
  - format
```
public StyleSetter format(String numberingFormat)
```
    Set numbering format.
    
    Parameters:
    
    numberingFormat - Numbering format. For more information, refer to this page.
    
    Returns:
    
    This style setter.
  - fillColor
```
public StyleSetter fillColor(String rgb)
```
    Set fill color.
    
    Parameters:
    
    rgb - RGB fill color. See Color for predefined values.
    
    Returns:
    
    This style setter.
  - shadeAlternateRows
```
public StyleSetter shadeAlternateRows(String rgb)
```
    Shade alternate rows.
    
    Parameters:
    
    rgb - RGB shading color.
    
    Returns:
    
    This style setter.
  - shadeRows
```
public StyleSetter shadeRows(String rgb,
                             int eachNRows)
```
    Shade Nth rows.
    
    Parameters:
    
    rgb - RGB shading color.
    
    eachNRows - shading frequency.
    
    Returns:
    
    This style setter.
  - fontColor
```
public StyleSetter fontColor(String rgb)
```
    Set font color.
    
    Parameters:
    
    rgb - RGB font color.
    
    Returns:
    
    This style setter.
  - fontName
```
public StyleSetter fontName(String name)
```
    Set font name.
    
    Parameters:
    
    name - Font name.
    
    Returns:
    
    This style setter.
  - fontSize
```
public StyleSetter fontSize(BigDecimal size)
```
    Set font size.
    
    Parameters:
    
    size - Font size, in points.
    
    Returns:
    
    This style setter.
  - fontSize
```
public StyleSetter fontSize(int size)
```
    Set font size.
    
    Parameters:
    
    size - Font size, in points.
    
    Returns:
    
    This style setter.
  - bold
```
public StyleSetter bold()
```
    Use bold text.
    
    Returns:
    
    This style setter.
  - italic
```
public StyleSetter italic()
```
    Use italic text.
    
    Returns:
    
    This style setter.
  - underlined
```
public StyleSetter underlined()
```
    Use underlined text.
    
    Returns:
    
    This style setter.
  - horizontalAlignment
```
public StyleSetter horizontalAlignment(String alignment)
```
    Define horizontal alignment.
    
    Parameters:
    
    alignment - Horizontal alignment. Possible values are defined here.
    
    Returns:
    
    This style setter.
  - verticalAlignment
```
public StyleSetter verticalAlignment(String alignment)
```
    Define vertical alignment.
    
    Parameters:
    
    alignment - Vertical alignment. Possible values are defined here.
    
    Returns:
    
    This style setter.
  - wrapText
```
public StyleSetter wrapText(boolean wrapText)
```
    Enable or disable text wrapping in cells.
    
    Parameters:
    
    wrapText - true to enable text wrapping (default is false).
    
    Returns:
    
    This style setter.
  - rotation
```
public StyleSetter rotation(int degrees)
```
    Set cell text rotation in degrees.
    
    Parameters:
    
    degrees - rotation of text in cell
    
    Returns:
    
    This style setter
  - indent
```
public StyleSetter indent(int indent)
```
    Set cell text indentation.
    
    Parameters:
    
    indent - indentation of text in cell
    
    Returns:
    
    This style setter
  - borderStyle
```
public StyleSetter borderStyle(BorderStyle borderStyle)
```
    Apply cell border style on all sides, except diagonal.
    
    Parameters:
    
    borderStyle - Border style.
    
    Returns:
    
    This style setter.
  - borderStyle
```
public StyleSetter borderStyle(String borderStyle)
```
    Apply cell border style on all sides, except diagonal.
    
    Parameters:
    
    borderStyle - Border style. Possible values are defined here.
    
    Returns:
    
    This style setter.
  - borderStyle
```
public StyleSetter borderStyle(BorderSide side,
                               BorderStyle borderStyle)
```
    Apply cell border style on a side.
    
    Parameters:
    
    side - Border side where to apply the given style.
    
    borderStyle - Border style.
    
    Returns:
    
    This style setter.
  - borderStyle
```
public StyleSetter borderStyle(BorderSide side,
                               String borderStyle)
```
    Apply cell border style on a side.
    
    Parameters:
    
    side - Border side where to apply the given style.
    
    borderStyle - Border style. Possible values are defined here.
    
    Returns:
    
    This style setter.
  - borderColor
```
public StyleSetter borderColor(String borderColor)
```
    Set cell border color.
    
    Parameters:
    
    borderColor - RGB border color.
    
    Returns:
    
    This style setter.
  - borderColor
```
public StyleSetter borderColor(BorderSide side,
                               String borderColor)
```
    Set cell border color.
    
    Parameters:
    
    side - Border side where to apply the given border color.
    
    borderColor - RGB border color.
    
    Returns:
    
    This style setter.
  - diagonalProperty
```
public StyleSetter diagonalProperty(DiagonalProperty diagonalProperty)
```
    Set cell diagonal property.
    
    Parameters:
    
    diagonalProperty - Diagonal border property which should be aplied to a cell
    
    Returns:
    
    This style setter.
  - protectionOption
```
public StyleSetter protectionOption(ProtectionOption option,
                                    Boolean value)
```
    Sets the value for a protection option.
    
    Parameters:
    
    option - The option to set
    
    value - The value to set for the given option.
    
    Returns:
    
    This style setter.
  - merge
```
public StyleSetter merge()
```
    Merge cells in this style setter's range.
    
    Returns:
    
    This style setter.
  - set
```
public void set()
```
    Apply style elements. Do not forget to call this method when you are done otherwise style changes are lost!
  - set
```
public void set(ConditionalFormattingRule conditionalFormattingRule)
```
    Apply style elements conditionally
    
    Parameters:
    
    conditionalFormattingRule - Conditional formatting rule to apply

Class StyleSetter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

format

fillColor

shadeAlternateRows

shadeRows

fontColor

fontName

fontSize

fontSize

bold

italic

underlined

horizontalAlignment

verticalAlignment

wrapText

rotation

indent

borderStyle

borderStyle

borderStyle

borderStyle

borderColor

borderColor

diagonalProperty

protectionOption

merge

set

set