Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hssf.usermodel
Class HSSFBorderFormatting

    java.lang.Object
      org.apache.poi.hssf.usermodel.HSSFBorderFormatting

All Implemented Interfaces:
  BorderFormatting

    public final class HSSFBorderFormatting

extends java.lang.Object
implements BorderFormatting

High level representation for Border Formatting component of Conditional Formatting settings

Constructor Summary
`protected` | `HSSFBorderFormatting(CFRuleBase cfRuleRecord, HSSFWorkbook workbook)`

Method Summary
`short` | `getBorderBottom()` Deprecated. POI 3.15. Use `getBorderBottomEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle` | `getBorderBottomEnum()`
`short` | `getBorderDiagonal()` Deprecated. POI 3.15. Use `getBorderDiagonalEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle` | `getBorderDiagonalEnum()`
`protected BorderFormatting` | `getBorderFormattingBlock()`
`BorderStyle` | `getBorderHorizontalEnum()` HSSF doesn't support table borders, so always `BorderStyle.NONE`
`short` | `getBorderLeft()` Deprecated. POI 3.15. Use `getBorderLeftEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle` | `getBorderLeftEnum()`
`short` | `getBorderRight()` Deprecated. POI 3.15. Use `getBorderRightEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle` | `getBorderRightEnum()`
`short` | `getBorderTop()` Deprecated. POI 3.15. Use `getBorderTopEnum()`. This method will return an BorderStyle enum in the future.
`BorderStyle` | `getBorderTopEnum()`
`BorderStyle` | `getBorderVerticalEnum()` HSSF doesn't support table borders, so always `BorderStyle.NONE`
`short` | `getBottomBorderColor()`
`HSSFColor` | `getBottomBorderColorColor()`
`short` | `getDiagonalBorderColor()`
`HSSFColor` | `getDiagonalBorderColorColor()`
`short` | `getHorizontalBorderColor()` HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`
`Color` | `getHorizontalBorderColorColor()` HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`
`short` | `getLeftBorderColor()`
`HSSFColor` | `getLeftBorderColorColor()`
`short` | `getRightBorderColor()`
`HSSFColor` | `getRightBorderColorColor()`
`short` | `getTopBorderColor()`
`HSSFColor` | `getTopBorderColorColor()`
`short` | `getVerticalBorderColor()` HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`
`Color` | `getVerticalBorderColorColor()` HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`
`boolean` | `isBackwardDiagonalOn()`
`boolean` | `isForwardDiagonalOn()`
`void` | `setBackwardDiagonalOn(boolean on)`
`void` | `setBorderBottom(BorderStyle border)` Set bottom border.
`void` | `setBorderBottom(short border)` Set bottom border.
`void` | `setBorderDiagonal(BorderStyle border)` Set diagonal border.
`void` | `setBorderDiagonal(short border)` Set diagonal border.
`void` | `setBorderHorizontal(BorderStyle border)` Not available for HSSF.
`void` | `setBorderLeft(BorderStyle border)` Set left border.
`void` | `setBorderLeft(short border)` Set left border.
`void` | `setBorderRight(BorderStyle border)` Set right border.
`void` | `setBorderRight(short border)` Set right border.
`void` | `setBorderTop(BorderStyle border)` Set top border.
`void` | `setBorderTop(short border)` Set top border.
`void` | `setBorderVertical(BorderStyle border)` Not available for HSSF.
`void` | `setBottomBorderColor(Color color)`
`void` | `setBottomBorderColor(short color)`
`void` | `setDiagonalBorderColor(Color color)`
`void` | `setDiagonalBorderColor(short color)`
`void` | `setForwardDiagonalOn(boolean on)`
`void` | `setHorizontalBorderColor(Color color)` Not available for HSSF.
`void` | `setHorizontalBorderColor(short color)` Not available for HSSF.
`void` | `setLeftBorderColor(Color color)`
`void` | `setLeftBorderColor(short color)`
`void` | `setRightBorderColor(Color color)`
`void` | `setRightBorderColor(short color)`
`void` | `setTopBorderColor(Color color)`
`void` | `setTopBorderColor(short color)`
`void` | `setVerticalBorderColor(Color color)` Not available for HSSF.
`void` | `setVerticalBorderColor(short color)` Not available for HSSF.

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

