Package org.apache.poi.xssf.usermodel
Class XSSFBorderFormatting
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFBorderFormatting
- All Implemented Interfaces:
BorderFormatting
XSSF high level representation for Border Formatting component
of Conditional Formatting settings
-
Method Summary
Modifier and TypeMethodDescriptionOnly valid for range borders, such as table stylesOnly valid for range borders, such as table stylesOnly valid for range borders, such as table stylesOnly valid for range borders, such as table stylesshortshortshortRange internal borders.Range internal borders.shortshortshortshortRange internal borders.Range internal borders.voidsetBorderBottom(BorderStyle border) Set bottom border.voidsetBorderDiagonal(BorderStyle border) Set diagonal border.voidsetBorderHorizontal(BorderStyle border) Set range internal horizontal borders.voidsetBorderLeft(BorderStyle border) Set left border.voidsetBorderRight(BorderStyle border) Set right border.voidsetBorderTop(BorderStyle border) Set top border.voidsetBorderVertical(BorderStyle border) Set range internal vertical borders.voidsetBottomBorderColor(short color) voidsetBottomBorderColor(Color color) voidsetBottomBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) voidsetDiagonalBorderColor(short color) voidsetDiagonalBorderColor(Color color) voidsetDiagonalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) voidsetHorizontalBorderColor(short color) Range internal border color, such as table stylesvoidsetHorizontalBorderColor(Color color) Range internal border color, such as table stylesvoidsetHorizontalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) voidsetLeftBorderColor(short color) voidsetLeftBorderColor(Color color) voidsetLeftBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) voidsetRightBorderColor(short color) voidsetRightBorderColor(Color color) voidsetRightBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) voidsetTopBorderColor(short color) voidsetTopBorderColor(Color color) voidsetTopBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) voidsetVerticalBorderColor(short color) Range internal border color, such as table stylesvoidsetVerticalBorderColor(Color color) Range internal border color, such as table stylesvoidsetVerticalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
-
Method Details
-
getBorderBottom
- Specified by:
getBorderBottomin interfaceBorderFormatting
-
getBorderDiagonal
- Specified by:
getBorderDiagonalin interfaceBorderFormatting
-
getBorderLeft
- Specified by:
getBorderLeftin interfaceBorderFormatting
-
getBorderRight
- Specified by:
getBorderRightin interfaceBorderFormatting
-
getBorderTopEnum
- Specified by:
getBorderTopEnumin interfaceBorderFormatting
-
getBorderBottomEnum
- Specified by:
getBorderBottomEnumin interfaceBorderFormatting
-
getBorderDiagonalEnum
- Specified by:
getBorderDiagonalEnumin interfaceBorderFormatting
-
getBorderLeftEnum
- Specified by:
getBorderLeftEnumin interfaceBorderFormatting
-
getBorderRightEnum
- Specified by:
getBorderRightEnumin interfaceBorderFormatting
-
getBorderTop
- Specified by:
getBorderTopin interfaceBorderFormatting
-
getBottomBorderColorColor
- Specified by:
getBottomBorderColorColorin interfaceBorderFormatting
-
getBottomBorderColor
public short getBottomBorderColor()- Specified by:
getBottomBorderColorin interfaceBorderFormatting
-
getDiagonalBorderColorColor
- Specified by:
getDiagonalBorderColorColorin interfaceBorderFormatting
-
getDiagonalBorderColor
public short getDiagonalBorderColor()- Specified by:
getDiagonalBorderColorin interfaceBorderFormatting
-
getLeftBorderColorColor
- Specified by:
getLeftBorderColorColorin interfaceBorderFormatting
-
getLeftBorderColor
public short getLeftBorderColor()- Specified by:
getLeftBorderColorin interfaceBorderFormatting
-
getRightBorderColorColor
- Specified by:
getRightBorderColorColorin interfaceBorderFormatting
-
getRightBorderColor
public short getRightBorderColor()- Specified by:
getRightBorderColorin interfaceBorderFormatting
-
getTopBorderColorColor
- Specified by:
getTopBorderColorColorin interfaceBorderFormatting
-
getTopBorderColor
public short getTopBorderColor()- Specified by:
getTopBorderColorin interfaceBorderFormatting
-
setBorderBottom
Description copied from interface:BorderFormattingSet bottom border.- Specified by:
setBorderBottomin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderDiagonal
Description copied from interface:BorderFormattingSet diagonal border.- Specified by:
setBorderDiagonalin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderLeft
Description copied from interface:BorderFormattingSet left border.- Specified by:
setBorderLeftin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderRight
Description copied from interface:BorderFormattingSet right border.- Specified by:
setBorderRightin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderTop
Description copied from interface:BorderFormattingSet top border.- Specified by:
setBorderTopin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBottomBorderColor
- Specified by:
setBottomBorderColorin interfaceBorderFormatting
-
setBottomBorderColor
public void setBottomBorderColor(short color) - Specified by:
setBottomBorderColorin interfaceBorderFormatting
-
setBottomBorderColor
public void setBottomBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setDiagonalBorderColor
- Specified by:
setDiagonalBorderColorin interfaceBorderFormatting
-
setDiagonalBorderColor
public void setDiagonalBorderColor(short color) - Specified by:
setDiagonalBorderColorin interfaceBorderFormatting
-
setDiagonalBorderColor
public void setDiagonalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setLeftBorderColor
- Specified by:
setLeftBorderColorin interfaceBorderFormatting
-
setLeftBorderColor
public void setLeftBorderColor(short color) - Specified by:
setLeftBorderColorin interfaceBorderFormatting
-
setLeftBorderColor
public void setLeftBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setRightBorderColor
- Specified by:
setRightBorderColorin interfaceBorderFormatting
-
setRightBorderColor
public void setRightBorderColor(short color) - Specified by:
setRightBorderColorin interfaceBorderFormatting
-
setRightBorderColor
public void setRightBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setTopBorderColor
- Specified by:
setTopBorderColorin interfaceBorderFormatting
-
setTopBorderColor
public void setTopBorderColor(short color) - Specified by:
setTopBorderColorin interfaceBorderFormatting
-
setTopBorderColor
public void setTopBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
getBorderVertical
Description copied from interface:BorderFormattingOnly valid for range borders, such as table styles- Specified by:
getBorderVerticalin interfaceBorderFormatting- Returns:
- border style
-
getBorderHorizontal
Description copied from interface:BorderFormattingOnly valid for range borders, such as table styles- Specified by:
getBorderHorizontalin interfaceBorderFormatting- Returns:
- border style
-
getBorderVerticalEnum
Description copied from interface:BorderFormattingOnly valid for range borders, such as table styles- Specified by:
getBorderVerticalEnumin interfaceBorderFormatting- Returns:
- border style
-
getBorderHorizontalEnum
Description copied from interface:BorderFormattingOnly valid for range borders, such as table styles- Specified by:
getBorderHorizontalEnumin interfaceBorderFormatting- Returns:
- border style
-
getVerticalBorderColor
public short getVerticalBorderColor()Description copied from interface:BorderFormattingRange internal borders. Only relevant for range styles, such as table formatting- Specified by:
getVerticalBorderColorin interfaceBorderFormatting- Returns:
- color index
-
getVerticalBorderColorColor
Description copied from interface:BorderFormattingRange internal borders. Only relevant for range styles, such as table formatting- Specified by:
getVerticalBorderColorColorin interfaceBorderFormatting- Returns:
- color
-
getHorizontalBorderColor
public short getHorizontalBorderColor()Description copied from interface:BorderFormattingRange internal borders. Only relevant for range styles, such as table formatting- Specified by:
getHorizontalBorderColorin interfaceBorderFormatting- Returns:
- color index
-
getHorizontalBorderColorColor
Description copied from interface:BorderFormattingRange internal borders. Only relevant for range styles, such as table formatting- Specified by:
getHorizontalBorderColorColorin interfaceBorderFormatting- Returns:
- color
-
setBorderHorizontal
Description copied from interface:BorderFormattingSet range internal horizontal borders.- Specified by:
setBorderHorizontalin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setBorderVertical
Description copied from interface:BorderFormattingSet range internal vertical borders.- Specified by:
setBorderVerticalin interfaceBorderFormatting- Parameters:
border- The style of border to set.
-
setHorizontalBorderColor
public void setHorizontalBorderColor(short color) Description copied from interface:BorderFormattingRange internal border color, such as table styles- Specified by:
setHorizontalBorderColorin interfaceBorderFormatting- Parameters:
color- index
-
setHorizontalBorderColor
Description copied from interface:BorderFormattingRange internal border color, such as table styles- Specified by:
setHorizontalBorderColorin interfaceBorderFormatting- Parameters:
color- index
-
setHorizontalBorderColor
public void setHorizontalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color) -
setVerticalBorderColor
public void setVerticalBorderColor(short color) Description copied from interface:BorderFormattingRange internal border color, such as table styles- Specified by:
setVerticalBorderColorin interfaceBorderFormatting- Parameters:
color- index
-
setVerticalBorderColor
Description copied from interface:BorderFormattingRange internal border color, such as table styles- Specified by:
setVerticalBorderColorin interfaceBorderFormatting- Parameters:
color- index
-
setVerticalBorderColor
public void setVerticalBorderColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
-