Paragraph right
" + + "Implicit paragraph left" + + "Paragraph 1.
" + + "Paragraph 2.
", useBuilderFormatting); + + ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs(); + + // The first paragraph has an alignment specified. When InsertHtml parses the HTML code, + // the paragraph alignment value found in the HTML code always supersedes the document builder's value. + Assert.assertEquals("Paragraph 1.", paragraphs.get(0).getText().trim()); + Assert.assertEquals(ParagraphAlignment.RIGHT, paragraphs.get(0).getParagraphFormat().getAlignment()); + + // The second paragraph has no alignment specified. It can have its alignment value filled in + // by the builder's value depending on the flag we passed to the InsertHtml method. + Assert.assertEquals("Paragraph 2.", paragraphs.get(1).getText().trim()); + Assert.assertEquals(useBuilderFormatting ? ParagraphAlignment.DISTRIBUTED : ParagraphAlignment.LEFT, + paragraphs.get(1).getParagraphFormat().getAlignment()); + + doc.save(getArtifactsDir() + "DocumentBuilder.InsertHtmlWithFormatting.docx"); + //ExEnd + } + + //JAVA-added data provider for test method + @DataProvider(name = "insertHtmlWithFormattingDataProvider") + public static Object[][] insertHtmlWithFormattingDataProvider() throws Exception { + return new Object[][] + { + {false}, + {true}, + }; + } + + @Test + public void mathMl() throws Exception { + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + final String mathML = + ""; + + builder.insertHtml(mathML); + + doc.save(getArtifactsDir() + "DocumentBuilder.MathML.docx"); + doc.save(getArtifactsDir() + "DocumentBuilder.MathML.pdf"); + + Assert.assertTrue(DocumentHelper.compareDocs(getGoldsDir() + "DocumentBuilder.MathML Gold.docx", getArtifactsDir() + "DocumentBuilder.MathML.docx")); + } + + @Test + public void insertTextAndBookmark() throws Exception { + //ExStart + //ExFor:DocumentBuilder.StartBookmark + //ExFor:DocumentBuilder.EndBookmark + //ExSummary:Shows how create a bookmark. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // A valid bookmark needs to have document body text enclosed by + // BookmarkStart and BookmarkEnd nodes created with a matching bookmark name. + builder.startBookmark("MyBookmark"); + builder.writeln("Hello world!"); + builder.endBookmark("MyBookmark"); + + Assert.assertEquals(1, doc.getRange().getBookmarks().getCount()); + Assert.assertEquals("MyBookmark", doc.getRange().getBookmarks().get(0).getName()); + Assert.assertEquals("Hello world!", doc.getRange().getBookmarks().get(0).getText().trim()); + //ExEnd + } + + @Test + public void createColumnBookmark() throws Exception + { + //ExStart + //ExFor:DocumentBuilder.StartColumnBookmark + //ExFor:DocumentBuilder.EndColumnBookmark + //ExSummary:Shows how to create a column bookmark. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + builder.startTable(); + + builder.insertCell(); + // Cells 1,2,4,5 will be bookmarked. + builder.startColumnBookmark("MyBookmark_1"); + // Badly formed bookmarks or bookmarks with duplicate names will be ignored when the document is saved. + builder.startColumnBookmark("MyBookmark_1"); + builder.startColumnBookmark("BadStartBookmark"); + builder.write("Cell 1"); + + builder.insertCell(); + builder.write("Cell 2"); + + builder.insertCell(); + builder.write("Cell 3"); + + builder.endRow(); + + builder.insertCell(); + builder.write("Cell 4"); + + builder.insertCell(); + builder.write("Cell 5"); + builder.endColumnBookmark("MyBookmark_1"); + builder.endColumnBookmark("MyBookmark_1"); + + Assert.assertThrows(IllegalStateException.class, () -> builder.endColumnBookmark("BadEndBookmark")); //ExSkip + + builder.insertCell(); + builder.write("Cell 6"); + + builder.endRow(); + builder.endTable(); + + doc.save(getArtifactsDir() + "Bookmarks.CreateColumnBookmark.docx"); + //ExEnd + } + + @Test + public void createForm() throws Exception + { + //ExStart + //ExFor:TextFormFieldType + //ExFor:DocumentBuilder.InsertTextInput + //ExFor:DocumentBuilder.InsertComboBox + //ExSummary:Shows how to create form fields. + DocumentBuilder builder = new DocumentBuilder(); + + // Form fields are objects in the document that the user can interact with by being prompted to enter values. + // We can create them using a document builder, and below are two ways of doing so. + // 1 - Basic text input: + builder.insertTextInput("My text input", TextFormFieldType.REGULAR, + "", "Enter your name here", 30); + + // 2 - Combo box with prompt text, and a range of possible values: + String[] items = + { + "-- Select your favorite footwear --", "Sneakers", "Oxfords", "Flip-flops", "Other" + }; + + builder.insertParagraph(); + builder.insertComboBox("My combo box", items, 0); + + builder.getDocument().save(getArtifactsDir() + "DocumentBuilder.CreateForm.docx"); + //ExEnd + + Document doc = new Document(getArtifactsDir() + "DocumentBuilder.CreateForm.docx"); + FormField formField = doc.getRange().getFormFields().get(0); + + Assert.assertEquals("My text input", formField.getName()); + Assert.assertEquals(TextFormFieldType.REGULAR, formField.getTextInputType()); + Assert.assertEquals("Enter your name here", formField.getResult()); + + formField = doc.getRange().getFormFields().get(1); + + Assert.assertEquals("My combo box", formField.getName()); + Assert.assertEquals(TextFormFieldType.REGULAR, formField.getTextInputType()); + Assert.assertEquals("-- Select your favorite footwear --", formField.getResult()); + Assert.assertEquals(0, formField.getDropDownSelectedIndex()); + Assert.assertEquals(Arrays.asList("-- Select your favorite footwear --", "Sneakers", "Oxfords", "Flip-flops", "Other"), + formField.getDropDownItems()); + } + + @Test + public void insertCheckBox() throws Exception { + //ExStart + //ExFor:DocumentBuilder.InsertCheckBox(string, bool, bool, int) + //ExFor:DocumentBuilder.InsertCheckBox(String, bool, int) + //ExSummary:Shows how to insert checkboxes into the document. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // Insert checkboxes of varying sizes and default checked statuses. + builder.write("Unchecked check box of a default size: "); + builder.insertCheckBox("", false, false, 0); + builder.insertParagraph(); + + builder.write("Large checked check box: "); + builder.insertCheckBox("CheckBox_Default", true, true, 50); + builder.insertParagraph(); + + // Form fields have a name length limit of 20 characters. + builder.write("Very large checked check box: "); + builder.insertCheckBox("CheckBox_OnlyCheckedValue", true, 100); + + Assert.assertEquals("CheckBox_OnlyChecked", doc.getRange().getFormFields().get(2).getName()); + + // We can interact with these check boxes in Microsoft Word by double clicking them. + doc.save(getArtifactsDir() + "DocumentBuilder.InsertCheckBox.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertCheckBox.docx"); + + FormFieldCollection formFields = doc.getRange().getFormFields(); + + Assert.assertEquals("", formFields.get(0).getName()); + Assert.assertEquals(false, formFields.get(0).getChecked()); + Assert.assertEquals(false, formFields.get(0).getDefault()); + Assert.assertEquals(10.0, formFields.get(0).getCheckBoxSize()); + + Assert.assertEquals("CheckBox_Default", formFields.get(1).getName()); + Assert.assertEquals(true, formFields.get(1).getChecked()); + Assert.assertEquals(true, formFields.get(1).getDefault()); + Assert.assertEquals(50.0, formFields.get(1).getCheckBoxSize()); + + Assert.assertEquals("CheckBox_OnlyChecked", formFields.get(2).getName()); + Assert.assertEquals(true, formFields.get(2).getChecked()); + Assert.assertEquals(true, formFields.get(2).getDefault()); + Assert.assertEquals(100.0, formFields.get(2).getCheckBoxSize()); + } + + @Test + public void insertCheckBoxEmptyName() throws Exception { + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // Checking that the checkbox insertion with an empty name working correctly. + builder.insertCheckBox("", true, false, 1); + builder.insertCheckBox("", false, 1); + } + + @Test + public void workingWithNodes() throws Exception { + //ExStart + //ExFor:DocumentBuilder.MoveTo(Node) + //ExFor:DocumentBuilder.MoveToBookmark(String) + //ExFor:DocumentBuilder.CurrentParagraph + //ExFor:DocumentBuilder.CurrentNode + //ExFor:DocumentBuilder.MoveToDocumentStart + //ExFor:DocumentBuilder.MoveToDocumentEnd + //ExFor:DocumentBuilder.IsAtEndOfParagraph + //ExFor:DocumentBuilder.IsAtStartOfParagraph + //ExSummary:Shows how to move a document builder's cursor to different nodes in a document. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // Create a valid bookmark, an entity that consists of nodes enclosed by a bookmark start node, + // and a bookmark end node. + builder.startBookmark("MyBookmark"); + builder.write("Bookmark contents."); + builder.endBookmark("MyBookmark"); + + NodeCollection firstParagraphNodes = doc.getFirstSection().getBody().getFirstParagraph().getChildNodes(NodeType.ANY, false); + + Assert.assertEquals(NodeType.BOOKMARK_START, firstParagraphNodes.get(0).getNodeType()); + Assert.assertEquals(NodeType.RUN, firstParagraphNodes.get(1).getNodeType()); + Assert.assertEquals("Bookmark contents.", firstParagraphNodes.get(1).getText().trim()); + Assert.assertEquals(NodeType.BOOKMARK_END, firstParagraphNodes.get(2).getNodeType()); + + // The document builder's cursor is always ahead of the node that we last added with it. + // If the builder's cursor is at the end of the document, its current node will be null. + // The previous node is the bookmark end node that we last added. + // Adding new nodes with the builder will append them to the last node. + Assert.assertNull(builder.getCurrentNode()); + + // If we wish to edit a different part of the document with the builder, + // we will need to bring its cursor to the node we wish to edit. + builder.moveToBookmark("MyBookmark"); + + // Moving it to a bookmark will move it to the first node within the bookmark start and end nodes, the enclosed run. + Assert.assertEquals(firstParagraphNodes.get(1), builder.getCurrentNode()); + + // We can also move the cursor to an individual node like this. + builder.moveTo(doc.getFirstSection().getBody().getFirstParagraph().getChildNodes(NodeType.ANY, false).get(0)); + + Assert.assertEquals(NodeType.BOOKMARK_START, builder.getCurrentNode().getNodeType()); + Assert.assertEquals(doc.getFirstSection().getBody().getFirstParagraph(), builder.getCurrentParagraph()); + Assert.assertTrue(builder.isAtStartOfParagraph()); + + // We can use specific methods to move to the start/end of a document. + builder.moveToDocumentEnd(); + + Assert.assertTrue(builder.isAtEndOfParagraph()); + + builder.moveToDocumentStart(); + + Assert.assertTrue(builder.isAtStartOfParagraph()); + //ExEnd + } + + @Test + public void fillMergeFields() throws Exception { + //ExStart + //ExFor:DocumentBuilder.MoveToMergeField(String) + //ExFor:DocumentBuilder.Bold + //ExFor:DocumentBuilder.Italic + //ExSummary:Shows how to fill MERGEFIELDs with data with a document builder instead of a mail merge. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // Insert some MERGEFIELDS, which accept data from columns of the same name in a data source during a mail merge, + // and then fill them manually. + builder.insertField(" MERGEFIELD Chairman "); + builder.insertField(" MERGEFIELD ChiefFinancialOfficer "); + builder.insertField(" MERGEFIELD ChiefTechnologyOfficer "); + + builder.moveToMergeField("Chairman"); + builder.setBold(true); + builder.writeln("John Doe"); + + builder.moveToMergeField("ChiefFinancialOfficer"); + builder.setItalic(true); + builder.writeln("Jane Doe"); + + builder.moveToMergeField("ChiefTechnologyOfficer"); + builder.setItalic(true); + builder.writeln("John Bloggs"); + + doc.save(getArtifactsDir() + "DocumentBuilder.FillMergeFields.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.FillMergeFields.docx"); + ParagraphCollection paragraphs = doc.getFirstSection().getBody().getParagraphs(); + + Assert.assertTrue(paragraphs.get(0).getRuns().get(0).getFont().getBold()); + Assert.assertEquals("John Doe", paragraphs.get(0).getRuns().get(0).getText().trim()); + + Assert.assertTrue(paragraphs.get(1).getRuns().get(0).getFont().getItalic()); + Assert.assertEquals("Jane Doe", paragraphs.get(1).getRuns().get(0).getText().trim()); + + Assert.assertTrue(paragraphs.get(2).getRuns().get(0).getFont().getItalic()); + Assert.assertEquals("John Bloggs", paragraphs.get(2).getRuns().get(0).getText().trim()); + + } + + @Test + public void insertToc() throws Exception { + //ExStart + //ExFor:DocumentBuilder.InsertTableOfContents + //ExFor:Document.UpdateFields + //ExFor:DocumentBuilder.#ctor(Document) + //ExFor:ParagraphFormat.StyleIdentifier + //ExFor:DocumentBuilder.InsertBreak + //ExFor:BreakType + //ExSummary:Shows how to insert a Table of contents (TOC) into a document using heading styles as entries. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // Insert a table of contents for the first page of the document. + // Configure the table to pick up paragraphs with headings of levels 1 to 3. + // Also, set its entries to be hyperlinks that will take us + // to the location of the heading when left-clicked in Microsoft Word. + builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u"); + builder.insertBreak(BreakType.PAGE_BREAK); + + // Populate the table of contents by adding paragraphs with heading styles. + // Each such heading with a level between 1 and 3 will create an entry in the table. + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1); + builder.writeln("Heading 1"); + + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2); + builder.writeln("Heading 1.1"); + builder.writeln("Heading 1.2"); + + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1); + builder.writeln("Heading 2"); + builder.writeln("Heading 3"); + + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2); + builder.writeln("Heading 3.1"); + + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3); + builder.writeln("Heading 3.1.1"); + builder.writeln("Heading 3.1.2"); + builder.writeln("Heading 3.1.3"); + + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_4); + builder.writeln("Heading 3.1.3.1"); + builder.writeln("Heading 3.1.3.2"); + + builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2); + builder.writeln("Heading 3.2"); + builder.writeln("Heading 3.3"); + + // A table of contents is a field of a type that needs to be updated to show an up-to-date result. + doc.updateFields(); + doc.save(getArtifactsDir() + "DocumentBuilder.InsertToc.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertToc.docx"); + FieldToc tableOfContents = (FieldToc) doc.getRange().getFields().get(0); + + Assert.assertEquals("1-3", tableOfContents.getHeadingLevelRange()); + Assert.assertTrue(tableOfContents.getInsertHyperlinks()); + Assert.assertTrue(tableOfContents.getHideInWebLayout()); + Assert.assertTrue(tableOfContents.getUseParagraphOutlineLevel()); + } + + @Test + public void insertTable() throws Exception { + //ExStart + //ExFor:DocumentBuilder + //ExFor:DocumentBuilder.Write(String) + //ExFor:DocumentBuilder.StartTable + //ExFor:DocumentBuilder.InsertCell + //ExFor:DocumentBuilder.EndRow + //ExFor:DocumentBuilder.EndTable + //ExFor:DocumentBuilder.CellFormat + //ExFor:DocumentBuilder.RowFormat + //ExFor:CellFormat + //ExFor:CellFormat.FitText + //ExFor:CellFormat.Width + //ExFor:CellFormat.VerticalAlignment + //ExFor:CellFormat.Shading + //ExFor:CellFormat.Orientation + //ExFor:CellFormat.WrapText + //ExFor:RowFormat + //ExFor:RowFormat.Borders + //ExFor:RowFormat.ClearFormatting + //ExFor:Shading.ClearFormatting + //ExSummary:Shows how to build a table with custom borders. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + builder.startTable(); + + // Setting table formatting options for a document builder + // will apply them to every row and cell that we add with it. + builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); + + builder.getCellFormat().clearFormatting(); + builder.getCellFormat().setWidth(150.0); + builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER); + builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN); + builder.getCellFormat().setWrapText(false); + builder.getCellFormat().setFitText(true); + + builder.getRowFormat().clearFormatting(); + builder.getRowFormat().setHeightRule(HeightRule.EXACTLY); + builder.getRowFormat().setHeight(50.0); + builder.getRowFormat().getBorders().setLineStyle(LineStyle.ENGRAVE_3_D); + builder.getRowFormat().getBorders().setColor(Color.ORANGE); + + builder.insertCell(); + builder.write("Row 1, Col 1"); + + builder.insertCell(); + builder.write("Row 1, Col 2"); + builder.endRow(); + + // Changing the formatting will apply it to the current cell, + // and any new cells that we create with the builder afterward. + // This will not affect the cells that we have added previously. + builder.getCellFormat().getShading().clearFormatting(); + + builder.insertCell(); + builder.write("Row 2, Col 1"); + + builder.insertCell(); + builder.write("Row 2, Col 2"); + + builder.endRow(); + + // Increase row height to fit the vertical text. + builder.insertCell(); + builder.getRowFormat().setHeight(150.0); + builder.getCellFormat().setOrientation(TextOrientation.UPWARD); + builder.write("Row 3, Col 1"); + + builder.insertCell(); + builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD); + builder.write("Row 3, Col 2"); + + builder.endRow(); + builder.endTable(); + + doc.save(getArtifactsDir() + "DocumentBuilder.InsertTable.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertTable.docx"); + Table table = (Table) doc.getChild(NodeType.TABLE, 0, true); + + Assert.assertEquals("Row 1, Col 1", table.getRows().get(0).getCells().get(0).getText().trim()); + Assert.assertEquals("Row 1, Col 2", table.getRows().get(0).getCells().get(1).getText().trim()); + Assert.assertEquals(HeightRule.EXACTLY, table.getRows().get(0).getRowFormat().getHeightRule()); + Assert.assertEquals(50.0d, table.getRows().get(0).getRowFormat().getHeight()); + Assert.assertEquals(LineStyle.ENGRAVE_3_D, table.getRows().get(0).getRowFormat().getBorders().getLineStyle()); + Assert.assertEquals(Color.ORANGE.getRGB(), table.getRows().get(0).getRowFormat().getBorders().getColor().getRGB()); + + for (Cell c : table.getRows().get(0).getCells()) { + Assert.assertEquals(150.0, c.getCellFormat().getWidth()); + Assert.assertEquals(CellVerticalAlignment.CENTER, c.getCellFormat().getVerticalAlignment()); + Assert.assertEquals(Color.GREEN.getRGB(), c.getCellFormat().getShading().getBackgroundPatternColor().getRGB()); + Assert.assertFalse(c.getCellFormat().getWrapText()); + Assert.assertTrue(c.getCellFormat().getFitText()); + + Assert.assertEquals(ParagraphAlignment.CENTER, c.getFirstParagraph().getParagraphFormat().getAlignment()); + } + + Assert.assertEquals("Row 2, Col 1", table.getRows().get(1).getCells().get(0).getText().trim()); + Assert.assertEquals("Row 2, Col 2", table.getRows().get(1).getCells().get(1).getText().trim()); + + + for (Cell c : table.getRows().get(1).getCells()) { + Assert.assertEquals(150.0, c.getCellFormat().getWidth()); + Assert.assertEquals(CellVerticalAlignment.CENTER, c.getCellFormat().getVerticalAlignment()); + Assert.assertEquals(0, c.getCellFormat().getShading().getBackgroundPatternColor().getRGB()); + Assert.assertFalse(c.getCellFormat().getWrapText()); + Assert.assertTrue(c.getCellFormat().getFitText()); + + Assert.assertEquals(ParagraphAlignment.CENTER, c.getFirstParagraph().getParagraphFormat().getAlignment()); + } + + Assert.assertEquals(150.0, table.getRows().get(2).getRowFormat().getHeight()); + + Assert.assertEquals("Row 3, Col 1", table.getRows().get(2).getCells().get(0).getText().trim()); + Assert.assertEquals(TextOrientation.UPWARD, table.getRows().get(2).getCells().get(0).getCellFormat().getOrientation()); + Assert.assertEquals(ParagraphAlignment.CENTER, table.getRows().get(2).getCells().get(0).getFirstParagraph().getParagraphFormat().getAlignment()); + + Assert.assertEquals("Row 3, Col 2", table.getRows().get(2).getCells().get(1).getText().trim()); + Assert.assertEquals(TextOrientation.DOWNWARD, table.getRows().get(2).getCells().get(1).getCellFormat().getOrientation()); + Assert.assertEquals(ParagraphAlignment.CENTER, table.getRows().get(2).getCells().get(1).getFirstParagraph().getParagraphFormat().getAlignment()); + } + + @Test + public void insertTableWithStyle() throws Exception { + //ExStart + //ExFor:Table.StyleIdentifier + //ExFor:Table.StyleOptions + //ExFor:TableStyleOptions + //ExFor:Table.AutoFit + //ExFor:AutoFitBehavior + //ExSummary:Shows how to build a new table while applying a style. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + Table table = builder.startTable(); + + // We must insert at least one row before setting any table formatting. + builder.insertCell(); + + // Set the table style used based on the style identifier. + // Note that not all table styles are available when saving to .doc format. + table.setStyleIdentifier(StyleIdentifier.MEDIUM_SHADING_1_ACCENT_1); + + // Partially apply the style to features of the table based on predicates, then build the table. + table.setStyleOptions(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW); + table.autoFit(AutoFitBehavior.AUTO_FIT_TO_CONTENTS); + + builder.writeln("Item"); + builder.getCellFormat().setRightPadding(40.0); + builder.insertCell(); + builder.writeln("Quantity (kg)"); + builder.endRow(); + + builder.insertCell(); + builder.writeln("Apples"); + builder.insertCell(); + builder.writeln("20"); + builder.endRow(); + + builder.insertCell(); + builder.writeln("Bananas"); + builder.insertCell(); + builder.writeln("40"); + builder.endRow(); + + builder.insertCell(); + builder.writeln("Carrots"); + builder.insertCell(); + builder.writeln("50"); + builder.endRow(); + + doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertTableWithStyle.docx"); + + doc.expandTableStylesToDirectFormatting(); + + Assert.assertEquals("Medium Shading 1 Accent 1", table.getStyle().getName()); + Assert.assertEquals(TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS | TableStyleOptions.FIRST_ROW, + table.getStyleOptions()); + Assert.assertEquals(189, (table.getFirstRow().getFirstCell().getCellFormat().getShading().getBackgroundPatternColor().getBlue() & 0xFF)); + Assert.assertEquals(Color.WHITE.getRGB(), table.getFirstRow().getFirstCell().getFirstParagraph().getRuns().get(0).getFont().getColor().getRGB()); + Assert.assertNotEquals(Color.BLUE.getRGB(), + (table.getLastRow().getFirstCell().getCellFormat().getShading().getBackgroundPatternColor().getBlue() & 0xFF)); + Assert.assertEquals(0, table.getLastRow().getFirstCell().getFirstParagraph().getRuns().get(0).getFont().getColor().getRGB()); + } + + @Test + public void insertTableSetHeadingRow() throws Exception { + //ExStart + //ExFor:RowFormat.HeadingFormat + //ExSummary:Shows how to build a table with rows that repeat on every page. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + Table table = builder.startTable(); + + // Any rows inserted while the "HeadingFormat" flag is set to "true" + // will show up at the top of the table on every page that it spans. + builder.getRowFormat().setHeadingFormat(true); + builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); + builder.getCellFormat().setWidth(100.0); + builder.insertCell(); + builder.write("Heading row 1"); + builder.endRow(); + builder.insertCell(); + builder.write("Heading row 2"); + builder.endRow(); + + builder.getCellFormat().setWidth(50.0); + builder.getParagraphFormat().clearFormatting(); + builder.getRowFormat().setHeadingFormat(false); + + // Add enough rows for the table to span two pages. + for (int i = 0; i < 50; i++) { + builder.insertCell(); + builder.write(MessageFormat.format("Row {0}, column 1.", table.getRows().toArray().length)); + builder.insertCell(); + builder.write(MessageFormat.format("Row {0}, column 2.", table.getRows().toArray().length)); + builder.endRow(); + } + + doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableSetHeadingRow.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertTableSetHeadingRow.docx"); + table = doc.getFirstSection().getBody().getTables().get(0); + + for (int i = 0; i < table.getRows().getCount(); i++) + Assert.assertEquals(i < 2, table.getRows().get(i).getRowFormat().getHeadingFormat()); + } + + @Test + public void insertTableWithPreferredWidth() throws Exception { + //ExStart + //ExFor:Table.PreferredWidth + //ExFor:PreferredWidth.FromPercent + //ExFor:PreferredWidth + //ExSummary:Shows how to set a table to auto fit to 50% of the width of the page. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + Table table = builder.startTable(); + builder.insertCell(); + builder.write("Cell #1"); + builder.insertCell(); + builder.write("Cell #2"); + builder.insertCell(); + builder.write("Cell #3"); + + table.setPreferredWidth(PreferredWidth.fromPercent(50.0)); + + doc.save(getArtifactsDir() + "DocumentBuilder.InsertTableWithPreferredWidth.docx"); + //ExEnd + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertTableWithPreferredWidth.docx"); + table = doc.getFirstSection().getBody().getTables().get(0); + + Assert.assertEquals(PreferredWidthType.PERCENT, table.getPreferredWidth().getType()); + Assert.assertEquals(50.0, table.getPreferredWidth().getValue()); + } + + @Test + public void insertCellsWithPreferredWidths() throws Exception { + //ExStart + //ExFor:CellFormat.PreferredWidth + //ExFor:PreferredWidth + //ExFor:PreferredWidth.Auto + //ExFor:PreferredWidth.Equals(PreferredWidth) + //ExFor:PreferredWidth.Equals(Object) + //ExFor:PreferredWidth.FromPoints + //ExFor:PreferredWidth.FromPercent + //ExFor:PreferredWidth.GetHashCode + //ExFor:PreferredWidth.ToString + //ExSummary:Shows how to set a preferred width for table cells. + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + Table table = builder.startTable(); + + // There are two ways of applying the "PreferredWidth" class to table cells. + // 1 - Set an absolute preferred width based on points: + builder.insertCell(); + builder.getCellFormat().setPreferredWidth(PreferredWidth.fromPoints(40.0)); + builder.getCellFormat().getShading().setBackgroundPatternColor(Color.YELLOW); + builder.writeln(MessageFormat.format("Cell with a width of {0}.", builder.getCellFormat().getPreferredWidth())); + + // 2 - Set a relative preferred width based on percent of the table's width: + builder.insertCell(); + builder.getCellFormat().setPreferredWidth(PreferredWidth.fromPercent(20.0)); + builder.getCellFormat().getShading().setBackgroundPatternColor(Color.BLUE); + builder.writeln(MessageFormat.format("Cell with a width of {0}.", builder.getCellFormat().getPreferredWidth())); + + builder.insertCell(); + + // A cell with no preferred width specified will take up the rest of the available space. + builder.getCellFormat().setPreferredWidth(PreferredWidth.AUTO); + + // Each configuration of the "PreferredWidth" property creates a new object. + Assert.assertNotEquals(table.getFirstRow().getCells().get(1).getCellFormat().getPreferredWidth().hashCode(), + builder.getCellFormat().getPreferredWidth().hashCode()); + + builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN); + builder.writeln("Automatically sized cell."); + + doc.save(getArtifactsDir() + "DocumentBuilder.InsertCellsWithPreferredWidths.docx"); + //ExEnd + + Assert.assertEquals(100.0d, PreferredWidth.fromPercent(100.0).getValue()); + Assert.assertEquals(100.0d, PreferredWidth.fromPoints(100.0).getValue()); + + doc = new Document(getArtifactsDir() + "DocumentBuilder.InsertCellsWithPreferredWidths.docx"); + table = doc.getFirstSection().getBody().getTables().get(0); + + Assert.assertEquals(PreferredWidthType.POINTS, table.getFirstRow().getCells().get(0).getCellFormat().getPreferredWidth().getType()); + Assert.assertEquals(40.0d, table.getFirstRow().getCells().get(0).getCellFormat().getPreferredWidth().getValue()); + Assert.assertEquals("Cell with a width of 800.", table.getFirstRow().getCells().get(0).getText().trim()); + + Assert.assertEquals(PreferredWidthType.PERCENT, table.getFirstRow().getCells().get(1).getCellFormat().getPreferredWidth().getType()); + Assert.assertEquals(20.0d, table.getFirstRow().getCells().get(1).getCellFormat().getPreferredWidth().getValue()); + Assert.assertEquals("Cell with a width of 20%.", table.getFirstRow().getCells().get(1).getText().trim()); + + Assert.assertEquals(PreferredWidthType.AUTO, table.getFirstRow().getCells().get(2).getCellFormat().getPreferredWidth().getType()); + Assert.assertEquals(0.0d, table.getFirstRow().getCells().get(2).getCellFormat().getPreferredWidth().getValue()); + Assert.assertEquals("Automatically sized cell.", table.getFirstRow().getCells().get(2).getText().trim()); + } + + @Test + public void insertTableFromHtml() throws Exception { + Document doc = new Document(); + DocumentBuilder builder = new DocumentBuilder(doc); + + // Insert the table from HTML. Note that AutoFitSettings does not apply to tables + // inserted from HTML. + builder.insertHtml("| Row 1, Cell 1 | " + "Row 1, Cell 2 | " + "
| Row 2, Cell 2 | " + "Row 2, Cell 2 | " + "
paragraph 1
\nparagraph 2
\n