com.aspose.words
Class Shading

java.lang.Object
  InternableComplexAttr
      com.aspose.words.Shading

All Implemented Interfaces:

java.lang.Cloneable

public class Shading 
extends InternableComplexAttr

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

BorderCollection borders = builder.getParagraphFormat().getBorders();
borders.setDistanceFromText(20.0);
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);

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("This paragraph is formatted with a double border and shading.");
doc.save(getArtifactsDir() + "DocumentBuilder.ApplyBordersAndShading.docx");

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");

public java.awt.Color getBackgroundPatternColor() / public void setBackgroundPatternColor(java.awt.Color value)

Gets or sets the color that's applied to the background of the Shading object.

Example:

Shows how to decorate text with borders and shading.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

BorderCollection borders = builder.getParagraphFormat().getBorders();
borders.setDistanceFromText(20.0);
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);

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("This paragraph is formatted with a double border and shading.");
doc.save(getArtifactsDir() + "DocumentBuilder.ApplyBordersAndShading.docx");

public int getBackgroundPatternThemeColor() / public void setBackgroundPatternThemeColor(int value)

Gets or sets the background pattern theme color in the applied color scheme that is associated with this Shading object. The value of the property is ThemeColor integer constant.

Example:

Shows how to set foreground and background colors for shading texture.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Shading shading = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getShading();
shading.setTexture(TextureIndex.TEXTURE_12_PT_5_PERCENT);
shading.setForegroundPatternThemeColor(ThemeColor.DARK_1);
shading.setBackgroundPatternThemeColor(ThemeColor.DARK_2);

shading.setForegroundTintAndShade(0.5);
shading.setBackgroundTintAndShade(-0.2);

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5d);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.writeln("Foreground and background pattern colors for shading texture.");

doc.save(getArtifactsDir() + "Font.ForegroundAndBackground.docx");

public double getBackgroundTintAndShade() / public void setBackgroundTintAndShade(double value)

Gets or sets a double value that lightens or darkens a background theme color.

The allowed values are in the range from -1 (the darkest) to 1 (the lightest) for this property.

Zero (0) is neutral.

Example:

Shows how to set foreground and background colors for shading texture.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Shading shading = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getShading();
shading.setTexture(TextureIndex.TEXTURE_12_PT_5_PERCENT);
shading.setForegroundPatternThemeColor(ThemeColor.DARK_1);
shading.setBackgroundPatternThemeColor(ThemeColor.DARK_2);

shading.setForegroundTintAndShade(0.5);
shading.setBackgroundTintAndShade(-0.2);

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5d);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.writeln("Foreground and background pattern colors for shading texture.");

doc.save(getArtifactsDir() + "Font.ForegroundAndBackground.docx");

public java.awt.Color getForegroundPatternColor() / public void setForegroundPatternColor(java.awt.Color value)

Gets or sets the color that's applied to the foreground of the Shading object.

Example:

Shows how to decorate text with borders and shading.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

BorderCollection borders = builder.getParagraphFormat().getBorders();
borders.setDistanceFromText(20.0);
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);

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("This paragraph is formatted with a double border and shading.");
doc.save(getArtifactsDir() + "DocumentBuilder.ApplyBordersAndShading.docx");

public int getForegroundPatternThemeColor() / public void setForegroundPatternThemeColor(int value)

Gets or sets the foreground pattern theme color in the applied color scheme that is associated with this Shading object. The value of the property is ThemeColor integer constant.

Example:

Shows how to set foreground and background colors for shading texture.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Shading shading = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getShading();
shading.setTexture(TextureIndex.TEXTURE_12_PT_5_PERCENT);
shading.setForegroundPatternThemeColor(ThemeColor.DARK_1);
shading.setBackgroundPatternThemeColor(ThemeColor.DARK_2);

shading.setForegroundTintAndShade(0.5);
shading.setBackgroundTintAndShade(-0.2);

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5d);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.writeln("Foreground and background pattern colors for shading texture.");

doc.save(getArtifactsDir() + "Font.ForegroundAndBackground.docx");

public double getForegroundTintAndShade() / public void setForegroundTintAndShade(double value)

Gets or sets a double value that lightens or darkens a foreground theme color.

The allowed values are in the range from -1 (the darkest) to 1 (the lightest) for this property.

Zero (0) is neutral.

Example:

Shows how to set foreground and background colors for shading texture.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Shading shading = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getShading();
shading.setTexture(TextureIndex.TEXTURE_12_PT_5_PERCENT);
shading.setForegroundPatternThemeColor(ThemeColor.DARK_1);
shading.setBackgroundPatternThemeColor(ThemeColor.DARK_2);

shading.setForegroundTintAndShade(0.5);
shading.setBackgroundTintAndShade(-0.2);

builder.getFont().getBorder().setColor(Color.GREEN);
builder.getFont().getBorder().setLineWidth(2.5d);
builder.getFont().getBorder().setLineStyle(LineStyle.DASH_DOT_STROKER);

builder.writeln("Foreground and background pattern colors for shading texture.");

doc.save(getArtifactsDir() + "Font.ForegroundAndBackground.docx");

public int getTexture() / public void setTexture(int value)

Gets or sets the shading texture. The value of the property is TextureIndex integer constant.

Example:

Shows how to decorate text with borders and shading.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

BorderCollection borders = builder.getParagraphFormat().getBorders();
borders.setDistanceFromText(20.0);
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);

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("This paragraph is formatted with a double border and shading.");
doc.save(getArtifactsDir() + "DocumentBuilder.ApplyBordersAndShading.docx");

public void clearFormatting()

Removes shading from the object.

Example:

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");

public boolean equals(Shading rhs)

Determines whether the specified Shading is equal in value to the current Shading.

public boolean equals(java.lang.Object obj)

Determines whether the specified object is equal in value to the current object.

public int hashCode()

Serves as a hash function for this type.