com.groupdocs.watermark.search

Class FormattedTextFragmentCollection

java.lang.Object

com.groupdocs.watermark.common.ReadOnlyListBase<T>

com.groupdocs.watermark.common.RemoveOnlyListBase<FormattedTextFragment>

com.groupdocs.watermark.search.FormattedTextFragmentCollection

All Implemented Interfaces:

IReadOnlyList<FormattedTextFragment>, Iterable<FormattedTextFragment>

Direct Known Subclasses:

DiagramFormattedTextFragmentCollection, PdfFormattedTextFragmentCollection, PresentationFormattedTextFragmentCollection, SpreadsheetCellFormattedTextFragmentCollection, SpreadsheetShapeFormattedTextFragmentCollection, SpreadsheetTextEffectFormattedTextFragmentCollection, WordProcessingFormattedTextFragmentCollection

public class FormattedTextFragmentCollection
extends RemoveOnlyListBase<FormattedTextFragment>

Represents a mutable collection of formatted text fragments.

This collection contains the items of FormattedTextFragment base type.

Constructor Summary

Constructors

Constructor and Description
FormattedTextFragmentCollection(int collectionType)

Method Summary

Modifier and Type	Method and Description
void	add(String text) Adds a formatted text fragment to the collection.
void	add(String text, Font font) Adds a formatted text fragment to the collection.
void	add(String text, Font font, Color foregroundColor) Adds a formatted text fragment to the collection.
void	add(String text, Font font, Color foregroundColor, Color backgroundColor) Adds a formatted text fragment to the collection.
FormattedTextFragment	createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
int	getCollectionType() Gets the formatted fragment collection type.
Color	getDefaultBackgroundColor()
Font	getDefaultFont()
Color	getDefaultForegroundColor()
String	getText()
void	insert(int index, String text) Inserts a formatted text fragment into the collection at a given index.
void	insert(int index, String text, Font font) Inserts a formatted text fragment into the collection at a given index.
void	insert(int index, String text, Font font, Color foregroundColor) Inserts a formatted text fragment into the collection at a given index.
void	insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor) Inserts a formatted text fragment into the collection at a given index.
void	setText(String text)

Methods inherited from class com.groupdocs.watermark.common.RemoveOnlyListBase

clear, isReadOnly, remove, removeAt, removeFromDocument

Methods inherited from class com.groupdocs.watermark.common.ReadOnlyListBase

addInternally, contains, get_Item, getCount, getInnerList, indexOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FormattedTextFragmentCollection

public FormattedTextFragmentCollection(int collectionType)

Method Detail

add

public final void add(String text)

Adds a formatted text fragment to the collection.

Parameters:

text - The fragment text.

add

public final void add(String text,
                      Font font)

Adds a formatted text fragment to the collection.

Parameters:

text - The fragment text.

font - The font of the text.

add

public final void add(String text,
                      Font font,
                      Color foregroundColor)

Adds a formatted text fragment to the collection.

Parameters:

text - The fragment text.

font - The font of the text.

foregroundColor - The foreground color of the text.

add

public final void add(String text,
                      Font font,
                      Color foregroundColor,
                      Color backgroundColor)

Adds a formatted text fragment to the collection.

Parameters:

text - The fragment text.

font - The font of the text.

foregroundColor - The foreground color of the text.

backgroundColor - The background color of the text.

createInDocument

public FormattedTextFragment createInDocument(int index,
                                              String text,
                                              Font font,
                                              Color foregroundColor,
                                              Color backgroundColor)

getCollectionType

public final int getCollectionType()

Gets the formatted fragment collection type.

Returns:

The formatted fragment collection type.

getDefaultBackgroundColor

public final Color getDefaultBackgroundColor()

getDefaultFont

public final Font getDefaultFont()

getDefaultForegroundColor

public final Color getDefaultForegroundColor()

getText

public String getText()

insert

public final void insert(int index,
                         String text)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

index - The zero-based index at which formatted text fragment should be inserted.

text - The fragment text.

insert

public final void insert(int index,
                         String text,
                         Font font)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

index - The zero-based index at which formatted text fragment should be inserted.

text - The fragment text.

font - The font of the text.

insert

public final void insert(int index,
                         String text,
                         Font font,
                         Color foregroundColor)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

index - The zero-based index at which formatted text fragment should be inserted.

text - The fragment text.

font - The font of the text.

foregroundColor - The foreground color of the text.

insert

public final void insert(int index,
                         String text,
                         Font font,
                         Color foregroundColor,
                         Color backgroundColor)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

index - The zero-based index at which formatted text fragment should be inserted.

text - The fragment text.

font - The font of the text.

foregroundColor - The foreground color of the text.

backgroundColor - The background color of the text.

setText

public void setText(String text)