Package io.keikai.doc.io.schema.docx

Class DOCXTcBorders

java.lang.Object

io.keikai.doc.io.schema.docx.DOCXTcBorders

All Implemented Interfaces:

ICTElement

public class DOCXTcBorders
extends java.lang.Object
implements ICTElement

Internal Use Only.

TcBorders Definition.

Represents tcBorders in xml.

Author:

Jamson Chan

Constructor Summary

Constructors

Constructor	Description
DOCXTcBorders(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcBorders borders)	Create a new Borders by given CTTcBorders.

Method Summary

Modifier and Type	Method	Description
DOCXBorder[]	getBorders()	Returns all borders in the order of top, right, bottom, left.
DOCXBorder[]	getBorders(boolean create)	Returns all borders in the order of top, right, bottom, left.
DOCXBorder	getBottom()	Returns the bottom border.
DOCXBorder	getBottom(boolean create)	Returns the bottom border.
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcBorders	getCT()	Returns the CT object of current element.
DOCXBorder	getLeft()	Returns the left border.
DOCXBorder	getLeft(boolean create)	Returns the left border.
DOCXBorder	getRight()	Returns the right border.
DOCXBorder	getRight(boolean create)	Returns the right border.
DOCXBorder	getTop()	Returns the top border.
DOCXBorder	getTop(boolean create)	Returns the top border.
boolean	isBordersEmpty()	Returns whether all borders are empty.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DOCXTcBorders

public DOCXTcBorders(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcBorders borders)

Create a new Borders by given CTTcBorders.

Parameters:

borders - the CTTcBorders object.

Method Detail

getCT

public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcBorders getCT()

Description copied from interface: ICTElement

Returns the CT object of current element.

Specified by:

getCT in interface ICTElement

getBorders

public DOCXBorder[] getBorders()

Returns all borders in the order of top, right, bottom, left.

Returns:

all borders.

getBorders

public DOCXBorder[] getBorders(boolean create)

Returns all borders in the order of top, right, bottom, left.

Parameters:

create - whether to create new borders if any of them is not set.

Returns:

all borders.

isBordersEmpty

public boolean isBordersEmpty()

Returns whether all borders are empty.

Returns:

whether all borders are empty.

getTop

public DOCXBorder getTop()

Returns the top border.

Represents the following element tag in the schema: w:top.

Returns:

the top border.

getTop

public DOCXBorder getTop(boolean create)

Returns the top border.

Represents the following element tag in the schema: w:top.

Parameters:

create - whether to create a new border if it is not set.

Returns:

the top border.

getLeft

public DOCXBorder getLeft()

Returns the left border.

Represents the following element tag in the schema: w:left.

Returns:

the left border.

getLeft

public DOCXBorder getLeft(boolean create)

Returns the left border.

Represents the following element tag in the schema: w:left.

Parameters:

create - whether to create a new border if it is not set.

Returns:

the left border.

getBottom

public DOCXBorder getBottom()

Returns the bottom border.

Represents the following element tag in the schema: w:bottom.

Returns:

the bottom border.

getBottom

public DOCXBorder getBottom(boolean create)

Returns the bottom border.

Represents the following element tag in the schema: w:bottom.

Parameters:

create - whether to create a new border if it is not set.

Returns:

the bottom border.

getRight

public DOCXBorder getRight()

Returns the right border.

Represents the following element tag in the schema: w:right.

Returns:

the right border.

getRight

public DOCXBorder getRight(boolean create)

Returns the right border.

Represents the following element tag in the schema: w:right.

Parameters:

create - whether to create a new border if it is not set.

Returns:

the right border.