java.lang.Objectcom.aspose.words.Shading
public class Shading
Example: Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Set paragraph borders
BorderCollection borders = builder.getParagraphFormat().getBorders();
borders.setDistanceFromText(20);
borders.getByBorderType(BorderType.LEFT).setLineStyle(LineStyle.DOUBLE);
borders.getByBorderType(BorderType.RIGHT).setLineStyle(LineStyle.DOUBLE);
borders.getByBorderType(BorderType.TOP).setLineStyle(LineStyle.DOUBLE);
borders.getByBorderType(BorderType.BOTTOM).setLineStyle(LineStyle.DOUBLE);
// Set paragraph shading
Shading shading = builder.getParagraphFormat().getShading();
shading.setTexture(TextureIndex.TEXTURE_DIAGONAL_CROSS);
shading.setBackgroundPatternColor(new Color(240, 128, 128)); // Light Coral
shading.setForegroundPatternColor(new Color(255, 160, 122)); // Light Salmon
builder.write("I'm a formatted paragraph with double border and nice shading.");
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Table table = builder.startTable();
builder.insertCell();
// Set the borders for the entire table.
table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK);
// Set the cell shading for this cell.
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED);
builder.writeln("Cell #1");
builder.insertCell();
// Specify a different cell shading for the second cell.
builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN);
builder.writeln("Cell #2");
// End this row.
builder.endRow();
// Clear the cell formatting from previous operations.
builder.getCellFormat().clearFormatting();
// Create the second row.
builder.insertCell();
// Create larger borders for the first cell of this row. This will be different
// compared to the borders set for the table.
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.writeln("Cell #3");
builder.insertCell();
// Clear the cell formatting from the previous cell.
builder.getCellFormat().clearFormatting();
builder.writeln("Cell #4");
doc.save(getMyDir() + "Table.SetBordersAndShading Out.doc");
Property Getters/Setters Summary | ||
---|---|---|
java.awt.Color | getBackgroundPatternColor() | |
void | setBackgroundPatternColor(java.awt.Color value) | |
Gets or sets the color that's applied to the background of the Shading object. | ||
java.awt.Color | getForegroundPatternColor() | |
void | setForegroundPatternColor(java.awt.Color value) | |
Gets or sets the color that's applied to the foreground of the Shading object. | ||
int | getTexture() | |
void | setTexture(int value) | |
Gets or sets the shading texture. The value of the property is TextureIndex integer constant. |
Method Summary | ||
---|---|---|
void | clearFormatting() | |
Removes shading from the object. | ||
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 |
---|
getBackgroundPatternColor/setBackgroundPatternColor | |
public java.awt.Color getBackgroundPatternColor() / public void setBackgroundPatternColor(java.awt.Color value) |
Example:
Shows how to apply borders and shading to a paragraph.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set paragraph borders BorderCollection borders = builder.getParagraphFormat().getBorders(); borders.setDistanceFromText(20); borders.getByBorderType(BorderType.LEFT).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.RIGHT).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.TOP).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.BOTTOM).setLineStyle(LineStyle.DOUBLE); // Set paragraph shading Shading shading = builder.getParagraphFormat().getShading(); shading.setTexture(TextureIndex.TEXTURE_DIAGONAL_CROSS); shading.setBackgroundPatternColor(new Color(240, 128, 128)); // Light Coral shading.setForegroundPatternColor(new Color(255, 160, 122)); // Light Salmon builder.write("I'm a formatted paragraph with double border and nice shading.");
Example:
Shows how to format table and cell with different borders and shadingsDocument doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); builder.insertCell(); // Set the borders for the entire table. table.setBorders(LineStyle.SINGLE, 2.0, Color.BLACK); // Set the cell shading for this cell. builder.getCellFormat().getShading().setBackgroundPatternColor(Color.RED); builder.writeln("Cell #1"); builder.insertCell(); // Specify a different cell shading for the second cell. builder.getCellFormat().getShading().setBackgroundPatternColor(Color.GREEN); builder.writeln("Cell #2"); // End this row. builder.endRow(); // Clear the cell formatting from previous operations. builder.getCellFormat().clearFormatting(); // Create the second row. builder.insertCell(); // Create larger borders for the first cell of this row. This will be different // compared to the borders set for the table. 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.writeln("Cell #3"); builder.insertCell(); // Clear the cell formatting from the previous cell. builder.getCellFormat().clearFormatting(); builder.writeln("Cell #4"); doc.save(getMyDir() + "Table.SetBordersAndShading Out.doc");
Example:
Shows how to create a formatted table using DocumentBuilderDocument doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Table table = builder.startTable(); // Make the header row. builder.insertCell(); // Set the left indent for the table. Table wide formatting must be applied after // at least one row is present in the table. table.setLeftIndent(20.0); // Set height and define the height rule for the header row. builder.getRowFormat().setHeight(40.0); builder.getRowFormat().setHeightRule(HeightRule.AT_LEAST); // Some special features for the header row. builder.getCellFormat().getShading().setBackgroundPatternColor(new Color(198, 217, 241)); builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER); builder.getFont().setSize(16); builder.getFont().setName("Arial"); builder.getFont().setBold (true); builder.getCellFormat().setWidth(100.0); builder.write("Header Row,\n Cell 1"); // We don't need to specify the width of this cell because it's inherited from the previous cell. builder.insertCell(); builder.write("Header Row,\n Cell 2"); builder.insertCell(); builder.getCellFormat().setWidth(200.0); builder.write("Header Row,\n Cell 3"); builder.endRow(); // Set features for the other rows and cells. builder.getCellFormat().getShading().setBackgroundPatternColor(Color.WHITE); builder.getCellFormat().setWidth(100.0); builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER); // Reset height and define a different height rule for table body builder.getRowFormat().setHeight(30.0); builder.getRowFormat().setHeightRule(HeightRule.AUTO); builder.insertCell(); // Reset font formatting. builder.getFont().setSize(12); builder.getFont().setBold(false); // Build the other cells. builder.write("Row 1, Cell 1 Content"); builder.insertCell(); builder.write("Row 1, Cell 2 Content"); builder.insertCell(); builder.getCellFormat().setWidth(200.0); builder.write("Row 1, Cell 3 Content"); builder.endRow(); builder.insertCell(); builder.getCellFormat().setWidth(100.0); builder.write("Row 2, Cell 1 Content"); builder.insertCell(); builder.write("Row 2, Cell 2 Content"); builder.insertCell(); builder.getCellFormat().setWidth(200.0); builder.write("Row 2, Cell 3 Content."); builder.endRow(); builder.endTable(); doc.save(getMyDir() + "DocumentBuilder.CreateFormattedTable Out.doc");
getForegroundPatternColor/setForegroundPatternColor | |
public java.awt.Color getForegroundPatternColor() / public void setForegroundPatternColor(java.awt.Color value) |
Example:
Shows how to apply borders and shading to a paragraph.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set paragraph borders BorderCollection borders = builder.getParagraphFormat().getBorders(); borders.setDistanceFromText(20); borders.getByBorderType(BorderType.LEFT).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.RIGHT).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.TOP).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.BOTTOM).setLineStyle(LineStyle.DOUBLE); // Set paragraph shading Shading shading = builder.getParagraphFormat().getShading(); shading.setTexture(TextureIndex.TEXTURE_DIAGONAL_CROSS); shading.setBackgroundPatternColor(new Color(240, 128, 128)); // Light Coral shading.setForegroundPatternColor(new Color(255, 160, 122)); // Light Salmon builder.write("I'm a formatted paragraph with double border and nice shading.");
getTexture/setTexture | |
public int getTexture() / public void setTexture(int value) |
Example:
Shows how to apply borders and shading to a paragraph.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set paragraph borders BorderCollection borders = builder.getParagraphFormat().getBorders(); borders.setDistanceFromText(20); borders.getByBorderType(BorderType.LEFT).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.RIGHT).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.TOP).setLineStyle(LineStyle.DOUBLE); borders.getByBorderType(BorderType.BOTTOM).setLineStyle(LineStyle.DOUBLE); // Set paragraph shading Shading shading = builder.getParagraphFormat().getShading(); shading.setTexture(TextureIndex.TEXTURE_DIAGONAL_CROSS); shading.setBackgroundPatternColor(new Color(240, 128, 128)); // Light Coral shading.setForegroundPatternColor(new Color(255, 160, 122)); // Light Salmon builder.write("I'm a formatted paragraph with double border and nice shading.");
Method Detail |
---|
clearFormatting | |
public void clearFormatting() |
equals | |
public boolean equals(java.lang.Object obj) |
hashCode | |
public int hashCode() |