Constructor Detail

### HSSFBorderFormatting

    protected HSSFBorderFormatting(CFRuleBase cfRuleRecord,
                                   HSSFWorkbook workbook)

Method Detail

### getBorderFormattingBlock

    protected BorderFormatting getBorderFormattingBlock()

### getBorderBottom

    public short getBorderBottom()

  Deprecated. POI 3.15. Use `getBorderBottomEnum()`. This method will return an BorderStyle enum in the future.

  Specified by:
    `getBorderBottom` in interface `BorderFormatting`

### getBorderBottomEnum

    public BorderStyle getBorderBottomEnum()

  Specified by:
    `getBorderBottomEnum` in interface `BorderFormatting`
  Since:
    POI 3.15

### getBorderDiagonal

    public short getBorderDiagonal()

  Deprecated. POI 3.15. Use `getBorderDiagonalEnum()`. This method will return an BorderStyle enum in the future.

  Specified by:
    `getBorderDiagonal` in interface `BorderFormatting`

### getBorderDiagonalEnum

    public BorderStyle getBorderDiagonalEnum()

  Specified by:
    `getBorderDiagonalEnum` in interface `BorderFormatting`
  Since:
    POI 3.15

### getBorderLeft

    public short getBorderLeft()

  Deprecated. POI 3.15. Use `getBorderLeftEnum()`. This method will return an BorderStyle enum in the future.

  Specified by:
    `getBorderLeft` in interface `BorderFormatting`

### getBorderLeftEnum

    public BorderStyle getBorderLeftEnum()

  Specified by:
    `getBorderLeftEnum` in interface `BorderFormatting`
  Since:
    POI 3.15

### getBorderRight

    public short getBorderRight()

  Deprecated. POI 3.15. Use `getBorderRightEnum()`. This method will return an BorderStyle enum in the future.

  Specified by:
    `getBorderRight` in interface `BorderFormatting`

### getBorderRightEnum

    public BorderStyle getBorderRightEnum()

  Specified by:
    `getBorderRightEnum` in interface `BorderFormatting`
  Since:
    POI 3.15

### getBorderTop

    public short getBorderTop()

  Deprecated. POI 3.15. Use `getBorderTopEnum()`. This method will return an BorderStyle enum in the future.

  Specified by:
    `getBorderTop` in interface `BorderFormatting`

### getBorderTopEnum

    public BorderStyle getBorderTopEnum()

  Specified by:
    `getBorderTopEnum` in interface `BorderFormatting`
  Since:
    POI 3.15

### getBottomBorderColor

    public short getBottomBorderColor()

  Specified by:
    `getBottomBorderColor` in interface `BorderFormatting`

### getBottomBorderColorColor

    public HSSFColor getBottomBorderColorColor()

  Specified by:
    `getBottomBorderColorColor` in interface `BorderFormatting`

### getDiagonalBorderColor

    public short getDiagonalBorderColor()

  Specified by:
    `getDiagonalBorderColor` in interface `BorderFormatting`

### getDiagonalBorderColorColor

    public HSSFColor getDiagonalBorderColorColor()

  Specified by:
    `getDiagonalBorderColorColor` in interface `BorderFormatting`

### getLeftBorderColor

    public short getLeftBorderColor()

  Specified by:
    `getLeftBorderColor` in interface `BorderFormatting`

### getLeftBorderColorColor

    public HSSFColor getLeftBorderColorColor()

  Specified by:
    `getLeftBorderColorColor` in interface `BorderFormatting`

### getRightBorderColor

    public short getRightBorderColor()

  Specified by:
    `getRightBorderColor` in interface `BorderFormatting`

### getRightBorderColorColor

    public HSSFColor getRightBorderColorColor()

  Specified by:
    `getRightBorderColorColor` in interface `BorderFormatting`

### getTopBorderColor

    public short getTopBorderColor()

  Specified by:
    `getTopBorderColor` in interface `BorderFormatting`

