com.aspose.pdf

Class TextFragmentState

java.lang.Object

com.aspose.pdf.TextState

com.aspose.pdf.TextFragmentState

public final class TextFragmentState
extends TextState

Represents a text state of a text fragment.

  The example demonstrates how to change text color and font size of the text with TextState object.
  
 
  // Open document
  Document doc = new Document("D:\Tests\input.pdf");
  
  // Create TextFragmentAbsorber object to find all "hello world" text occurrences
  TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
  
  // Accept the absorber for first page
  doc.getPages(1).accept(absorber);
  
  // Change foreground color of the first text occurrence
  absorber.TgetextFragments().get(1).getTextState().setForegroundColor ( java.awt.Color.RED);
  // Change font size of the first text occurrence
  absorber.getTextFragments.get(1).getTextState().setFontSize ( 15);
  
  // Save document
  doc.save("D:\Tests\output.pdf");  
        
  

Provides a way to change following properties of the text: font (TextFragmentState.Font property) font size (TextFragmentState.FontSize property) font style (TextFragmentState.FontStyle property) foreground color (TextFragmentState.ForegroundColor property) background color (TextFragmentState.BackgroundColor property) Note that changing TextFragmentState properties may change inner TextFragment.Segments collection because TextFragment is an aggregate object and it may rearrange internal segments or merge them into single segment. If your requirement is to leave the TextFragment.Segments collection unchanged, please change inner segments individually.

See Also:

TextFragmentAbsorber, IDocument

Constructor Summary

Constructors

Constructor and Description
TextFragmentState(TextFragment fragment) Initializes new instance of the TextFragmentState object with specified TextFragment object.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyChangesFrom(TextState textState) Applies settings from another textState
void	applyChangesFrom(TextState textState, boolean groupChangesOnly) Applies settings from another textState
float	getCharacterSpacing() Gets character spacing of the text, represented by the TextFragment object.
Font	getFont() Gets font of the text, represented by the TextFragment object
float	getFontSize() Gets font size of the text, represented by the TextFragment object
Color	getForegroundColor() Gets foreground color of the text, represented by the TextFragment object
int	getHorizontalAlignment() Gets or sets horizontal alignment for the text.
float	getHorizontalScaling()
float	getLineSpacing() Gets or sets line spacing of the text.
float	getWordSpacing()
void	setBackgroundColor(Color value) Sets background color of the text, represented by the TextFragment object
void	setCharacterSpacing(float value)
void	setFont(Font value) Sets font of the text, represented by the TextFragment object
void	setFontSize(float value) Sets font size of the text, represented by the TextFragment object
void	setFontStyle(int value) Sets font style of the text, represented by the TextFragment object
void	setForegroundColor(Color value) Sets foreground color of the text, represented by the TextFragment object
void	setHorizontalAlignment(int value)
void	setHorizontalScaling(float value)
void	setLineSpacing(float value)
void	setUnderline(boolean value) Sets underline for the text, represented by the TextFragment object
void	setWordSpacing(float value)

Methods inherited from class com.aspose.pdf.TextState

calculateFontSize, getBackgroundColor, getUnderline, setBackgroundColor

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFragmentState

public TextFragmentState(TextFragment fragment)

Initializes new instance of the TextFragmentState object with specified TextFragment object. This TextFragmentState initialization is not supported. TextFragmentState is only available with TextFragment.TextState property.

Method Detail

getCharacterSpacing

public float getCharacterSpacing()

Gets character spacing of the text, represented by the TextFragment object.

Overrides:

getCharacterSpacing in class TextState

Returns:

float value

setCharacterSpacing

public void setCharacterSpacing(float value)

Overrides:

setCharacterSpacing in class TextState

getHorizontalScaling

public float getHorizontalScaling()

Overrides:

getHorizontalScaling in class TextState

setHorizontalScaling

public void setHorizontalScaling(float value)

Overrides:

setHorizontalScaling in class TextState

getWordSpacing

public float getWordSpacing()

Overrides:

getWordSpacing in class TextState

setWordSpacing

public void setWordSpacing(float value)

Overrides:

setWordSpacing in class TextState

getLineSpacing

public float getLineSpacing()

Gets or sets line spacing of the text.

Note that the value is not preserved as a text characteristic within the document. The LineSpacing property getter works for an object in case it was explicitly set previously with LineSpacing setter for those object. The property is used by runtime in context of current generation/modification process.

Overrides:

getLineSpacing in class TextState

Returns:

setLineSpacing

public void setLineSpacing(float value)

Overrides:

setLineSpacing in class TextState

getForegroundColor

public Color getForegroundColor()

Gets foreground color of the text, represented by the TextFragment object

Overrides:

getForegroundColor in class TextState

setForegroundColor

public void setForegroundColor(Color value)

Sets foreground color of the text, represented by the TextFragment object

Overrides:

setForegroundColor in class TextState

setBackgroundColor

public void setBackgroundColor(Color value)

Sets background color of the text, represented by the TextFragment object

Overrides:

setBackgroundColor in class TextState

setUnderline

public void setUnderline(boolean value)

Sets underline for the text, represented by the TextFragment object

Overrides:

setUnderline in class TextState

setFontStyle

public void setFontStyle(int value)

Sets font style of the text, represented by the TextFragment object

Overrides:

setFontStyle in class TextState

getFont

public Font getFont()

Gets font of the text, represented by the TextFragment object

Overrides:

getFont in class TextState

setFont

public void setFont(Font value)

Sets font of the text, represented by the TextFragment object

Overrides:

setFont in class TextState

getFontSize

public float getFontSize()

Gets font size of the text, represented by the TextFragment object

Overrides:

getFontSize in class TextState

setFontSize

public void setFontSize(float value)

Sets font size of the text, represented by the TextFragment object

Overrides:

setFontSize in class TextState

getHorizontalAlignment

public int getHorizontalAlignment()

Gets or sets horizontal alignment for the text.

HorizontalAlignment.None is equal to HorizontalAlignment.Left. Note that TextFragmentState.VerticalAlignment property works in new document deneration generation scenarios only.

Overrides:

getHorizontalAlignment in class TextState

setHorizontalAlignment

public void setHorizontalAlignment(int value)

Overrides:

setHorizontalAlignment in class TextState

applyChangesFrom

public void applyChangesFrom(TextState textState)

Applies settings from another textState

Overrides:

applyChangesFrom in class TextState

Parameters:

textState -

applyChangesFrom

public void applyChangesFrom(TextState textState,
                    boolean groupChangesOnly)

Applies settings from another textState

Parameters:

textState -

groupChangesOnly - if true inherit group changes only (without isolating the segments into single segment)