java.lang.ObjectInternableComplexAttr
com.aspose.words.Border
public class Border
Borders can be applied to various document elements including paragraph,
run of text inside a paragraph or a table cell. Example: Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);
builder.write("Text surrounded by green border.");
doc.save(getArtifactsDir() + "Border.FontBorder.docx");
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Border topBorder = builder.getParagraphFormat().getBorders().getByBorderType(BorderType.TOP);
topBorder.setColor(Color.RED);
topBorder.setLineStyle(LineStyle.DASH_SMALL_GAP);
topBorder.setLineWidth(4);
builder.writeln("Text with a red top border.");
doc.save(getArtifactsDir() + "Border.ParagraphTopBorder.docx");
Property Getters/Setters Summary | ||
---|---|---|
java.awt.Color | getColor() | |
void | setColor(java.awt.Color value) | |
Gets or sets the border color. | ||
double | getDistanceFromText() | |
void | setDistanceFromText(double value) | |
Gets or sets distance of the border from text or from the page edge in points. | ||
boolean | isVisible() | |
Returns true if the LineStyle is not LineStyle.None. | ||
int | getLineStyle() | |
void | setLineStyle(int value) | |
Gets or sets the border style. The value of the property is LineStyle integer constant. | ||
double | getLineWidth() | |
void | setLineWidth(double value) | |
Gets or sets the border width in points. | ||
boolean | getShadow() | |
void | setShadow(boolean value) | |
Gets or sets a value indicating whether the border has a shadow. |
Method Summary | ||
---|---|---|
void | clearFormatting() | |
Resets border properties to default values. | ||
boolean | equals(Border rhs) | |
Determines whether the specified border is equal in value to the current border. | ||
boolean | equals(java.lang.Object obj) | |
Determines whether the specified object is equal in value to the current object. | ||
int | hashCode() | |
Serves as a hash function for this type. |
Property Getters/Setters Detail |
---|
getColor/setColor | |
public java.awt.Color getColor() / public void setColor(java.awt.Color value) |
Example:
Shows how to insert a string surrounded by a border into a document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().getBorder().setColor(Color.GREEN); builder.getFont().getBorder().setLineWidth(2.5); builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER); builder.write("Text surrounded by green border."); doc.save(getArtifactsDir() + "Border.FontBorder.docx");
getDistanceFromText/setDistanceFromText | |
public double getDistanceFromText() / public void setDistanceFromText(double value) |
Example:
Creates a page border that looks like a wide blue band at the top of the first page only.Document doc = new Document(); PageSetup ps = doc.getSections().get(0).getPageSetup(); ps.setBorderAlwaysInFront(false); ps.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE); ps.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE); Border border = ps.getBorders().getByBorderType(BorderType.TOP); border.setLineStyle(LineStyle.SINGLE); border.setLineWidth(30); border.setColor(Color.BLUE); border.setDistanceFromText(0); doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.doc");
isVisible | |
public boolean isVisible() |
Example:
Shows the equality of BorderCollections as well counting, visibility of their elements.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 1.")); Paragraph firstParagraph = doc.getFirstSection().getBody().getFirstParagraph(); BorderCollection firstParaBorders = firstParagraph.getParagraphFormat().getBorders(); builder.insertParagraph(); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 2.")); Paragraph secondParagraph = builder.getCurrentParagraph(); BorderCollection secondParaBorders = secondParagraph.getParagraphFormat().getBorders(); // Two paragraphs have two different BorderCollections, but share the elements that are in from the first paragraph for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertTrue(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Borders are invisible by default Assert.assertFalse(firstParaBorders.get(i).isVisible()); } // Each border in the second paragraph collection becomes no longer the same as its counterpart from the first paragraph collection // Change all the elements in the second collection to make it completely different from the first Assert.assertEquals(6, secondParaBorders.getCount()); // ExSkip for (Border border : secondParaBorders) { border.setLineStyle(LineStyle.DOT_DASH); } // Now the BorderCollections both have their own elements for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertFalse(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertNotEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Changing the line style made the borders visible Assert.assertTrue(secondParaBorders.get(i).isVisible()); } doc.save(getArtifactsDir() + "Border.EqualityCountingAndVisibility.docx");
getLineStyle/setLineStyle | |
public int getLineStyle() / public void setLineStyle(int value) |
If you set line style to none, then line width is automatically changed to zero.
Example:
Shows how to insert a string surrounded by a border into a document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().getBorder().setColor(Color.GREEN); builder.getFont().getBorder().setLineWidth(2.5); builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER); builder.write("Text surrounded by green border."); doc.save(getArtifactsDir() + "Border.FontBorder.docx");
getLineWidth/setLineWidth | |
public double getLineWidth() / public void setLineWidth(double value) |
If you set line width greater than zero when line style is none, the line style is automatically changed to single line.
Example:
Shows how to insert a string surrounded by a border into a document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().getBorder().setColor(Color.GREEN); builder.getFont().getBorder().setLineWidth(2.5); builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER); builder.write("Text surrounded by green border."); doc.save(getArtifactsDir() + "Border.FontBorder.docx");
getShadow/setShadow | |
public boolean getShadow() / public void setShadow(boolean value) |
In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.
Example:
Creates a fancy looking green wavy page border with a shadow.Document doc = new Document(); PageSetup ps = doc.getSections().get(0).getPageSetup(); ps.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE); ps.getBorders().setLineWidth(2); ps.getBorders().setColor(Color.GREEN); ps.getBorders().setDistanceFromText(24); ps.getBorders().setShadow(true); doc.save(getArtifactsDir() + "PageSetup.PageBorders.doc");
Method Detail |
---|
clearFormatting | |
public void clearFormatting() |
Example:
Shows how to remove borders from a paragraph.Document doc = new Document(getMyDir() + "Borders.docx"); // Get the first paragraph's collection of borders DocumentBuilder builder = new DocumentBuilder(doc); BorderCollection borders = builder.getParagraphFormat().getBorders(); Assert.assertEquals(3.0d, borders.get(0).getLineWidth()); // ExSkip Assert.assertEquals(LineStyle.SINGLE, borders.get(0).getLineStyle()); // ExSkip for (Border border : borders) { border.clearFormatting(); } builder.getCurrentParagraph().getRuns().get(0).setText("Paragraph with no border"); doc.save(getArtifactsDir() + "Border.ClearFormatting.docx");
equals | |
public boolean equals(Border rhs) |
Example:
Shows the equality of BorderCollections as well counting, visibility of their elements.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 1.")); Paragraph firstParagraph = doc.getFirstSection().getBody().getFirstParagraph(); BorderCollection firstParaBorders = firstParagraph.getParagraphFormat().getBorders(); builder.insertParagraph(); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 2.")); Paragraph secondParagraph = builder.getCurrentParagraph(); BorderCollection secondParaBorders = secondParagraph.getParagraphFormat().getBorders(); // Two paragraphs have two different BorderCollections, but share the elements that are in from the first paragraph for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertTrue(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Borders are invisible by default Assert.assertFalse(firstParaBorders.get(i).isVisible()); } // Each border in the second paragraph collection becomes no longer the same as its counterpart from the first paragraph collection // Change all the elements in the second collection to make it completely different from the first Assert.assertEquals(6, secondParaBorders.getCount()); // ExSkip for (Border border : secondParaBorders) { border.setLineStyle(LineStyle.DOT_DASH); } // Now the BorderCollections both have their own elements for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertFalse(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertNotEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Changing the line style made the borders visible Assert.assertTrue(secondParaBorders.get(i).isVisible()); } doc.save(getArtifactsDir() + "Border.EqualityCountingAndVisibility.docx");
equals | |
public boolean equals(java.lang.Object obj) |
Example:
Shows the equality of BorderCollections as well counting, visibility of their elements.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 1.")); Paragraph firstParagraph = doc.getFirstSection().getBody().getFirstParagraph(); BorderCollection firstParaBorders = firstParagraph.getParagraphFormat().getBorders(); builder.insertParagraph(); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 2.")); Paragraph secondParagraph = builder.getCurrentParagraph(); BorderCollection secondParaBorders = secondParagraph.getParagraphFormat().getBorders(); // Two paragraphs have two different BorderCollections, but share the elements that are in from the first paragraph for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertTrue(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Borders are invisible by default Assert.assertFalse(firstParaBorders.get(i).isVisible()); } // Each border in the second paragraph collection becomes no longer the same as its counterpart from the first paragraph collection // Change all the elements in the second collection to make it completely different from the first Assert.assertEquals(6, secondParaBorders.getCount()); // ExSkip for (Border border : secondParaBorders) { border.setLineStyle(LineStyle.DOT_DASH); } // Now the BorderCollections both have their own elements for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertFalse(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertNotEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Changing the line style made the borders visible Assert.assertTrue(secondParaBorders.get(i).isVisible()); } doc.save(getArtifactsDir() + "Border.EqualityCountingAndVisibility.docx");
hashCode | |
public int hashCode() |
Example:
Shows the equality of BorderCollections as well counting, visibility of their elements.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 1.")); Paragraph firstParagraph = doc.getFirstSection().getBody().getFirstParagraph(); BorderCollection firstParaBorders = firstParagraph.getParagraphFormat().getBorders(); builder.insertParagraph(); builder.getCurrentParagraph().appendChild(new Run(doc, "Paragraph 2.")); Paragraph secondParagraph = builder.getCurrentParagraph(); BorderCollection secondParaBorders = secondParagraph.getParagraphFormat().getBorders(); // Two paragraphs have two different BorderCollections, but share the elements that are in from the first paragraph for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertTrue(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Borders are invisible by default Assert.assertFalse(firstParaBorders.get(i).isVisible()); } // Each border in the second paragraph collection becomes no longer the same as its counterpart from the first paragraph collection // Change all the elements in the second collection to make it completely different from the first Assert.assertEquals(6, secondParaBorders.getCount()); // ExSkip for (Border border : secondParaBorders) { border.setLineStyle(LineStyle.DOT_DASH); } // Now the BorderCollections both have their own elements for (int i = 0; i < firstParaBorders.getCount(); i++) { Assert.assertFalse(firstParaBorders.get(i).equals(secondParaBorders.get(i))); Assert.assertNotEquals(firstParaBorders.get(i).hashCode(), secondParaBorders.get(i).hashCode()); // Changing the line style made the borders visible Assert.assertTrue(secondParaBorders.get(i).isVisible()); } doc.save(getArtifactsDir() + "Border.EqualityCountingAndVisibility.docx");