### getTopBorderColorColor

    public HSSFColor getTopBorderColorColor()

  Specified by:
    `getTopBorderColorColor` in interface `BorderFormatting`

### isBackwardDiagonalOn

    public boolean isBackwardDiagonalOn()

### isForwardDiagonalOn

    public boolean isForwardDiagonalOn()

### setBackwardDiagonalOn

    public void setBackwardDiagonalOn(boolean on)

### setForwardDiagonalOn

    public void setForwardDiagonalOn(boolean on)

### setBorderBottom

    public void setBorderBottom(short border)

  Description copied from interface: `BorderFormatting`
  Set bottom border.

  Specified by:
    `setBorderBottom` in interface `BorderFormatting`
  Parameters:
    `border` - MUST be a BORDER_* constant

### setBorderBottom

    public void setBorderBottom(BorderStyle border)

  Description copied from interface: `BorderFormatting`
  Set bottom border.

  Specified by:
    `setBorderBottom` in interface `BorderFormatting`

### setBorderDiagonal

    public void setBorderDiagonal(short border)

  Description copied from interface: `BorderFormatting`
  Set diagonal border.

  Specified by:
    `setBorderDiagonal` in interface `BorderFormatting`
  Parameters:
    `border` - MUST be a BORDER_* constant

### setBorderDiagonal

    public void setBorderDiagonal(BorderStyle border)

  Description copied from interface: `BorderFormatting`
  Set diagonal border.

  Specified by:
    `setBorderDiagonal` in interface `BorderFormatting`

### setBorderLeft

    public void setBorderLeft(short border)

  Description copied from interface: `BorderFormatting`
  Set left border.

  Specified by:
    `setBorderLeft` in interface `BorderFormatting`
  Parameters:
    `border` - MUST be a BORDER_* constant

### setBorderLeft

    public void setBorderLeft(BorderStyle border)

  Description copied from interface: `BorderFormatting`
  Set left border.

  Specified by:
    `setBorderLeft` in interface `BorderFormatting`

### setBorderRight

    public void setBorderRight(short border)

  Description copied from interface: `BorderFormatting`
  Set right border.

  Specified by:
    `setBorderRight` in interface `BorderFormatting`
  Parameters:
    `border` - MUST be a BORDER_* constant

### setBorderRight

    public void setBorderRight(BorderStyle border)

  Description copied from interface: `BorderFormatting`
  Set right border.

  Specified by:
    `setBorderRight` in interface `BorderFormatting`

### setBorderTop

    public void setBorderTop(short border)

  Description copied from interface: `BorderFormatting`
  Set top border.

  Specified by:
    `setBorderTop` in interface `BorderFormatting`
  Parameters:
    `border` - MUST be a BORDER_* constant

### setBorderTop

    public void setBorderTop(BorderStyle border)

  Description copied from interface: `BorderFormatting`
  Set top border.

  Specified by:
    `setBorderTop` in interface `BorderFormatting`

### setBottomBorderColor

    public void setBottomBorderColor(short color)

  Specified by:
    `setBottomBorderColor` in interface `BorderFormatting`

### setBottomBorderColor

    public void setBottomBorderColor(Color color)

  Specified by:
    `setBottomBorderColor` in interface `BorderFormatting`

### setDiagonalBorderColor

    public void setDiagonalBorderColor(short color)

  Specified by:
    `setDiagonalBorderColor` in interface `BorderFormatting`

### setDiagonalBorderColor

    public void setDiagonalBorderColor(Color color)

  Specified by:
    `setDiagonalBorderColor` in interface `BorderFormatting`

### setLeftBorderColor

    public void setLeftBorderColor(short color)

  Specified by:
    `setLeftBorderColor` in interface `BorderFormatting`

### setLeftBorderColor

    public void setLeftBorderColor(Color color)

  Specified by:
    `setLeftBorderColor` in interface `BorderFormatting`

### setRightBorderColor

    public void setRightBorderColor(short color)

  Specified by:
    `setRightBorderColor` in interface `BorderFormatting`

### setRightBorderColor

    public void setRightBorderColor(Color color)

  Specified by:
    `setRightBorderColor` in interface `BorderFormatting`

