Interface BorderFormatting

  • All Known Implementing Classes:
    HSSFBorderFormatting

    public interface BorderFormatting
    High level representation for Border Formatting component of Conditional Formatting settings
    • Method Detail

      • getBorderBottom

        BorderStyle getBorderBottom()
        Since:
        POI 4.0.0
      • getBorderDiagonal

        BorderStyle getBorderDiagonal()
        Since:
        POI 4.0.0
      • getBorderLeft

        BorderStyle getBorderLeft()
        Since:
        POI 4.0.0
      • getBorderRight

        BorderStyle getBorderRight()
        Since:
        POI 4.0.0
      • getBorderTop

        BorderStyle getBorderTop()
        Since:
        POI 4.0.0
      • getBorderVertical

        BorderStyle getBorderVertical()
        Only valid for range borders, such as table styles
        Returns:
        border style
        Since:
        4.0.0
      • getBorderHorizontal

        BorderStyle getBorderHorizontal()
        Only valid for range borders, such as table styles
        Returns:
        border style
        Since:
        4.0.0
      • getBottomBorderColor

        short getBottomBorderColor()
      • getBottomBorderColorColor

        Color getBottomBorderColorColor()
      • getDiagonalBorderColor

        short getDiagonalBorderColor()
      • getDiagonalBorderColorColor

        Color getDiagonalBorderColorColor()
      • getLeftBorderColor

        short getLeftBorderColor()
      • getLeftBorderColorColor

        Color getLeftBorderColorColor()
      • getRightBorderColor

        short getRightBorderColor()
      • getRightBorderColorColor

        Color getRightBorderColorColor()
      • getTopBorderColor

        short getTopBorderColor()
      • getTopBorderColorColor

        Color getTopBorderColorColor()
      • getVerticalBorderColor

        short getVerticalBorderColor()
        Range internal borders. Only relevant for range styles, such as table formatting
        Returns:
        color index
        Since:
        3.17 beta 1
      • getVerticalBorderColorColor

        Color getVerticalBorderColorColor()
        Range internal borders. Only relevant for range styles, such as table formatting
        Returns:
        color
        Since:
        3.17 beta 1
      • getHorizontalBorderColor

        short getHorizontalBorderColor()
        Range internal borders. Only relevant for range styles, such as table formatting
        Returns:
        color index
        Since:
        3.17 beta 1
      • getHorizontalBorderColorColor

        Color getHorizontalBorderColorColor()
        Range internal borders. Only relevant for range styles, such as table formatting
        Returns:
        color
        Since:
        3.17 beta 1
      • setBorderBottom

        void setBorderBottom​(BorderStyle border)
        Set bottom border.
        Parameters:
        border - The style of border to set.
      • setBorderDiagonal

        void setBorderDiagonal​(BorderStyle border)
        Set diagonal border.
        Parameters:
        border - The style of border to set.
      • setBorderLeft

        void setBorderLeft​(BorderStyle border)
        Set left border.
        Parameters:
        border - The style of border to set.
      • setBorderRight

        void setBorderRight​(BorderStyle border)
        Set right border.
        Parameters:
        border - The style of border to set.
      • setBorderTop

        void setBorderTop​(BorderStyle border)
        Set top border.
        Parameters:
        border - The style of border to set.
      • setBorderHorizontal

        void setBorderHorizontal​(BorderStyle border)
        Set range internal horizontal borders.
        Parameters:
        border - The style of border to set.
        Since:
        3.17 beta 1
      • setBorderVertical

        void setBorderVertical​(BorderStyle border)
        Set range internal vertical borders.
        Parameters:
        border - The style of border to set.
        Since:
        3.17 beta 1
      • setBottomBorderColor

        void setBottomBorderColor​(short color)
      • setBottomBorderColor

        void setBottomBorderColor​(Color color)
      • setDiagonalBorderColor

        void setDiagonalBorderColor​(short color)
      • setDiagonalBorderColor

        void setDiagonalBorderColor​(Color color)
      • setLeftBorderColor

        void setLeftBorderColor​(short color)
      • setLeftBorderColor

        void setLeftBorderColor​(Color color)
      • setRightBorderColor

        void setRightBorderColor​(short color)
      • setRightBorderColor

        void setRightBorderColor​(Color color)
      • setTopBorderColor

        void setTopBorderColor​(short color)
      • setTopBorderColor

        void setTopBorderColor​(Color color)
      • setHorizontalBorderColor

        void setHorizontalBorderColor​(short color)
        Range internal border color, such as table styles
        Parameters:
        color - index
        Since:
        3.17 beta 1
      • setHorizontalBorderColor

        void setHorizontalBorderColor​(Color color)
        Range internal border color, such as table styles
        Parameters:
        color - index
        Since:
        3.17 beta 1
      • setVerticalBorderColor

        void setVerticalBorderColor​(short color)
        Range internal border color, such as table styles
        Parameters:
        color - index
        Since:
        3.17 beta 1
      • setVerticalBorderColor

        void setVerticalBorderColor​(Color color)
        Range internal border color, such as table styles
        Parameters:
        color - index
        Since:
        3.17 beta 1