Theme
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Cloneable
public class Theme implements Cloneable
Represents document Theme, and provides access to main theme parts including getMajorFonts(), getMinorFonts() and getColors()
To learn more, visit the Working with Styles and Themes documentation article.
Examples:
Shows how to set custom colors and fonts for themes.
Document doc = new Document(getMyDir() + "Theme colors.docx");
// The "Theme" object gives us access to the document theme, a source of default fonts and colors.
Theme theme = doc.getTheme();
// Some styles, such as "Heading 1" and "Subtitle", will inherit these fonts.
theme.getMajorFonts().setLatin("Courier New");
theme.getMinorFonts().setLatin("Agency FB");
// Other languages may also have their custom fonts in this theme.
Assert.assertEquals(theme.getMajorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMajorFonts().getEastAsian(), "");
Assert.assertEquals(theme.getMinorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMinorFonts().getEastAsian(), "");
// The "Colors" property contains the color palette from Microsoft Word,
// which appears when changing shading or font color.
// Apply custom colors to the color palette so we have easy access to them in Microsoft Word
// when we, for example, change the font color via "Home" -> "Font" -> "Font Color",
// or insert a shape, and then set a color for it via "Shape Format" -> "Shape Styles".
ThemeColors colors = theme.getColors();
colors.setDark1(Color.BLUE);
colors.setLight1(Color.GREEN);
colors.setDark2(Color.MAGENTA);
colors.setLight2(Color.BLACK);
colors.setAccent1(Color.RED);
colors.setAccent2(Color.PINK);
colors.setAccent3(Color.YELLOW);
colors.setAccent4(Color.orange);
colors.setAccent5(Color.cyan);
colors.setAccent6(Color.darkGray);
// Apply custom colors to hyperlinks in their clicked and un-clicked states.
colors.setHyperlink(Color.WHITE);
colors.setFollowedHyperlink(Color.lightGray);
doc.save(getArtifactsDir() + "Themes.CustomColorsAndFonts.docx");
Methods
| Method | Description |
|---|---|
| getColors() | Allows to specify the set of theme colors for the document. |
| getFontName(int themeFont) | |
| getMajorFonts() | Allows to specify the set of major fonts for different languages. |
| getMinorFonts() | Allows to specify the set of minor fonts for different languages. |
| onChange() |
getColors()
public ThemeColors getColors()
Allows to specify the set of theme colors for the document.
Examples:
Shows how to set custom colors and fonts for themes.
Document doc = new Document(getMyDir() + "Theme colors.docx");
// The "Theme" object gives us access to the document theme, a source of default fonts and colors.
Theme theme = doc.getTheme();
// Some styles, such as "Heading 1" and "Subtitle", will inherit these fonts.
theme.getMajorFonts().setLatin("Courier New");
theme.getMinorFonts().setLatin("Agency FB");
// Other languages may also have their custom fonts in this theme.
Assert.assertEquals(theme.getMajorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMajorFonts().getEastAsian(), "");
Assert.assertEquals(theme.getMinorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMinorFonts().getEastAsian(), "");
// The "Colors" property contains the color palette from Microsoft Word,
// which appears when changing shading or font color.
// Apply custom colors to the color palette so we have easy access to them in Microsoft Word
// when we, for example, change the font color via "Home" -> "Font" -> "Font Color",
// or insert a shape, and then set a color for it via "Shape Format" -> "Shape Styles".
ThemeColors colors = theme.getColors();
colors.setDark1(Color.BLUE);
colors.setLight1(Color.GREEN);
colors.setDark2(Color.MAGENTA);
colors.setLight2(Color.BLACK);
colors.setAccent1(Color.RED);
colors.setAccent2(Color.PINK);
colors.setAccent3(Color.YELLOW);
colors.setAccent4(Color.orange);
colors.setAccent5(Color.cyan);
colors.setAccent6(Color.darkGray);
// Apply custom colors to hyperlinks in their clicked and un-clicked states.
colors.setHyperlink(Color.WHITE);
colors.setFollowedHyperlink(Color.lightGray);
doc.save(getArtifactsDir() + "Themes.CustomColorsAndFonts.docx");
Returns: ThemeColors - The corresponding ThemeColors value.
getFontName(int themeFont)
public String getFontName(int themeFont)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| themeFont | int |
Returns: java.lang.String
getMajorFonts()
public ThemeFonts getMajorFonts()
Allows to specify the set of major fonts for different languages.
Examples:
Shows how to set custom colors and fonts for themes.
Document doc = new Document(getMyDir() + "Theme colors.docx");
// The "Theme" object gives us access to the document theme, a source of default fonts and colors.
Theme theme = doc.getTheme();
// Some styles, such as "Heading 1" and "Subtitle", will inherit these fonts.
theme.getMajorFonts().setLatin("Courier New");
theme.getMinorFonts().setLatin("Agency FB");
// Other languages may also have their custom fonts in this theme.
Assert.assertEquals(theme.getMajorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMajorFonts().getEastAsian(), "");
Assert.assertEquals(theme.getMinorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMinorFonts().getEastAsian(), "");
// The "Colors" property contains the color palette from Microsoft Word,
// which appears when changing shading or font color.
// Apply custom colors to the color palette so we have easy access to them in Microsoft Word
// when we, for example, change the font color via "Home" -> "Font" -> "Font Color",
// or insert a shape, and then set a color for it via "Shape Format" -> "Shape Styles".
ThemeColors colors = theme.getColors();
colors.setDark1(Color.BLUE);
colors.setLight1(Color.GREEN);
colors.setDark2(Color.MAGENTA);
colors.setLight2(Color.BLACK);
colors.setAccent1(Color.RED);
colors.setAccent2(Color.PINK);
colors.setAccent3(Color.YELLOW);
colors.setAccent4(Color.orange);
colors.setAccent5(Color.cyan);
colors.setAccent6(Color.darkGray);
// Apply custom colors to hyperlinks in their clicked and un-clicked states.
colors.setHyperlink(Color.WHITE);
colors.setFollowedHyperlink(Color.lightGray);
doc.save(getArtifactsDir() + "Themes.CustomColorsAndFonts.docx");
Returns: ThemeFonts - The corresponding ThemeFonts value.
getMinorFonts()
public ThemeFonts getMinorFonts()
Allows to specify the set of minor fonts for different languages.
Examples:
Shows how to set custom colors and fonts for themes.
Document doc = new Document(getMyDir() + "Theme colors.docx");
// The "Theme" object gives us access to the document theme, a source of default fonts and colors.
Theme theme = doc.getTheme();
// Some styles, such as "Heading 1" and "Subtitle", will inherit these fonts.
theme.getMajorFonts().setLatin("Courier New");
theme.getMinorFonts().setLatin("Agency FB");
// Other languages may also have their custom fonts in this theme.
Assert.assertEquals(theme.getMajorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMajorFonts().getEastAsian(), "");
Assert.assertEquals(theme.getMinorFonts().getComplexScript(), "");
Assert.assertEquals(theme.getMinorFonts().getEastAsian(), "");
// The "Colors" property contains the color palette from Microsoft Word,
// which appears when changing shading or font color.
// Apply custom colors to the color palette so we have easy access to them in Microsoft Word
// when we, for example, change the font color via "Home" -> "Font" -> "Font Color",
// or insert a shape, and then set a color for it via "Shape Format" -> "Shape Styles".
ThemeColors colors = theme.getColors();
colors.setDark1(Color.BLUE);
colors.setLight1(Color.GREEN);
colors.setDark2(Color.MAGENTA);
colors.setLight2(Color.BLACK);
colors.setAccent1(Color.RED);
colors.setAccent2(Color.PINK);
colors.setAccent3(Color.YELLOW);
colors.setAccent4(Color.orange);
colors.setAccent5(Color.cyan);
colors.setAccent6(Color.darkGray);
// Apply custom colors to hyperlinks in their clicked and un-clicked states.
colors.setHyperlink(Color.WHITE);
colors.setFollowedHyperlink(Color.lightGray);
doc.save(getArtifactsDir() + "Themes.CustomColorsAndFonts.docx");
Returns: ThemeFonts - The corresponding ThemeFonts value.
onChange()
public void onChange()
