Border (Excel Write/Read Framework 0.5.21 API)

java.lang.Object
- org.ttzero.excel.entity.style.Border

所有已实现的接口:

Cloneable
```
public class Border
extends Object
implements Cloneable
```
边框，在样式中位于第6-12位，边框包含方向、样式和颜色。 Excel边框有6个方向分别是左、右、上、下、对角线向下、对角线向上。

作者:

guanquan.wang on 2018-02-06 08:55

另请参阅:

BorderStyle

嵌套类概要

嵌套类
限定符和类型类和说明

static class Border.SubBorder

嵌套类
限定符和类型	类和说明
`static class`	`Border.SubBorder`

构造器概要

构造器
构造器和说明

Border()
创建一个无边框的边框样式

Border(BorderStyle style, Color color)
实例化上-下-左-右四个方位的边框样式

构造器
构造器和说明
`Border()` 创建一个无边框的边框样式
`Border(BorderStyle style, Color color)` 实例化上-下-左-右四个方位的边框样式

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Border`	`clone()`
`Border`	`delBorder(int index)` 删除某个位置的边框
`static List<Border>`	`domToBorder(org.dom4j.Element root)` 解析Dom树并转为边框对象
`static List<Border>`	`domToBorder(org.dom4j.Element root, Color[] indexedColors)` 解析Dom树并转为边框对象
`boolean`	`equals(Object o)`
`Border.SubBorder`	`getBorder(int axis)` 获取指定位置的边框样式
`Border.SubBorder`	`getBorderBottom()` 获取下边框样式
`Border.SubBorder`	`getBorderLeft()` 获取左边框样式
`Border.SubBorder`	`getBorderRight()` 获取右边框样式
`Border.SubBorder[]`	`getBorders()` 获取所有位置的边框样式
`Border.SubBorder`	`getBorderTop()` 获取上边框样式
`Border.SubBorder`	`getDiagonalDown()` 获取左上到右下边框样式
`Border.SubBorder`	`getDiagonalUp()` 获取左下到右上边框样式
`int`	`hashCode()`
`boolean`	`isEffectiveBorder()` 检查边框是否有效（样式不为NONE)
`static Border`	`parse(String text)` The setting order is top -> right -> bottom -> left, the attribute order is style-name + color, if the orientation setting is not complete, the unset orientation has no border.
`Border`	`setBorder(BorderStyle style)` 设置上-下-左-右四个方位的边框样式
`Border`	`setBorder(BorderStyle style, Color color)` 设置上-下-左-右四个方位的边框样式和颜色
`Border`	`setBorderBottom(BorderStyle style)` 设置下边框样式
`Border`	`setBorderBottom(BorderStyle style, Color color)` 设置下边框样式和颜色
`Border`	`setBorderLeft(BorderStyle style)` 设置上边框样式
`Border`	`setBorderLeft(BorderStyle style, Color color)` 设置左边框样式和颜色
`Border`	`setBorderRight(BorderStyle style)` 设置右边框样式
`Border`	`setBorderRight(BorderStyle style, Color color)` 设置右边框样式和颜色
`Border`	`setBorderTop(BorderStyle style)` 设置上边框样式
`Border`	`setBorderTop(BorderStyle style, Color color)` 设置上边框样式和颜色
`Border`	`setDiagonal(BorderStyle style)` 设置左上右下和左下右上的边框样式
`Border`	`setDiagonal(BorderStyle style, Color color)` 设置左上右下和左下右上的边框样式和颜色
`Border`	`setDiagonalDown(BorderStyle style)` 设置左上到右下的边框样式
`Border`	`setDiagonalDown(BorderStyle style, Color color)` 设置左上到右下边框样式和颜色
`Border`	`setDiagonalUp(BorderStyle style)` 设置左下到右上的边框样式
`Border`	`setDiagonalUp(BorderStyle style, Color color)` 设置左下到右上边框样式和颜色
`org.dom4j.Element`	`toDom(org.dom4j.Element root)`
`String`	`toString()`
`protected void`	`writeProperties(org.dom4j.Element element, Border.SubBorder subBorder)`

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Border
```
public Border()
```
    创建一个无边框的边框样式
  - Border
```
public Border(BorderStyle style,
              Color color)
```
    实例化上-下-左-右四个方位的边框样式
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
- 方法详细资料
  - setBorderTop
```
public Border setBorderTop(BorderStyle style)
```
    设置上边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setBorderRight
```
public Border setBorderRight(BorderStyle style)
```
    设置右边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setBorderBottom
```
public Border setBorderBottom(BorderStyle style)
```
    设置下边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setBorderLeft
```
public Border setBorderLeft(BorderStyle style)
```
    设置上边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setDiagonalDown
```
public Border setDiagonalDown(BorderStyle style)
```
    设置左上到右下的边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setDiagonalUp
```
public Border setDiagonalUp(BorderStyle style)
```
    设置左下到右上的边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setBorder
```
public Border setBorder(BorderStyle style)
```
    设置上-下-左-右四个方位的边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setDiagonal
```
public Border setDiagonal(BorderStyle style)
```
    设置左上右下和左下右上的边框样式
    
    参数:
    
    style - 边框样式
    
    返回:
    
    当前边框
  - setBorderTop
```
public Border setBorderTop(BorderStyle style,
                           Color color)
