*/
@Override
public void createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow) {
- CTSheetView ctView = getDefaultSheetView();
+ final boolean removeSplit = colSplit == 0 && rowSplit == 0;
+ final CTSheetView ctView = getDefaultSheetView(!removeSplit);
+
+ if (ctView != null) {
+ ctView.setSelectionArray(null);
+ }
// If both colSplit and rowSplit are zero then the existing freeze pane is removed
- if(colSplit == 0 && rowSplit == 0){
- if(ctView.isSetPane()) {
+ if (removeSplit) {
+ if (ctView != null && ctView.isSetPane()) {
ctView.unsetPane();
}
- ctView.setSelectionArray(null);
return;
}
- if (!ctView.isSetPane()) {
- ctView.addNewPane();
- }
- CTPane pane = ctView.getPane();
+ assert(ctView != null);
+ final CTPane pane = (ctView.isSetPane()) ? ctView.getPane() : ctView.addNewPane();
+ assert(pane != null);
if (colSplit > 0) {
pane.setXSplit(colSplit);
- } else {
- if(pane.isSetXSplit()) {
- pane.unsetXSplit();
- }
+ } else if (pane.isSetXSplit()) {
+ pane.unsetXSplit();
}
if (rowSplit > 0) {
pane.setYSplit(rowSplit);
- } else {
- if(pane.isSetYSplit()) {
- pane.unsetYSplit();
- }
+ } else if(pane.isSetYSplit()) {
+ pane.unsetYSplit();
}
- pane.setState(STPaneState.FROZEN);
+ STPane.Enum activePane = STPane.BOTTOM_RIGHT;
+ int pRow = topRow, pCol = leftmostColumn;
if (rowSplit == 0) {
- pane.setTopLeftCell(new CellReference(0, leftmostColumn).formatAsString());
- pane.setActivePane(STPane.TOP_RIGHT);
+ pRow = 0;
+ activePane = STPane.TOP_RIGHT;
} else if (colSplit == 0) {
- pane.setTopLeftCell(new CellReference(topRow, 0).formatAsString());
- pane.setActivePane(STPane.BOTTOM_LEFT);
- } else {
- pane.setTopLeftCell(new CellReference(topRow, leftmostColumn).formatAsString());
- pane.setActivePane(STPane.BOTTOM_RIGHT);
+ pCol = 0;
+ activePane = STPane.BOTTOM_LEFT;
}
- ctView.setSelectionArray(null);
- CTSelection sel = ctView.addNewSelection();
- sel.setPane(pane.getActivePane());
+ pane.setState(STPaneState.FROZEN);
+ pane.setTopLeftCell(new CellReference(pRow, pCol).formatAsString());
+ pane.setActivePane(activePane);
+
+ ctView.addNewSelection().setPane(activePane);
}
/**
@Override
public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane) {
createFreezePane(xSplitPos, ySplitPos, leftmostColumn, topRow);
- getPane().setState(STPaneState.SPLIT);
- getPane().setActivePane(STPane.Enum.forInt(activePane));
+ if (xSplitPos > 0 || ySplitPos > 0) {
+ final CTPane pane = getPane(true);
+ pane.setState(STPaneState.SPLIT);
+ pane.setActivePane(STPane.Enum.forInt(activePane));
+ }
}
/**
*/
@Override
public void setRightToLeft(boolean value) {
- CTSheetView view = getDefaultSheetView();
- view.setRightToLeft(value);
+ final CTSheetView dsv = getDefaultSheetView(true);
+ assert(dsv != null);
+ dsv.setRightToLeft(value);
}
/**
*/
@Override
public boolean isRightToLeft() {
- CTSheetView view = getDefaultSheetView();
- return view != null && view.getRightToLeft();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ return (dsv != null && dsv.getRightToLeft());
}
/**
* Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
* When false, cells with zero value appear blank instead of showing the number zero.
*
- * @return whether all zero values on the worksheet are displayed
+ * @return whether all zero values on the worksheet are displayed (defaults to true)
*/
@Override
public boolean isDisplayZeros(){
- CTSheetView view = getDefaultSheetView();
- return view == null || view.getShowZeros();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ return (dsv != null) ? dsv.getShowZeros() : true;
}
/**
*/
@Override
public void setDisplayZeros(boolean value){
- CTSheetView view = getSheetTypeSheetView();
+ final CTSheetView view = getDefaultSheetView(true);
+ assert(view != null);
view.setShowZeros(value);
}
*/
@Override
public PaneInformation getPaneInformation() {
- CTPane pane = getDefaultSheetView().getPane();
+ final CTPane pane = getPane(false);
// no pane configured
if(pane == null) {
return null;
}
- CellReference cellRef = pane.isSetTopLeftCell() ? new CellReference(pane.getTopLeftCell()) : null;
- return new PaneInformation((short)pane.getXSplit(), (short)pane.getYSplit(),
- (short)(cellRef == null ? 0 : cellRef.getRow()),(cellRef == null ? 0 : cellRef.getCol()),
- (byte)(pane.getActivePane().intValue() - 1), pane.getState() == STPaneState.FROZEN);
+ short row = 0, col = 0;
+ if (pane.isSetTopLeftCell()) {
+ final CellReference cellRef = new CellReference(pane.getTopLeftCell());
+ row = (short)cellRef.getRow();
+ col = (short)cellRef.getCol();
+ }
+
+ final short x = (short)pane.getXSplit();
+ final short y = (short)pane.getYSplit();
+ final byte active = (byte)(pane.getActivePane().intValue() - 1);
+ final boolean frozen = pane.getState() == STPaneState.FROZEN;
+
+ return new PaneInformation(x, y, row, col, active, frozen);
}
/**
*/
@Override
public short getTopRow() {
- String cellRef = getSheetTypeSheetView().getTopLeftCell();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ final String cellRef = (dsv == null) ? null : dsv.getTopLeftCell();
if(cellRef == null) {
return 0;
}
- CellReference cellReference = new CellReference(cellRef);
- return (short) cellReference.getRow();
+ return (short) new CellReference(cellRef).getRow();
}
/**
*/
@Override
public boolean isDisplayFormulas() {
- return getSheetTypeSheetView().getShowFormulas();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ return (dsv != null) ? dsv.getShowFormulas() : false;
}
/**
* Gets the flag indicating whether this sheet displays the lines
* between rows and columns to make editing and reading easier.
*
- * @return <code>true</code> if this sheet displays gridlines.
+ * @return <code>true</code> (default) if this sheet displays gridlines.
* @see #isPrintGridlines() to check if printing of gridlines is turned on or off
*/
@Override
public boolean isDisplayGridlines() {
- return getSheetTypeSheetView().getShowGridLines();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ return (dsv != null) ? dsv.getShowGridLines() : true;
}
/**
*/
@Override
public void setDisplayGridlines(boolean show) {
- getSheetTypeSheetView().setShowGridLines(show);
+ final CTSheetView dsv = getDefaultSheetView(true);
+ assert(dsv != null);
+ dsv.setShowGridLines(show);
}
/**
* Column heading are the letters or numbers that appear above the columns of the sheet
* </p>
*
- * @return <code>true</code> if this sheet should display row and column headings.
+ * @return <code>true</code> (default) if this sheet should display row and column headings.
*/
@Override
public boolean isDisplayRowColHeadings() {
- return getSheetTypeSheetView().getShowRowColHeaders();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ return (dsv != null) ? dsv.getShowRowColHeaders() : true;
}
/**
*/
@Override
public void setDisplayRowColHeadings(boolean show) {
- getSheetTypeSheetView().setShowRowColHeaders(show);
+ final CTSheetView dsv = getDefaultSheetView(true);
+ assert(dsv != null);
+ dsv.setShowRowColHeaders(show);
}
/**
*/
@Override
public void setDisplayFormulas(boolean show) {
- getSheetTypeSheetView().setShowFormulas(show);
- }
-
- private CTSheetView getSheetTypeSheetView() {
- if (getDefaultSheetView() == null) {
- getSheetTypeSheetViews().setSheetViewArray(0, CTSheetView.Factory.newInstance());
- }
- return getDefaultSheetView();
+ final CTSheetView dsv = getDefaultSheetView(true);
+ assert(dsv != null);
+ dsv.setShowFormulas(show);
}
/**
if (scale < 10 || scale > 400) {
throw new IllegalArgumentException("Valid scale values range from 10 to 400");
}
- getSheetTypeSheetView().setZoomScale(scale);
+ final CTSheetView dsv = getDefaultSheetView(true);
+ assert(dsv != null);
+ dsv.setZoomScale(scale);
}
*/
@Override
public void showInPane(int toprow, int leftcol) {
- CellReference cellReference = new CellReference(toprow, leftcol);
- String cellRef = cellReference.formatAsString();
- getPane().setTopLeftCell(cellRef);
+ final CellReference cellReference = new CellReference(toprow, leftcol);
+ final String cellRef = cellReference.formatAsString();
+ final CTPane pane = getPane(true);
+ assert(pane != null);
+ pane.setTopLeftCell(cellRef);
}
@Override
getSheetTypeSheetFormatPr().setOutlineLevelCol(maxLevelCol);
}
- private CTSheetViews getSheetTypeSheetViews() {
- if (worksheet.getSheetViews() == null) {
- worksheet.setSheetViews(CTSheetViews.Factory.newInstance());
- worksheet.getSheetViews().addNewSheetView();
+ protected CTSheetViews getSheetTypeSheetViews(final boolean create) {
+ final CTSheetViews views = (worksheet.isSetSheetViews() || !create)
+ ? worksheet.getSheetViews() : worksheet.addNewSheetViews();
+ assert(views != null || !create);
+ if (views == null) {
+ return null;
+ }
+ if (views.sizeOfSheetViewArray() == 0 && create) {
+ views.addNewSheetView();
}
- return worksheet.getSheetViews();
+ return views;
}
/**
*/
@Override
public boolean isSelected() {
- CTSheetView view = getDefaultSheetView();
- return view != null && view.getTabSelected();
+ final CTSheetView dsv = getDefaultSheetView(false);
+ return (dsv != null) ? dsv.getTabSelected() : false;
}
/**
*/
@Override
public void setSelected(boolean value) {
- CTSheetViews views = getSheetTypeSheetViews();
+ final CTSheetViews views = getSheetTypeSheetViews(true);
+ assert(views != null);
for (CTSheetView view : views.getSheetViewArray()) {
view.setTabSelected(value);
}
*/
@Override
public CellAddress getActiveCell() {
- String address = getSheetTypeSelection().getActiveCell();
- if (address == null) {
- return null;
- }
- return new CellAddress(address);
+ final CTSelection sts = getSheetTypeSelection(false);
+ final String address = (sts != null) ? sts.getActiveCell() : null;
+ return (address != null) ? new CellAddress(address) : null;
}
/**
*/
@Override
public void setActiveCell(CellAddress address) {
+ final CTSelection ctsel = getSheetTypeSelection(true);
+ assert(ctsel != null);
String ref = address.formatAsString();
- CTSelection ctsel = getSheetTypeSelection();
ctsel.setActiveCell(ref);
ctsel.setSqref(Collections.singletonList(ref));
}
return sheetComments == null ? 0 : sheetComments.getNumberOfComments();
}
- private CTSelection getSheetTypeSelection() {
- if (getSheetTypeSheetView().sizeOfSelectionArray() == 0) {
- getSheetTypeSheetView().insertNewSelection(0);
+ private CTSelection getSheetTypeSelection(final boolean create) {
+ final CTSheetView dsv = getDefaultSheetView(create);
+ assert(dsv != null || !create);
+ if (dsv == null) {
+ return null;
+ }
+ final int sz = dsv.sizeOfSelectionArray();
+ if (sz == 0) {
+ return create ? dsv.addNewSelection() : null;
}
- return getSheetTypeSheetView().getSelectionArray(0);
+ return dsv.getSelectionArray(sz - 1);
}
/**
* When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
* workbookView entries) are saved."
*/
- private CTSheetView getDefaultSheetView() {
- CTSheetViews views = getSheetTypeSheetViews();
+ private CTSheetView getDefaultSheetView(final boolean create) {
+ final CTSheetViews views = getSheetTypeSheetViews(create);
+ assert(views != null || !create);
if (views == null) {
return null;
}
- int sz = views.sizeOfSheetViewArray();
+ final int sz = views.sizeOfSheetViewArray();
+ assert(sz > 0 || !create);
return (sz == 0) ? null : views.getSheetViewArray(sz - 1);
}
return false;
}
- private CTPane getPane() {
- if (getDefaultSheetView().getPane() == null) {
- getDefaultSheetView().addNewPane();
+ private CTPane getPane(final boolean create) {
+ final CTSheetView dsv = getDefaultSheetView(create);
+ assert(dsv != null || !create);
+ if (dsv == null) {
+ return null;
}
- return getDefaultSheetView().getPane();
+ return (dsv.isSetPane() || !create) ? dsv.getPane() : dsv.addNewPane();
}
/**
import java.util.HashMap;
import java.util.List;
import java.util.Collections;
+import java.util.function.Consumer;
+import java.util.function.Function;
+import java.util.function.Supplier;
import org.apache.poi.ooxml.POIXMLDocumentPart;
import org.apache.poi.util.Internal;
* <p>Specifies the contents of a table present in the document. A table is a set
* of paragraphs (and other block-level content) arranged in rows and columns.</p>
*/
+@SuppressWarnings("WeakerAccess")
public class XWPFTable implements IBodyElement, ISDTContents {
- private static EnumMap<XWPFBorderType, STBorder.Enum> xwpfBorderTypeMap;
+
+ // Create a map from this XWPF-level enum to the STBorder.Enum values
+ public enum XWPFBorderType {
+ NIL, NONE, SINGLE, THICK, DOUBLE, DOTTED, DASHED, DOT_DASH, DOT_DOT_DASH, TRIPLE,
+ THIN_THICK_SMALL_GAP, THICK_THIN_SMALL_GAP, THIN_THICK_THIN_SMALL_GAP,
+ THIN_THICK_MEDIUM_GAP, THICK_THIN_MEDIUM_GAP, THIN_THICK_THIN_MEDIUM_GAP,
+ THIN_THICK_LARGE_GAP, THICK_THIN_LARGE_GAP, THIN_THICK_THIN_LARGE_GAP,
+ WAVE, DOUBLE_WAVE, DASH_SMALL_GAP, DASH_DOT_STROKED, THREE_D_EMBOSS, THREE_D_ENGRAVE,
+ OUTSET, INSET;
+ }
+
+ private enum Border { INSIDE_V, INSIDE_H, LEFT, TOP, BOTTOM, RIGHT }
+
+ private static final EnumMap<XWPFBorderType, STBorder.Enum> xwpfBorderTypeMap;
// Create a map from the STBorder.Enum values to the XWPF-level enums
- private static HashMap<Integer, XWPFBorderType> stBorderTypeMap;
+ private static final HashMap<Integer, XWPFBorderType> stBorderTypeMap;
static {
// populate enum maps
* @param force - force creation of CTTblPr element if necessary
*/
private CTTblPr getTblPr(boolean force) {
- return (ctTbl.getTblPr() != null) ? ctTbl.getTblPr()
+ return (ctTbl.getTblPr() != null) ? ctTbl.getTblPr()
: (force ? ctTbl.addNewTblPr() : null);
}
: force ? tblPr.addNewTblBorders()
: null;
}
-
- /**
- * Return CTBorder object for Inside Vertical border. If force parameter is true,
- * will create the element if necessary. If force parameter is false, returns
- * null when Inside Vertical border is missing.
- *
- * @param force - force creation of Inside Vertical border if necessary.
- */
- private CTBorder getTblInsideVBorder(boolean force) {
- CTTblBorders ctb = getTblBorders(force);
- return ctb == null ? null
- : ctb.isSetInsideV() ? ctb.getInsideV()
- : force ? ctb.addNewInsideV()
- : null;
- }
-
- /**
- * Return CTBorder object for Inside Horizontal border. If force parameter is true,
- * will create the element if necessary. If force parameter is false, returns
- * null when Inside Horizontal border is missing.
- *
- * @param force - force creation of Inside Horizontal border if necessary.
- */
- private CTBorder getTblInsideHBorder(boolean force) {
- CTTblBorders ctb = getTblBorders(force);
- return ctb == null ? null
- : ctb.isSetInsideH() ? ctb.getInsideH()
- : force ? ctb.addNewInsideH()
- : null;
- }
- /**
- * Return CTBorder object for Top border. If force parameter is true,
- * will create the element if necessary. If force parameter is false, returns
- * null when Top border is missing.
- *
- * @param force - force creation of Top border if necessary.
- */
- private CTBorder getTblTopBorder(boolean force) {
- CTTblBorders ctb = getTblBorders(force);
- return ctb == null ? null
- : ctb.isSetTop() ? ctb.getTop()
- : force ? ctb.addNewTop()
- : null;
- }
/**
- * Return CTBorder object for Bottom border. If force parameter is true,
- * will create the element if necessary. If force parameter is false, returns
- * null when Bottom border is missing.
+ * Return CTBorder object for given border. If force parameter is true,
+ * will create the element if necessary. If force parameter is false, returns
+ * null when the border element is missing.
*
- * @param force - force creation of Bottom border if necessary.
- */
- private CTBorder getTblBottomBorder(boolean force) {
- CTTblBorders ctb = getTblBorders(force);
- return ctb == null ? null
- : ctb.isSetBottom() ? ctb.getBottom()
- : force ? ctb.addNewBottom()
- : null;
- }
+ * @param force - force creation of border if necessary.
+ */
+ private CTBorder getTblBorder(boolean force, Border border) {
+ final Function<CTTblBorders,Boolean> isSet;
+ final Function<CTTblBorders,CTBorder> get;
+ final Function<CTTblBorders,CTBorder> addNew;
+ switch (border) {
+ case INSIDE_V:
+ isSet = CTTblBorders::isSetInsideV;
+ get = CTTblBorders::getInsideV;
+ addNew = CTTblBorders::addNewInsideV;
+ break;
+ case INSIDE_H:
+ isSet = CTTblBorders::isSetInsideH;
+ get = CTTblBorders::getInsideH;
+ addNew = CTTblBorders::addNewInsideH;
+ break;
+ case LEFT:
+ isSet = CTTblBorders::isSetLeft;
+ get = CTTblBorders::getLeft;
+ addNew = CTTblBorders::addNewLeft;
+ break;
+ case TOP:
+ isSet = CTTblBorders::isSetTop;
+ get = CTTblBorders::getTop;
+ addNew = CTTblBorders::addNewTop;
+ break;
+ case RIGHT:
+ isSet = CTTblBorders::isSetRight;
+ get = CTTblBorders::getRight;
+ addNew = CTTblBorders::addNewRight;
+ break;
+ case BOTTOM:
+ isSet = CTTblBorders::isSetBottom;
+ get = CTTblBorders::getBottom;
+ addNew = CTTblBorders::addNewBottom;
+ break;
+ default:
+ return null;
+ }
- /**
- * Return CTBorder object for Left border. If force parameter is true,
- * will create the element if necessary. If force parameter is false, returns
- * null when Left border is missing.
- *
- * @param force - force creation of Left border if necessary.
- */
- private CTBorder getTblLeftBorder(boolean force) {
CTTblBorders ctb = getTblBorders(force);
return ctb == null ? null
- : ctb.isSetLeft() ? ctb.getLeft()
- : force ? ctb.addNewLeft()
- : null;
+ : isSet.apply(ctb) ? get.apply(ctb)
+ : force ? addNew.apply(ctb)
+ : null;
}
- /**
- * Return CTBorder object for Right border. If force parameter is true,
- * will create the element if necessary. If force parameter is false, returns
- * null when Right border is missing.
- *
- * @param force - force creation of Right border if necessary.
- */
- private CTBorder getTblRightBorder(boolean force) {
- CTTblBorders ctb = getTblBorders(force);
- return ctb == null ? null
- : ctb.isSetRight() ? ctb.getRight()
- : force ? ctb.addNewRight()
- : null;
- }
-
/**
* Returns the current table alignment or NULL
*
* @return {@link XWPFBorderType} of the inside horizontal borders or null if missing
*/
public XWPFBorderType getInsideHBorderType() {
- CTBorder b = getTblInsideHBorder(false);
- return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ return getBorderType(Border.INSIDE_H);
}
/**
* -1 if missing.
*/
public int getInsideHBorderSize() {
- CTBorder b = getTblInsideHBorder(false);
- return (b != null)
- ? (b.isSetSz() ? b.getSz().intValue() : -1)
- : -1;
+ return getBorderSize(Border.INSIDE_H);
}
/**
* -1 if missing.
*/
public int getInsideHBorderSpace() {
- CTBorder b = getTblInsideHBorder(false);
- return (b != null)
- ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
- : -1;
+ return getBorderSpace(Border.INSIDE_H);
}
/**
* @return The color of the Inside Horizontal borders, null if missing.
*/
public String getInsideHBorderColor() {
- CTBorder b = getTblInsideHBorder(false);
- return (b != null)
- ? (b.isSetColor() ? b.xgetColor().getStringValue() : null)
- : null;
+ return getBorderColor(Border.INSIDE_H);
}
/**
* @return {@link XWPFBorderType} of the inside vertical borders or null if missing
*/
public XWPFBorderType getInsideVBorderType() {
- CTBorder b = getTblInsideVBorder(false);
- return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ return getBorderType(Border.INSIDE_V);
}
/**
* -1 if missing.
*/
public int getInsideVBorderSize() {
- CTBorder b = getTblInsideVBorder(false);
- return (b != null)
- ? (b.isSetSz() ? b.getSz().intValue() : -1)
- : -1;
+ return getBorderSize(Border.INSIDE_V);
}
/**
* -1 if missing.
*/
public int getInsideVBorderSpace() {
- CTBorder b = getTblInsideVBorder(false);
- return (b != null)
- ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
- : -1;
+ return getBorderSpace(Border.INSIDE_V);
}
/**
* @return The color of the Inside vertical borders, null if missing.
*/
public String getInsideVBorderColor() {
- CTBorder b = getTblInsideVBorder(false);
- return (b != null)
- ? (b.isSetColor() ? b.xgetColor().getStringValue() : null)
- : null;
+ return getBorderColor(Border.INSIDE_V);
}
/**
* @return {@link XWPFBorderType} of the top borders or null if missing
*/
public XWPFBorderType getTopBorderType() {
- CTBorder b = getTblTopBorder(false);
- return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ return getBorderType(Border.TOP);
}
/**
* -1 if missing.
*/
public int getTopBorderSize() {
- CTBorder b = getTblTopBorder(false);
- return (b != null)
- ? (b.isSetSz() ? b.getSz().intValue() : -1)
- : -1;
+ return getBorderSize(Border.TOP);
}
/**
* -1 if missing.
*/
public int getTopBorderSpace() {
- CTBorder b = getTblTopBorder(false);
- return (b != null)
- ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
- : -1;
+ return getBorderSpace(Border.TOP);
}
/**
* @return The color of the top borders, null if missing.
*/
public String getTopBorderColor() {
- CTBorder b = getTblTopBorder(false);
- return (b != null)
- ? (b.isSetColor() ? b.xgetColor().getStringValue() : null)
- : null;
+ return getBorderColor(Border.TOP);
}
/**
* @return {@link XWPFBorderType} of the bottom borders or null if missing
*/
public XWPFBorderType getBottomBorderType() {
- CTBorder b = getTblBottomBorder(false);
- return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ return getBorderType(Border.BOTTOM);
}
/**
* -1 if missing.
*/
public int getBottomBorderSize() {
- CTBorder b = getTblBottomBorder(false);
- return (b != null)
- ? (b.isSetSz() ? b.getSz().intValue() : -1)
- : -1;
+ return getBorderSize(Border.BOTTOM);
}
/**
* -1 if missing.
*/
public int getBottomBorderSpace() {
- CTBorder b = getTblBottomBorder(false);
- return (b != null)
- ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
- : -1;
+ return getBorderSpace(Border.BOTTOM);
}
/**
* @return The color of the bottom borders, null if missing.
*/
public String getBottomBorderColor() {
- CTBorder b = getTblBottomBorder(false);
- return (b != null)
- ? (b.isSetColor() ? b.xgetColor().getStringValue() : null)
- : null;
+ return getBorderColor(Border.BOTTOM);
}
/**
* @return {@link XWPFBorderType} of the Left borders or null if missing
*/
public XWPFBorderType getLeftBorderType() {
- CTBorder b = getTblLeftBorder(false);
- return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ return getBorderType(Border.LEFT);
}
/**
* -1 if missing.
*/
public int getLeftBorderSize() {
- CTBorder b = getTblLeftBorder(false);
- return (b != null)
- ? (b.isSetSz() ? b.getSz().intValue() : -1)
- : -1;
+ return getBorderSize(Border.LEFT);
}
/**
* -1 if missing.
*/
public int getLeftBorderSpace() {
- CTBorder b = getTblLeftBorder(false);
- return (b != null)
- ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
- : -1;
+ return getBorderSpace(Border.LEFT);
}
/**
* @return The color of the Left borders, null if missing.
*/
public String getLeftBorderColor() {
- CTBorder b = getTblLeftBorder(false);
- return (b != null)
- ? (b.isSetColor() ? b.xgetColor().getStringValue() : null)
- : null;
+ return getBorderColor(Border.LEFT);
}
/**
* @return {@link XWPFBorderType} of the Right borders or null if missing
*/
public XWPFBorderType getRightBorderType() {
- CTBorder b = getTblRightBorder(false);
- return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ return getBorderType(Border.RIGHT);
}
/**
* -1 if missing.
*/
public int getRightBorderSize() {
- CTBorder b = getTblRightBorder(false);
- return (b != null)
- ? (b.isSetSz() ? b.getSz().intValue() : -1)
- : -1;
+ return getBorderSize(Border.RIGHT);
}
/**
* -1 if missing.
*/
public int getRightBorderSpace() {
- CTBorder b = getTblRightBorder(false);
- return (b != null)
- ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
- : -1;
+ return getBorderSpace(Border.RIGHT);
}
/**
* @return The color of the Right borders, null if missing.
*/
public String getRightBorderColor() {
- CTBorder b = getTblRightBorder(false);
- return (b != null)
+ return getBorderColor(Border.RIGHT);
+ }
+
+ private XWPFBorderType getBorderType(Border border) {
+ final CTBorder b = getTblBorder(false, border);
+ return (b != null) ? stBorderTypeMap.get(b.getVal().intValue()) : null;
+ }
+
+ private int getBorderSize(Border border) {
+ final CTBorder b = getTblBorder(false, border);
+ return (b != null)
+ ? (b.isSetSz() ? b.getSz().intValue() : -1)
+ : -1;
+ }
+
+ private int getBorderSpace(Border border) {
+ final CTBorder b = getTblBorder(false, border);
+ return (b != null)
+ ? (b.isSetSpace() ? b.getSpace().intValue() : -1)
+ : -1;
+ }
+
+ private String getBorderColor(Border border) {
+ final CTBorder b = getTblBorder(false, border);
+ return (b != null)
? (b.isSetColor() ? b.xgetColor().getStringValue() : null)
- : null;
+ : null;
}
public int getRowBandSize() {
* or auto to allow a consumer to automatically determine the border color as appropriate.
*/
public void setInsideHBorder(XWPFBorderType type, int size, int space, String rgbColor) {
- CTBorder b = getTblInsideHBorder(true);
- b.setVal(xwpfBorderTypeMap.get(type));
- b.setSz(BigInteger.valueOf(size));
- b.setSpace(BigInteger.valueOf(space));
- b.setColor(rgbColor);
+ setBorder(Border.INSIDE_H, type, size, space, rgbColor);
}
/**
* or auto to allow a consumer to automatically determine the border color as appropriate.
*/
public void setInsideVBorder(XWPFBorderType type, int size, int space, String rgbColor) {
- CTBorder b = getTblInsideVBorder(true);
- b.setVal(xwpfBorderTypeMap.get(type));
- b.setSz(BigInteger.valueOf(size));
- b.setSpace(BigInteger.valueOf(space));
- b.setColor(rgbColor);
+ setBorder(Border.INSIDE_V, type, size, space, rgbColor);
}
/**
* or auto to allow a consumer to automatically determine the border color as appropriate.
*/
public void setTopBorder(XWPFBorderType type, int size, int space, String rgbColor) {
- CTBorder b = getTblTopBorder(true);
- b.setVal(xwpfBorderTypeMap.get(type));
- b.setSz(BigInteger.valueOf(size));
- b.setSpace(BigInteger.valueOf(space));
- b.setColor(rgbColor);
+ setBorder(Border.TOP, type, size, space, rgbColor);
}
/**
* or auto to allow a consumer to automatically determine the border color as appropriate.
*/
public void setBottomBorder(XWPFBorderType type, int size, int space, String rgbColor) {
- CTBorder b = getTblBottomBorder(true);
- b.setVal(xwpfBorderTypeMap.get(type));
- b.setSz(BigInteger.valueOf(size));
- b.setSpace(BigInteger.valueOf(space));
- b.setColor(rgbColor);
+ setBorder(Border.BOTTOM, type, size, space, rgbColor);
}
/**
* or auto to allow a consumer to automatically determine the border color as appropriate.
*/
public void setLeftBorder(XWPFBorderType type, int size, int space, String rgbColor) {
- CTBorder b = getTblLeftBorder(true);
- b.setVal(xwpfBorderTypeMap.get(type));
- b.setSz(BigInteger.valueOf(size));
- b.setSpace(BigInteger.valueOf(space));
- b.setColor(rgbColor);
+ setBorder(Border.LEFT, type, size, space, rgbColor);
}
/**
* or auto to allow a consumer to automatically determine the border color as appropriate.
*/
public void setRightBorder(XWPFBorderType type, int size, int space, String rgbColor) {
- CTBorder b = getTblRightBorder(true);
+ setBorder(Border.RIGHT, type, size, space, rgbColor);
+ }
+
+ private void setBorder(Border border, XWPFBorderType type, int size, int space, String rgbColor) {
+ final CTBorder b = getTblBorder(true, border);
+ assert(b != null);
b.setVal(xwpfBorderTypeMap.get(type));
b.setSz(BigInteger.valueOf(size));
b.setSpace(BigInteger.valueOf(space));
b.setColor(rgbColor);
}
-
+
/**
* Remove inside horizontal borders for table
*/
public void removeInsideHBorder() {
- CTBorder b = getTblInsideHBorder(false);
- if (b != null) {
- getTblBorders(false).unsetInsideH();
- cleanupTblBorders();
- }
+ removeBorder(Border.INSIDE_H);
}
/**
* Remove inside vertical borders for table
*/
public void removeInsideVBorder() {
- CTBorder b = getTblInsideVBorder(false);
- if (b != null) {
- getTblBorders(false).unsetInsideV();
- cleanupTblBorders();
- }
+ removeBorder(Border.INSIDE_V);
}
/**
* Remove top borders for table
*/
public void removeTopBorder() {
- CTBorder b = getTblTopBorder(false);
- if (b != null) {
- getTblBorders(false).unsetTop();
- cleanupTblBorders();
- }
+ removeBorder(Border.TOP);
}
-
+
/**
* Remove bottom borders for table
*/
public void removeBottomBorder() {
- CTBorder b = getTblBottomBorder(false);
- if (b != null) {
- getTblBorders(false).unsetBottom();
- cleanupTblBorders();
- }
+ removeBorder(Border.BOTTOM);
}
/**
* Remove left borders for table
*/
public void removeLeftBorder() {
- CTBorder b = getTblLeftBorder(false);
- if (b != null) {
- getTblBorders(false).unsetLeft();
- cleanupTblBorders();
- }
+ removeBorder(Border.LEFT);
}
/**
* Remove right borders for table
*/
public void removeRightBorder() {
- CTBorder b = getTblRightBorder(false);
- if (b != null) {
- getTblBorders(false).unsetRight();
- cleanupTblBorders();
- }
+ removeBorder(Border.RIGHT);
}
/**
* Remove all borders from table
*/
public void removeBorders() {
- CTTblBorders b = getTblBorders(false);
- if (b != null) {
- getTblPr(false).unsetTblBorders();
+ final CTTblPr pr = getTblPr(false);
+ if (pr != null && pr.isSetTblBorders()) {
+ pr.unsetTblBorders();
}
}
-
+
+ private void removeBorder(final Border border) {
+ final Function<CTTblBorders,Boolean> isSet;
+ final Consumer<CTTblBorders> unSet;
+ switch (border) {
+ case INSIDE_H:
+ isSet = CTTblBorders::isSetInsideH;
+ unSet = CTTblBorders::unsetInsideH;
+ break;
+ case INSIDE_V:
+ isSet = CTTblBorders::isSetInsideV;
+ unSet = CTTblBorders::unsetInsideV;
+ break;
+ case LEFT:
+ isSet = CTTblBorders::isSetLeft;
+ unSet = CTTblBorders::unsetLeft;
+ break;
+ case TOP:
+ isSet = CTTblBorders::isSetTop;
+ unSet = CTTblBorders::unsetTop;
+ break;
+ case RIGHT:
+ isSet = CTTblBorders::isSetRight;
+ unSet = CTTblBorders::unsetRight;
+ break;
+ case BOTTOM:
+ isSet = CTTblBorders::isSetBottom;
+ unSet = CTTblBorders::unsetBottom;
+ break;
+ default:
+ return;
+ }
+
+ final CTTblBorders tbl = getTblBorders(false);
+ if (tbl != null && isSet.apply(tbl)) {
+ unSet.accept(tbl);
+ cleanupTblBorders();
+ }
+
+ }
+
/**
* removes the Borders node from Table properties if there are
* no border elements
*/
private void cleanupTblBorders() {
- CTTblBorders b = getTblBorders(false);
- if (b != null) {
- if (b.getInsideH() == null &&
- b.getInsideV() == null &&
- b.getTop() == null &&
- b.getBottom() == null &&
- b.getLeft() == null &&
- b.getRight() == null) {
- getTblPr(false).unsetTblBorders();
+ final CTTblPr pr = getTblPr(false);
+ if (pr != null && pr.isSetTblBorders()) {
+ final CTTblBorders b = pr.getTblBorders();
+ if (!(b.isSetInsideH() ||
+ b.isSetInsideV() ||
+ b.isSetTop() ||
+ b.isSetBottom() ||
+ b.isSetLeft() ||
+ b.isSetRight())) {
+ pr.unsetTblBorders();
}
}
}
public int getCellMarginTop() {
- int margin = 0;
- CTTblPr tblPr = getTblPr();
- CTTblCellMar tcm = tblPr.getTblCellMar();
- if (tcm != null) {
- CTTblWidth tw = tcm.getTop();
- if (tw != null) {
- margin = tw.getW().intValue();
- }
- }
- return margin;
+ return getCellMargin(CTTblCellMar::getTop);
}
public int getCellMarginLeft() {
- int margin = 0;
- CTTblPr tblPr = getTblPr();
- CTTblCellMar tcm = tblPr.getTblCellMar();
- if (tcm != null) {
- CTTblWidth tw = tcm.getLeft();
- if (tw != null) {
- margin = tw.getW().intValue();
- }
- }
- return margin;
+ return getCellMargin(CTTblCellMar::getLeft);
}
public int getCellMarginBottom() {
- int margin = 0;
- CTTblPr tblPr = getTblPr();
- CTTblCellMar tcm = tblPr.getTblCellMar();
- if (tcm != null) {
- CTTblWidth tw = tcm.getBottom();
- if (tw != null) {
- margin = tw.getW().intValue();
- }
- }
- return margin;
+ return getCellMargin(CTTblCellMar::getBottom);
}
public int getCellMarginRight() {
- int margin = 0;
+ return getCellMargin(CTTblCellMar::getRight);
+ }
+
+ private int getCellMargin(Function<CTTblCellMar,CTTblWidth> margin) {
CTTblPr tblPr = getTblPr();
CTTblCellMar tcm = tblPr.getTblCellMar();
if (tcm != null) {
- CTTblWidth tw = tcm.getRight();
+ CTTblWidth tw = margin.apply(tcm);
if (tw != null) {
- margin = tw.getW().intValue();
+ return tw.getW().intValue();
}
}
- return margin;
+ return 0;
}
public void setCellMargins(int top, int left, int bottom, int right) {
CTTblPr tblPr = getTblPr();
CTTblCellMar tcm = tblPr.isSetTblCellMar() ? tblPr.getTblCellMar() : tblPr.addNewTblCellMar();
- CTTblWidth tw = tcm.isSetLeft() ? tcm.getLeft() : tcm.addNewLeft();
- tw.setType(STTblWidth.DXA);
- tw.setW(BigInteger.valueOf(left));
-
- tw = tcm.isSetTop() ? tcm.getTop() : tcm.addNewTop();
- tw.setType(STTblWidth.DXA);
- tw.setW(BigInteger.valueOf(top));
-
- tw = tcm.isSetBottom() ? tcm.getBottom() : tcm.addNewBottom();
- tw.setType(STTblWidth.DXA);
- tw.setW(BigInteger.valueOf(bottom));
+ setCellMargin(tcm, CTTblCellMar::isSetTop, CTTblCellMar::getTop, CTTblCellMar::addNewTop, CTTblCellMar::unsetTop, top);
+ setCellMargin(tcm, CTTblCellMar::isSetLeft, CTTblCellMar::getLeft, CTTblCellMar::addNewLeft, CTTblCellMar::unsetLeft, left);
+ setCellMargin(tcm, CTTblCellMar::isSetBottom, CTTblCellMar::getBottom, CTTblCellMar::addNewBottom, CTTblCellMar::unsetBottom, bottom);
+ setCellMargin(tcm, CTTblCellMar::isSetRight, CTTblCellMar::getRight, CTTblCellMar::addNewRight, CTTblCellMar::unsetRight, right);
+ }
- tw = tcm.isSetRight() ? tcm.getRight() : tcm.addNewRight();
- tw.setType(STTblWidth.DXA);
- tw.setW(BigInteger.valueOf(right));
+ private void setCellMargin(CTTblCellMar tcm, Function<CTTblCellMar,Boolean> isSet, Function<CTTblCellMar,CTTblWidth> get, Function<CTTblCellMar,CTTblWidth> addNew, Consumer<CTTblCellMar> unSet, int margin) {
+ if (margin == 0) {
+ if (isSet.apply(tcm)) {
+ unSet.accept(tcm);
+ }
+ } else {
+ CTTblWidth tw = (isSet.apply(tcm) ? get : addNew).apply(tcm);
+ tw.setType(STTblWidth.DXA);
+ tw.setW(BigInteger.valueOf(margin));
+ }
}
/**
}
return null;
}
-
- // Create a map from this XWPF-level enum to the STBorder.Enum values
- public static enum XWPFBorderType {
- NIL, NONE, SINGLE, THICK, DOUBLE, DOTTED, DASHED, DOT_DASH, DOT_DOT_DASH, TRIPLE,
- THIN_THICK_SMALL_GAP, THICK_THIN_SMALL_GAP, THIN_THICK_THIN_SMALL_GAP,
- THIN_THICK_MEDIUM_GAP, THICK_THIN_MEDIUM_GAP, THIN_THICK_THIN_MEDIUM_GAP,
- THIN_THICK_LARGE_GAP, THICK_THIN_LARGE_GAP, THIN_THICK_THIN_LARGE_GAP,
- WAVE, DOUBLE_WAVE, DASH_SMALL_GAP, DASH_DOT_STROKED, THREE_D_EMBOSS, THREE_D_ENGRAVE,
- OUTSET, INSET;
- }
}
projects / poi.git / commitdiff