### setTopBorderColor

    public void setTopBorderColor(short color)

  Specified by:
    `setTopBorderColor` in interface `BorderFormatting`

### setTopBorderColor

    public void setTopBorderColor(Color color)

  Specified by:
    `setTopBorderColor` in interface `BorderFormatting`

### getBorderVerticalEnum

    public BorderStyle getBorderVerticalEnum()

  HSSF doesn't support table borders, so always `BorderStyle.NONE`

  Specified by:
    `getBorderVerticalEnum` in interface `BorderFormatting`
  Returns:
    border style
  See Also:
    `BorderFormatting.getBorderVerticalEnum()`

### getBorderHorizontalEnum

    public BorderStyle getBorderHorizontalEnum()

  HSSF doesn't support table borders, so always `BorderStyle.NONE`

  Specified by:
    `getBorderHorizontalEnum` in interface `BorderFormatting`
  Returns:
    border style
  See Also:
    `BorderFormatting.getBorderHorizontalEnum()`

### getVerticalBorderColor

    public short getVerticalBorderColor()

  HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`

  Specified by:
    `getVerticalBorderColor` in interface `BorderFormatting`
  Returns:
    color index
  See Also:
    `BorderFormatting.getVerticalBorderColor()`

### getVerticalBorderColorColor

    public Color getVerticalBorderColorColor()

  HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`

  Specified by:
    `getVerticalBorderColorColor` in interface `BorderFormatting`
  Returns:
    color
  See Also:
    `BorderFormatting.getVerticalBorderColorColor()`

### getHorizontalBorderColor

    public short getHorizontalBorderColor()

  HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`

  Specified by:
    `getHorizontalBorderColor` in interface `BorderFormatting`
  Returns:
    color index
  See Also:
    `BorderFormatting.getHorizontalBorderColor()`

### getHorizontalBorderColorColor

    public Color getHorizontalBorderColorColor()

  HSSF Doesn't support table borders, so always `HSSFColor.HSSFColorPredefined.AUTOMATIC`

  Specified by:
    `getHorizontalBorderColorColor` in interface `BorderFormatting`
  Returns:
    color
  See Also:
    `BorderFormatting.getHorizontalBorderColorColor()`

### setBorderHorizontal

    public void setBorderHorizontal(BorderStyle border)

  Not available for HSSF.

  Specified by:
    `setBorderHorizontal` in interface `BorderFormatting`
  See Also:
    `BorderFormatting.setBorderHorizontal(org.apache.poi.ss.usermodel.BorderStyle)`

### setBorderVertical

    public void setBorderVertical(BorderStyle border)

  Not available for HSSF.

  Specified by:
    `setBorderVertical` in interface `BorderFormatting`
  See Also:
    `BorderFormatting.setBorderVertical(org.apache.poi.ss.usermodel.BorderStyle)`

### setHorizontalBorderColor

    public void setHorizontalBorderColor(short color)

  Not available for HSSF.

  Specified by:
    `setHorizontalBorderColor` in interface `BorderFormatting`
  Parameters:
    `color` - index
  See Also:
    `BorderFormatting.setHorizontalBorderColor(short)`

### setHorizontalBorderColor

    public void setHorizontalBorderColor(Color color)

  Not available for HSSF.

  Specified by:
    `setHorizontalBorderColor` in interface `BorderFormatting`
  Parameters:
    `color` - index
  See Also:
    `BorderFormatting.setHorizontalBorderColor(org.apache.poi.ss.usermodel.Color)`

### setVerticalBorderColor

    public void setVerticalBorderColor(short color)

  Not available for HSSF.

  Specified by:
    `setVerticalBorderColor` in interface `BorderFormatting`
  Parameters:
    `color` - index
  See Also:
    `BorderFormatting.setVerticalBorderColor(short)`

### setVerticalBorderColor

    public void setVerticalBorderColor(Color color)

  Not available for HSSF.

  Specified by:
    `setVerticalBorderColor` in interface `BorderFormatting`
  Parameters:
    `color` - index
  See Also:
    `BorderFormatting.setVerticalBorderColor(org.apache.poi.ss.usermodel.Color)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.