/**
* Various utility functions that make working with a region of cells easier.
*
- * @see {@link BorderPropertyTemplate} to store border changes to a data structure
- * and apply the changes to multiple sheets. <code>BorderPropertyTemplate</code>
+ * @see BorderPropertyTemplate <code>BorderPropertyTemplate</code>
+ * to store border changes to a data structure and apply the changes to
+ * multiple sheets. <code>BorderPropertyTemplate</code>
* also supports setting INTERNAL borders within a region.
- *
- * @author Eric Pugh epugh@upstate.com
- * @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
*/
public final class RegionUtil {
* Sets the left border for a region of cells by manipulating the cell style of the individual
* cells on the left
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
- * @deprecated 3.15 beta 2. Use {@link #setBorderLeft(int, CellRangeAddress, Sheet).
+ * @deprecated 3.15 beta 2. Use {@link #setBorderLeft(int, CellRangeAddress, Sheet)}
*/
public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet, Workbook workbook) {
setBorderLeft(border, region, sheet);
* Sets the left border for a region of cells by manipulating the cell style of the individual
* cells on the left
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet) {
* Sets the left border color for a region of cells by manipulating the cell style of the individual
* cells on the left
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
* Sets the left border color for a region of cells by manipulating the cell style of the individual
* cells on the left
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setLeftBorderColor(int color, CellRangeAddress region, Sheet sheet) {
* Sets the right border for a region of cells by manipulating the cell style of the individual
* cells on the right
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
* Sets the right border for a region of cells by manipulating the cell style of the individual
* cells on the right
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setBorderRight(int border, CellRangeAddress region, Sheet sheet) {
* Sets the right border color for a region of cells by manipulating the cell style of the individual
* cells on the right
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
* Sets the right border color for a region of cells by manipulating the cell style of the individual
* cells on the right
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setRightBorderColor(int color, CellRangeAddress region, Sheet sheet) {
* Sets the bottom border for a region of cells by manipulating the cell style of the individual
* cells on the bottom
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
- * @deprecated 3.15 beta 2. Use {@link #setBorderBottom(int, CellRangeAddress, Sheet).
+ * @deprecated 3.15 beta 2. Use {@link #setBorderBottom(int, CellRangeAddress, Sheet)}
*/
public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet, Workbook workbook) {
setBorderBottom(border, region, sheet);
* Sets the bottom border for a region of cells by manipulating the cell style of the individual
* cells on the bottom
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet) {
* Sets the bottom border color for a region of cells by manipulating the cell style of the individual
* cells on the bottom
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
* Sets the bottom border color for a region of cells by manipulating the cell style of the individual
* cells on the bottom
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setBottomBorderColor(int color, CellRangeAddress region, Sheet sheet) {
* Sets the top border for a region of cells by manipulating the cell style of the individual
* cells on the top
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
* Sets the top border for a region of cells by manipulating the cell style of the individual
* cells on the top
*
- * @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param border The new border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setBorderTop(int border, CellRangeAddress region, Sheet sheet) {
* Sets the top border color for a region of cells by manipulating the cell style of the individual
* cells on the top
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
* Sets the top border color for a region of cells by manipulating the cell style of the individual
* cells on the top
*
- * @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
+ * @see BorderPropertyTemplate#drawBorders
+ * <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
*
* @param color The color of the border
* @param region The region that should have the border
- * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on.
*/
public static void setTopBorderColor(int color, CellRangeAddress region, Sheet sheet) {