BorderCollection
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Iterable
public class BorderCollection implements Iterable
A collection of Border objects.
To learn more, visit the Programming with Documents documentation article.
Remarks:
Different document elements have different borders. For example, ParagraphFormat has getBottom(), getLeft(), getRight() and getTop() borders. You can specify different formatting for each border independently or enumerate through all borders and apply same formatting.
Examples:
Shows how to insert a paragraph with a top border.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Border topBorder = builder.getParagraphFormat().getBorders().getByBorderType(BorderType.TOP);
topBorder.setLineWidth(4.0d);
topBorder.setLineStyle(LineStyle.DASH_SMALL_GAP);
// Set ThemeColor only when LineWidth or LineStyle setted.
topBorder.setThemeColor(ThemeColor.ACCENT_1);
topBorder.setTintAndShade(0.25d);
builder.writeln("Text with a top border.");
doc.save(getArtifactsDir() + "Border.ParagraphTopBorder.docx");
Methods
| Method | Description |
|---|---|
| clearFormatting() | Removes all borders of an object. |
| equals(BorderCollection brColl) | Compares collections of borders. |
| get(int index) | Retrieves a Border object by index. |
| getBottom() | Gets the bottom border. |
| getByBorderType(int borderType) | |
| getColor() | Gets the border color. |
| getCount() | Gets the number of borders in the collection. |
| getDistanceFromText() | Gets distance of the border from text in points. |
| getHorizontal() | Gets the horizontal border that is used between cells or conforming paragraphs. |
| getLeft() | Gets the left border. |
| getLineStyle() | Gets the border style. |
| getLineWidth() | Gets the border width in points. |
| getRight() | Gets the right border. |
| getShadow() | Gets a value indicating whether the border has a shadow. |
| getTop() | Gets the top border. |
| getVertical() | Gets the vertical border that is used between cells. |
| iterator() | Returns an enumerator object that can be used to iterate over all borders in the collection. |
| setColor(Color value) | Sets the border color. |
| setDistanceFromText(double value) | Sets distance of the border from text in points. |
| setLineStyle(int value) | Sets the border style. |
| setLineWidth(double value) | Sets the border width in points. |
| setShadow(boolean value) | Sets a value indicating whether the border has a shadow. |
clearFormatting()
public void clearFormatting()
Removes all borders of an object.
Examples:
Shows how to remove all borders from all paragraphs in a document.
Document doc = new Document(getMyDir() + "Borders.docx");
// The first paragraph of this document has visible borders with these settings.
BorderCollection firstParagraphBorders = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBorders();
Assert.assertEquals(Color.RED.getRGB(), firstParagraphBorders.getColor().getRGB());
Assert.assertEquals(LineStyle.SINGLE, firstParagraphBorders.getLineStyle());
Assert.assertEquals(3.0d, firstParagraphBorders.getLineWidth());
// Use the "ClearFormatting" method on each paragraph to remove all borders.
for (Paragraph paragraph : doc.getFirstSection().getBody().getParagraphs()) {
paragraph.getParagraphFormat().getBorders().clearFormatting();
for (Border border : paragraph.getParagraphFormat().getBorders()) {
Assert.assertEquals(0, border.getColor().getRGB());
Assert.assertEquals(LineStyle.NONE, border.getLineStyle());
Assert.assertEquals(0.0d, border.getLineWidth());
}
}
doc.save(getArtifactsDir() + "BorderCollection.RemoveAllBorders.docx");
equals(BorderCollection brColl)
public boolean equals(BorderCollection brColl)
Compares collections of borders.
Examples:
Shows how border collections can share elements.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Paragraph 1.");
builder.write("Paragraph 2.");
// Since we used the same border configuration while creating
// these paragraphs, their border collections share the same elements.
BorderCollection firstParagraphBorders = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBorders();
BorderCollection secondParagraphBorders = builder.getCurrentParagraph().getParagraphFormat().getBorders();
for (int i = 0; i < firstParagraphBorders.getCount(); i++) {
Assert.assertTrue(firstParagraphBorders.get(i).equals(secondParagraphBorders.get(i)));
Assert.assertEquals(firstParagraphBorders.get(i).hashCode(), secondParagraphBorders.get(i).hashCode());
Assert.assertFalse(firstParagraphBorders.get(i).isVisible());
}
for (Border border : secondParagraphBorders)
border.setLineStyle(LineStyle.DOT_DASH);
// After changing the line style of the borders in just the second paragraph,
// the border collections no longer share the same elements.
for (int i = 0; i < firstParagraphBorders.getCount(); i++) {
Assert.assertFalse(firstParagraphBorders.get(i).equals(secondParagraphBorders.get(i)));
Assert.assertNotEquals(firstParagraphBorders.get(i).hashCode(), secondParagraphBorders.get(i).hashCode());
// Changing the appearance of an empty border makes it visible.
Assert.assertTrue(secondParagraphBorders.get(i).isVisible());
}
doc.save(getArtifactsDir() + "Border.SharedElements.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| brColl | BorderCollection |
Returns: boolean
get(int index)
public Border get(int index)
Retrieves a Border object by index.
Examples:
Shows how border collections can share elements.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Paragraph 1.");
builder.write("Paragraph 2.");
// Since we used the same border configuration while creating
// these paragraphs, their border collections share the same elements.
BorderCollection firstParagraphBorders = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBorders();
BorderCollection secondParagraphBorders = builder.getCurrentParagraph().getParagraphFormat().getBorders();
for (int i = 0; i < firstParagraphBorders.getCount(); i++) {
Assert.assertTrue(firstParagraphBorders.get(i).equals(secondParagraphBorders.get(i)));
Assert.assertEquals(firstParagraphBorders.get(i).hashCode(), secondParagraphBorders.get(i).hashCode());
Assert.assertFalse(firstParagraphBorders.get(i).isVisible());
}
for (Border border : secondParagraphBorders)
border.setLineStyle(LineStyle.DOT_DASH);
// After changing the line style of the borders in just the second paragraph,
// the border collections no longer share the same elements.
for (int i = 0; i < firstParagraphBorders.getCount(); i++) {
Assert.assertFalse(firstParagraphBorders.get(i).equals(secondParagraphBorders.get(i)));
Assert.assertNotEquals(firstParagraphBorders.get(i).hashCode(), secondParagraphBorders.get(i).hashCode());
// Changing the appearance of an empty border makes it visible.
Assert.assertTrue(secondParagraphBorders.get(i).isVisible());
}
doc.save(getArtifactsDir() + "Border.SharedElements.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | Zero-based index of the border to retrieve. |
Returns: Border - The corresponding Border value.
getBottom()
public Border getBottom()
Gets the bottom border.
Examples:
Shows how to apply border and shading color while building a table.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Start a table and set a default color/thickness for its borders.
Table table = builder.startTable();
table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
// Create a row with two cells with different background colors.
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
builder.writeln("Row 1, Cell 1.");
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
builder.writeln("Row 1, Cell 2.");
builder.endRow();
// Reset cell formatting to disable the background colors
// set a custom border thickness for all new cells created by the builder,
// then build a second row.
builder.getCellFormat().clearFormatting();
builder.getCellFormat().getBorders().getLeft().setLineWidth(4.0);
builder.getCellFormat().getBorders().getRight().setLineWidth(4.0);
builder.getCellFormat().getBorders().getTop().setLineWidth(4.0);
builder.getCellFormat().getBorders().getBottom().setLineWidth(4.0);
builder.insertCell();
builder.writeln("Row 2, Cell 1.");
builder.insertCell();
builder.writeln("Row 2, Cell 2.");
doc.save(getArtifactsDir() + "DocumentBuilder.TableBordersAndShading.docx");
Returns: Border - The bottom border.
getByBorderType(int borderType)
public Border getByBorderType(int borderType)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| borderType | int |
Returns: Border
getColor()
public Color getColor()
Gets the border color.
Remarks:
Returns the color of the first border in the collection.
Sets the color of all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Returns: java.awt.Color - The border color.
getCount()
public int getCount()
Gets the number of borders in the collection.
Examples:
Shows how border collections can share elements.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Paragraph 1.");
builder.write("Paragraph 2.");
// Since we used the same border configuration while creating
// these paragraphs, their border collections share the same elements.
BorderCollection firstParagraphBorders = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBorders();
BorderCollection secondParagraphBorders = builder.getCurrentParagraph().getParagraphFormat().getBorders();
for (int i = 0; i < firstParagraphBorders.getCount(); i++) {
Assert.assertTrue(firstParagraphBorders.get(i).equals(secondParagraphBorders.get(i)));
Assert.assertEquals(firstParagraphBorders.get(i).hashCode(), secondParagraphBorders.get(i).hashCode());
Assert.assertFalse(firstParagraphBorders.get(i).isVisible());
}
for (Border border : secondParagraphBorders)
border.setLineStyle(LineStyle.DOT_DASH);
// After changing the line style of the borders in just the second paragraph,
// the border collections no longer share the same elements.
for (int i = 0; i < firstParagraphBorders.getCount(); i++) {
Assert.assertFalse(firstParagraphBorders.get(i).equals(secondParagraphBorders.get(i)));
Assert.assertNotEquals(firstParagraphBorders.get(i).hashCode(), secondParagraphBorders.get(i).hashCode());
// Changing the appearance of an empty border makes it visible.
Assert.assertTrue(secondParagraphBorders.get(i).isVisible());
}
doc.save(getArtifactsDir() + "Border.SharedElements.docx");
Returns: int - The number of borders in the collection.
getDistanceFromText()
public double getDistanceFromText()
Gets distance of the border from text in points.
Remarks:
Gets the distance from text for the first border.
Sets the distance from text for all borders in the collection excluding diagonal borders.
Has no effect and will be automatically reset to zero for borders of table cells.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Returns: double - Distance of the border from text in points.
getHorizontal()
public Border getHorizontal()
Gets the horizontal border that is used between cells or conforming paragraphs.
Examples:
Shows how to apply settings to horizontal borders to a paragraph’s format.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a red horizontal border for the paragraph. Any paragraphs created afterwards will inherit these border settings.
BorderCollection borders = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBorders();
borders.getHorizontal().setColor(Color.RED);
borders.getHorizontal().setLineStyle(LineStyle.DASH_SMALL_GAP);
borders.getHorizontal().setLineWidth(3.0);
// Write text to the document without creating a new paragraph afterward.
// Since there is no paragraph underneath, the horizontal border will not be visible.
builder.write("Paragraph above horizontal border.");
// Once we add a second paragraph, the border of the first paragraph will become visible.
builder.insertParagraph();
builder.write("Paragraph below horizontal border.");
doc.save(getArtifactsDir() + "Border.HorizontalBorders.docx");
Shows how to apply settings to vertical borders to a table row’s format.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a table with red and blue inner borders.
Table table = builder.startTable();
for (int i = 0; i < 3; i++) {
builder.insertCell();
builder.write(MessageFormat.format("Row {0}, Column 1", i + 1));
builder.insertCell();
builder.write(MessageFormat.format("Row {0}, Column 2", i + 1));
Row row = builder.endRow();
BorderCollection borders = row.getRowFormat().getBorders();
// Adjust the appearance of borders that will appear between rows.
borders.getHorizontal().setColor(Color.RED);
borders.getHorizontal().setLineStyle(LineStyle.DOT);
borders.getHorizontal().setLineWidth(2.0d);
// Adjust the appearance of borders that will appear between cells.
borders.getVertical().setColor(Color.BLUE);
borders.getVertical().setLineStyle(LineStyle.DOT);
borders.getVertical().setLineWidth(2.0d);
}
// A row format, and a cell's inner paragraph use different border settings.
Border border = table.getFirstRow().getFirstCell().getLastParagraph().getParagraphFormat().getBorders().getVertical();
Assert.assertEquals(0, border.getColor().getRGB());
Assert.assertEquals(0.0d, border.getLineWidth());
Assert.assertEquals(LineStyle.NONE, border.getLineStyle());
doc.save(getArtifactsDir() + "Border.VerticalBorders.docx");
Returns: Border - The horizontal border that is used between cells or conforming paragraphs.
getLeft()
public Border getLeft()
Gets the left border.
Examples:
Shows how to apply border and shading color while building a table.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Start a table and set a default color/thickness for its borders.
Table table = builder.startTable();
table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
// Create a row with two cells with different background colors.
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
builder.writeln("Row 1, Cell 1.");
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
builder.writeln("Row 1, Cell 2.");
builder.endRow();
// Reset cell formatting to disable the background colors
// set a custom border thickness for all new cells created by the builder,
// then build a second row.
builder.getCellFormat().clearFormatting();
builder.getCellFormat().getBorders().getLeft().setLineWidth(4.0);
builder.getCellFormat().getBorders().getRight().setLineWidth(4.0);
builder.getCellFormat().getBorders().getTop().setLineWidth(4.0);
builder.getCellFormat().getBorders().getBottom().setLineWidth(4.0);
builder.insertCell();
builder.writeln("Row 2, Cell 1.");
builder.insertCell();
builder.writeln("Row 2, Cell 2.");
doc.save(getArtifactsDir() + "DocumentBuilder.TableBordersAndShading.docx");
Returns: Border - The left border.
getLineStyle()
public int getLineStyle()
Gets the border style.
Remarks:
Returns the style of the first border in the collection.
Sets the style of all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Returns: int - The border style. The returned value is one of LineStyle constants.
getLineWidth()
public double getLineWidth()
Gets the border width in points.
Remarks:
Returns the width of the first border in the collection.
Sets the width of all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Returns: double - The border width in points.
getRight()
public Border getRight()
Gets the right border.
Examples:
Shows how to apply border and shading color while building a table.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Start a table and set a default color/thickness for its borders.
Table table = builder.startTable();
table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
// Create a row with two cells with different background colors.
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
builder.writeln("Row 1, Cell 1.");
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
builder.writeln("Row 1, Cell 2.");
builder.endRow();
// Reset cell formatting to disable the background colors
// set a custom border thickness for all new cells created by the builder,
// then build a second row.
builder.getCellFormat().clearFormatting();
builder.getCellFormat().getBorders().getLeft().setLineWidth(4.0);
builder.getCellFormat().getBorders().getRight().setLineWidth(4.0);
builder.getCellFormat().getBorders().getTop().setLineWidth(4.0);
builder.getCellFormat().getBorders().getBottom().setLineWidth(4.0);
builder.insertCell();
builder.writeln("Row 2, Cell 1.");
builder.insertCell();
builder.writeln("Row 2, Cell 2.");
doc.save(getArtifactsDir() + "DocumentBuilder.TableBordersAndShading.docx");
Returns: Border - The right border.
getShadow()
public boolean getShadow()
Gets a value indicating whether the border has a shadow.
Remarks:
Gets the value from the first border in the collection.
Sets the value for all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Returns: boolean - A value indicating whether the border has a shadow.
getTop()
public Border getTop()
Gets the top border.
Examples:
Shows how to apply border and shading color while building a table.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Start a table and set a default color/thickness for its borders.
Table table = builder.startTable();
table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
// Create a row with two cells with different background colors.
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
builder.writeln("Row 1, Cell 1.");
builder.insertCell();
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
builder.writeln("Row 1, Cell 2.");
builder.endRow();
// Reset cell formatting to disable the background colors
// set a custom border thickness for all new cells created by the builder,
// then build a second row.
builder.getCellFormat().clearFormatting();
builder.getCellFormat().getBorders().getLeft().setLineWidth(4.0);
builder.getCellFormat().getBorders().getRight().setLineWidth(4.0);
builder.getCellFormat().getBorders().getTop().setLineWidth(4.0);
builder.getCellFormat().getBorders().getBottom().setLineWidth(4.0);
builder.insertCell();
builder.writeln("Row 2, Cell 1.");
builder.insertCell();
builder.writeln("Row 2, Cell 2.");
doc.save(getArtifactsDir() + "DocumentBuilder.TableBordersAndShading.docx");
Returns: Border - The top border.
getVertical()
public Border getVertical()
Gets the vertical border that is used between cells.
Examples:
Shows how to apply settings to vertical borders to a table row’s format.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a table with red and blue inner borders.
Table table = builder.startTable();
for (int i = 0; i < 3; i++) {
builder.insertCell();
builder.write(MessageFormat.format("Row {0}, Column 1", i + 1));
builder.insertCell();
builder.write(MessageFormat.format("Row {0}, Column 2", i + 1));
Row row = builder.endRow();
BorderCollection borders = row.getRowFormat().getBorders();
// Adjust the appearance of borders that will appear between rows.
borders.getHorizontal().setColor(Color.RED);
borders.getHorizontal().setLineStyle(LineStyle.DOT);
borders.getHorizontal().setLineWidth(2.0d);
// Adjust the appearance of borders that will appear between cells.
borders.getVertical().setColor(Color.BLUE);
borders.getVertical().setLineStyle(LineStyle.DOT);
borders.getVertical().setLineWidth(2.0d);
}
// A row format, and a cell's inner paragraph use different border settings.
Border border = table.getFirstRow().getFirstCell().getLastParagraph().getParagraphFormat().getBorders().getVertical();
Assert.assertEquals(0, border.getColor().getRGB());
Assert.assertEquals(0.0d, border.getLineWidth());
Assert.assertEquals(LineStyle.NONE, border.getLineStyle());
doc.save(getArtifactsDir() + "Border.VerticalBorders.docx");
Returns: Border - The vertical border that is used between cells.
iterator()
public Iterator iterator()
Returns an enumerator object that can be used to iterate over all borders in the collection.
Examples:
Shows how to iterate over and edit all of the borders in a paragraph format object.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Configure the builder's paragraph format settings to create a green wave border on all sides.
BorderCollection borders = builder.getParagraphFormat().getBorders();
Iterator enumerator = borders.iterator();
while (enumerator.hasNext()) {
Border border = enumerator.next();
border.setColor(Color.green);
border.setLineStyle(LineStyle.WAVE);
border.setLineWidth(3.0);
}
// Insert a paragraph. Our border settings will determine the appearance of its border.
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "BorderCollection.GetBordersEnumerator.docx");
Returns: java.util.Iterator
setColor(Color value)
public void setColor(Color value)
Sets the border color.
Remarks:
Returns the color of the first border in the collection.
Sets the color of all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.awt.Color | The border color. |
setDistanceFromText(double value)
public void setDistanceFromText(double value)
Sets distance of the border from text in points.
Remarks:
Gets the distance from text for the first border.
Sets the distance from text for all borders in the collection excluding diagonal borders.
Has no effect and will be automatically reset to zero for borders of table cells.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | Distance of the border from text in points. |
setLineStyle(int value)
public void setLineStyle(int value)
Sets the border style.
Remarks:
Returns the style of the first border in the collection.
Sets the style of all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The border style. The value must be one of LineStyle constants. |
setLineWidth(double value)
public void setLineWidth(double value)
Sets the border width in points.
Remarks:
Returns the width of the first border in the collection.
Sets the width of all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The border width in points. |
setShadow(boolean value)
public void setShadow(boolean value)
Sets a value indicating whether the border has a shadow.
Remarks:
Gets the value from the first border in the collection.
Sets the value for all borders in the collection excluding diagonal borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating whether the border has a shadow. |
