StyleSettings (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.comparison.options.style.StyleSettings

public class StyleSettings
extends Object

This class represents style settings for text formatting.

Use this class to customize the font color, highlight color, style attributes (bold, underline, italic, strikethrough), string separators, original sizes, and word separators for text.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    StyleSettings styleSettings = new StyleSettings();
    styleSettings.setFontColor(Color.GREEN);
    styleSettings.setBold(true);
    styleSettings.setUnderline(true);

    final CompareOptions compareOptions = new CompareOptions();
    compareOptions.setInsertedItemStyle(styleSettings);

    comparer.compare(resultFile, compareOptions);
 }

See Also:: Comparer, StyleSettings, CompareOptions

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StyleSettings.Builder
A StyleSettings builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StyleSettings.Builder` A `StyleSettings` builder.

Constructor Summary

Constructors
Constructor and Description

StyleSettings()
Initializes a new instance of the StyleSettings class.

Constructors
Constructor and Description
`StyleSettings()` Initializes a new instance of the StyleSettings class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getEndStringSeparator()` Gets the end string separator.
`Color`	`getFontColor()` Gets the font color.
`Color`	`getHighlightColor()` Gets the highlight color.
`Size`	`getOriginalSize()` Gets the original size of comparing documents.
`String`	`getStartStringSeparator()` Gets the start string separator.
`char[]`	`getWordsSeparators()` Gets the word separator chars.
`boolean`	`isBold()` Gets a flag that indicates whether the text will be bold or not.
`boolean`	`isItalic()` Gets a flag that indicates whether the text will be italic or not.
`boolean`	`isStrikethrough()` Gets a flag that indicates whether the text will be strike through or not.
`boolean`	`isUnderline()` Gets a flag that indicates whether the text will be underlined or not.
`void`	`setBold(boolean value)` Sets a flag that indicates whether the text should be bold or not.
`void`	`setEndStringSeparator(String value)` Sets the end string separator.
`void`	`setFontColor(Color value)` Sets the font color.
`void`	`setHighlightColor(Color value)` Sets the highlight color.
`void`	`setItalic(boolean value)` Sets a flag that indicates whether the text should be italic or not.
`void`	`setOriginalSize(Size value)` Sets the original size of comparing documents.
`void`	`setStartStringSeparator(String value)` Sets the start string separator.
`void`	`setStrikethrough(boolean value)` Sets a flag that indicates whether the text should be strike through or not.
`void`	`setUnderline(boolean value)` Sets a flag that indicates whether the text should be underlined or not.
`void`	`setWordsSeparators(char[] value)` Sets the word separator chars.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StyleSettings
```
public StyleSettings()
```
    Initializes a new instance of the StyleSettings class.
- Method Detail
  - getEndStringSeparator
```
public final String getEndStringSeparator()
```
    Gets the end string separator.
    
    Returns:
    
    the end string separator.
  - getFontColor
```
public final Color getFontColor()
```
    Gets the font color.
    
    Returns:
    
    the font color.
  - getHighlightColor
```
public final Color getHighlightColor()
```
    Gets the highlight color.
    
    Returns:
    
    the highlight color.
  - getOriginalSize
```
public final Size getOriginalSize()
```
    Gets the original size of comparing documents.
    
    Returns:
    
    the original size of comparing documents.
  - getStartStringSeparator
```
public final String getStartStringSeparator()
```
    Gets the start string separator.
    
    Returns:
    
    the start string separator.
  - getWordsSeparators
```
public final char[] getWordsSeparators()
```
    Gets the word separator chars.
    
    Returns:
    
    the word separators.
  - isBold
```
public final boolean isBold()
```
    Gets a flag that indicates whether the text will be bold or not.
    
    Returns:
    
    true if the text will be bold, false otherwise.
  - isItalic
```
public final boolean isItalic()
```
    Gets a flag that indicates whether the text will be italic or not.
    
    Returns:
    
    true if the text will be italic, false otherwise.
  - isStrikethrough
```
public final boolean isStrikethrough()
```
    Gets a flag that indicates whether the text will be strike through or not.
    
    Returns:
    
    true if the text will be strike through, false otherwise.
  - isUnderline
```
public final boolean isUnderline()
```
    Gets a flag that indicates whether the text will be underlined or not.
    
    Returns:
    
    true if the text will be underlined, false otherwise.
  - setBold
```
public final void setBold(boolean value)
```
    Sets a flag that indicates whether the text should be bold or not.
    
    Parameters:
    
    value - true if the text should be bold, false otherwise.
  - setEndStringSeparator
```
public final void setEndStringSeparator(String value)
```
    Sets the end string separator.
    
    Parameters:
    
    value - The new end string separator.
  - setFontColor
```
public final void setFontColor(Color value)
```
    Sets the font color.
    
    Parameters:
    
    value - The new font color.
  - setHighlightColor
```
public final void setHighlightColor(Color value)
```
    Sets the highlight color.
    
    Parameters:
    
    value - The new highlight color.
  - setItalic
```
public final void setItalic(boolean value)
```
    Sets a flag that indicates whether the text should be italic or not.
    
    Parameters:
    
    value - true if the text should be italic, false otherwise.
  - setOriginalSize
```
public final void setOriginalSize(Size value)
```
    Sets the original size of comparing documents.
    
    Parameters:
    
    value - The new original size of comparing documents.
  - setStartStringSeparator
```
public final void setStartStringSeparator(String value)
```
    Sets the start string separator.
    
    Parameters:
    
    value - The new start string separator.
  - setStrikethrough
```
public final void setStrikethrough(boolean value)
```
    Sets a flag that indicates whether the text should be strike through or not.
    
    Parameters:
    
    value - true if the text should be strike through, false otherwise.
  - setUnderline
```
public final void setUnderline(boolean value)
```
    Sets a flag that indicates whether the text should be underlined or not.
    
    Parameters:
    
    value - true if the text should be underlined, false otherwise.
  - setWordsSeparators
```
public final void setWordsSeparators(char[] value)
```
    Sets the word separator chars.
    
    Parameters:
    
    value - The new word separators.

Class StyleSettings

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StyleSettings

Method Detail

getEndStringSeparator

getFontColor

getHighlightColor

getOriginalSize

getStartStringSeparator

getWordsSeparators

isBold

isItalic

isStrikethrough

isUnderline

setBold

setEndStringSeparator

setFontColor

setHighlightColor

setItalic

setOriginalSize

setStartStringSeparator

setStrikethrough

setUnderline

setWordsSeparators