public class TextColumn
extends java.lang.Object
implements java.lang.Cloneable
TextColumn is a member of the TextColumnCollection collection. The TextColumn collection includes all the columns in a section of a document.
To learn more, visit the Working with Sections documentation article.
Remarks:
TextColumn objects are only used to specify columns with custom width and spacing. If you want the columns in the document to be of equal width, set TextColumns. TextColumnCollection.getEvenlySpaced() / TextColumnCollection.setEvenlySpaced(boolean) to true.
When a new TextColumn is created it has its width and spacing set to zero.
Examples:
Shows how to create unevenly spaced columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
PageSetup pageSetup = builder.getPageSetup();
TextColumnCollection columns = pageSetup.getTextColumns();
columns.setEvenlySpaced(false);
columns.setCount(2);
// Determine the amount of room that we have available for arranging columns.
double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
Assert.assertEquals(468.0d, contentWidth, 0.01d);
// Set the first column to be narrow.
TextColumn column = columns.get(0);
column.setWidth(100.0);
column.setSpaceAfter(20.0);
// Set the second column to take the rest of the space available within the margins of the page.
column = columns.get(1);
column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
builder.writeln("Narrow column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Wide column 2.");
doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
TextColumnCollection,
PageSetup,
Section| Modifier and Type | Method and Description |
|---|---|
double |
getSpaceAfter()
Gets the space between this column and the next column in points.
|
double |
getWidth()
Gets the width of the text column in points.
|
protected java.lang.Object |
memberwiseClone() |
void |
setSpaceAfter(double value)
Sets the space between this column and the next column in points.
|
void |
setWidth(double value)
Sets the width of the text column in points.
|
public double getWidth()
Examples:
Shows how to create unevenly spaced columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
PageSetup pageSetup = builder.getPageSetup();
TextColumnCollection columns = pageSetup.getTextColumns();
columns.setEvenlySpaced(false);
columns.setCount(2);
// Determine the amount of room that we have available for arranging columns.
double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
Assert.assertEquals(468.0d, contentWidth, 0.01d);
// Set the first column to be narrow.
TextColumn column = columns.get(0);
column.setWidth(100.0);
column.setSpaceAfter(20.0);
// Set the second column to take the rest of the space available within the margins of the page.
column = columns.get(1);
column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
builder.writeln("Narrow column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Wide column 2.");
doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
public void setWidth(double value)
Examples:
Shows how to create unevenly spaced columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
PageSetup pageSetup = builder.getPageSetup();
TextColumnCollection columns = pageSetup.getTextColumns();
columns.setEvenlySpaced(false);
columns.setCount(2);
// Determine the amount of room that we have available for arranging columns.
double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
Assert.assertEquals(468.0d, contentWidth, 0.01d);
// Set the first column to be narrow.
TextColumn column = columns.get(0);
column.setWidth(100.0);
column.setSpaceAfter(20.0);
// Set the second column to take the rest of the space available within the margins of the page.
column = columns.get(1);
column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
builder.writeln("Narrow column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Wide column 2.");
doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
value - The width of the text column in points.public double getSpaceAfter()
Examples:
Shows how to create unevenly spaced columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
PageSetup pageSetup = builder.getPageSetup();
TextColumnCollection columns = pageSetup.getTextColumns();
columns.setEvenlySpaced(false);
columns.setCount(2);
// Determine the amount of room that we have available for arranging columns.
double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
Assert.assertEquals(468.0d, contentWidth, 0.01d);
// Set the first column to be narrow.
TextColumn column = columns.get(0);
column.setWidth(100.0);
column.setSpaceAfter(20.0);
// Set the second column to take the rest of the space available within the margins of the page.
column = columns.get(1);
column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
builder.writeln("Narrow column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Wide column 2.");
doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
public void setSpaceAfter(double value)
Examples:
Shows how to create unevenly spaced columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
PageSetup pageSetup = builder.getPageSetup();
TextColumnCollection columns = pageSetup.getTextColumns();
columns.setEvenlySpaced(false);
columns.setCount(2);
// Determine the amount of room that we have available for arranging columns.
double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
Assert.assertEquals(468.0d, contentWidth, 0.01d);
// Set the first column to be narrow.
TextColumn column = columns.get(0);
column.setWidth(100.0);
column.setSpaceAfter(20.0);
// Set the second column to take the rest of the space available within the margins of the page.
column = columns.get(1);
column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
builder.writeln("Narrow column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Wide column 2.");
doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
value - The space between this column and the next column in points.protected java.lang.Object memberwiseClone()