```
    设置上边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setBorderRight
```
public Border setBorderRight(BorderStyle style,
                             Color color)
```
    设置右边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setBorderBottom
```
public Border setBorderBottom(BorderStyle style,
                              Color color)
```
    设置下边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setBorderLeft
```
public Border setBorderLeft(BorderStyle style,
                            Color color)
```
    设置左边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setDiagonalDown
```
public Border setDiagonalDown(BorderStyle style,
                              Color color)
```
    设置左上到右下边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setDiagonalUp
```
public Border setDiagonalUp(BorderStyle style,
                            Color color)
```
    设置左下到右上边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setDiagonal
```
public Border setDiagonal(BorderStyle style,
                          Color color)
```
    设置左上右下和左下右上的边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - setBorder
```
public Border setBorder(BorderStyle style,
                        Color color)
```
    设置上-下-左-右四个方位的边框样式和颜色
    
    参数:
    
    style - 边框样式
    
    color - 边框颜色
    
    返回:
    
    当前边框
  - getBorderTop
```
public Border.SubBorder getBorderTop()
```
    获取上边框样式
    
    返回:
    
    Border.SubBorder
  - getBorderRight
```
public Border.SubBorder getBorderRight()
```
    获取右边框样式
    
    返回:
    
    Border.SubBorder
  - getBorderBottom
```
public Border.SubBorder getBorderBottom()
```
    获取下边框样式
    
    返回:
    
    Border.SubBorder
  - getBorderLeft
```
public Border.SubBorder getBorderLeft()
```
    获取左边框样式
    
    返回:
    
    Border.SubBorder
  - getDiagonalDown
```
public Border.SubBorder getDiagonalDown()
```
    获取左上到右下边框样式
    
    返回:
    
    Border.SubBorder
  - getDiagonalUp
```
public Border.SubBorder getDiagonalUp()
```
    获取左下到右上边框样式
    
    返回:
    
    Border.SubBorder
  - getBorder
```
public Border.SubBorder getBorder(int axis)
```
    获取指定位置的边框样式
    
    参数:
    
    axis - 位置取值0-5, 对应left-right-top-bottom-diagonalDown-diagonalUp
    
    返回:
    
    边框样式
  - getBorders
```
public Border.SubBorder[] getBorders()
```
    获取所有位置的边框样式
    
    返回:
    
    边框样式
  - delBorder
```
public Border delBorder(int index)
```
    删除某个位置的边框
    
    参数:
    
    index - 位置取值0-5, 对应left-right-top-bottom-diagonalDown-diagonalUp
    
    返回:
    
    当前边框
  - isEffectiveBorder
```
public boolean isEffectiveBorder()
```
    检查边框是否有效（样式不为NONE)
    
    返回:
    
    true有效
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - parse
```
public static Border parse(String text)
```
    The setting order is top -> right -> bottom -> left, the attribute order is style-name + color, if the orientation setting is not complete, the unset orientation has no border. If only the orientation is not set, the last color will be complemented.
    eq:
    thin red
    
    thin red thin dashed dashed
    
    medium black thick #cccccc double black hair green
    
    none none thin thin
    
    参数:
    
    text - the border value
    
    返回:
    
    the parse value of Border
    
    抛出:
    
    IllegalArgumentException - if convert failed.
  - toDom
```
public org.dom4j.Element toDom(org.dom4j.Element root)
```
  - domToBorder
```
public static List<Border> domToBorder(org.dom4j.Element root,
                                       Color[] indexedColors)
```
    解析Dom树并转为边框对象
    
    参数:
    
    root - dom树
    
    indexedColors - 特殊indexed颜色（大部分情况下为null）
    
    返回:
    
    边框
  - domToBorder
```
public static List<Border> domToBorder(org.dom4j.Element root)
```
    解析Dom树并转为边框对象
    
    参数:
    
    root - dom树
    
    返回:
    
    边框
  - writeProperties
```
protected void writeProperties(org.dom4j.Element element,
                               Border.SubBorder subBorder)
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - clone
```
public Border clone()
```
    覆盖:
    
    clone 在类中 Object

类 Border

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Border

Border

方法详细资料

setBorderTop

setBorderRight

setBorderBottom

setBorderLeft

setDiagonalDown

setDiagonalUp

setBorder

setDiagonal

setBorderTop

setBorderRight

setBorderBottom

setBorderLeft

setDiagonalDown

setDiagonalUp

setDiagonal

setBorder

getBorderTop

getBorderRight

getBorderBottom

getBorderLeft

getDiagonalDown

getDiagonalUp

getBorder

getBorders

delBorder

isEffectiveBorder

hashCode

equals

parse

toDom

domToBorder

domToBorder

writeProperties

toString

clone