Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.graphics.state.PDTextState

Modifier and Type	Field and Description
private float	characterSpacing
private PDFont	font
private float	fontSize
private float	horizontalScaling
private boolean	knockout
private float	leading
private RenderingMode	renderingMode
private float	rise
private float	wordSpacing

Access	Constructor and Description
public	PDTextState()

Method Summary

Modifier and Type	Method and Description
public PDTextState	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public float	Returns: The current characterSpacing. getCharacterSpacing() Get the value of the characterSpacing.
public PDFont	Returns: The font. getFont() Get the value of the font.
public float	Returns: The fontSize. getFontSize() Get the value of the fontSize.
public float	Returns: The horizontalScaling. getHorizontalScaling() Get the value of the horizontalScaling.
public boolean	Returns: The knockout. getKnockoutFlag() Get the value of the knockout.
public float	Returns: The leading. getLeading() Get the value of the leading.
public RenderingMode	Returns: The renderingMode. getRenderingMode() Get the value of the renderingMode.
public float	Returns: The rise. getRise() Get the value of the rise.
public float	Returns: The wordSpacing. getWordSpacing() Get the value of the wordSpacing.
public void	setCharacterSpacing(float The characterSpacing. value) Set the value of the characterSpacing.
public void	setFont(PDFont The font. value) Set the value of the font.
public void	setFontSize(float The fontSize. value) Set the value of the fontSize.
public void	setHorizontalScaling(float The horizontalScaling. value) Set the value of the horizontalScaling.
public void	setKnockoutFlag(boolean The knockout. value) Set the value of the knockout.
public void	setLeading(float The leading. value) Set the value of the leading.
public void	setRenderingMode(RenderingMode The renderingMode. renderingMode) Set the value of the renderingMode.
public void	setRise(float The rise. value) Set the value of the rise.
public void	setWordSpacing(float The wordSpacing. value) Set the value of the wordSpacing.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

characterSpacing	back to summary
private float characterSpacing

font	back to summary
private PDFont font

fontSize	back to summary
private float fontSize

horizontalScaling	back to summary
private float horizontalScaling

knockout	back to summary
private boolean knockout

leading	back to summary
private float leading

renderingMode	back to summary
private RenderingMode renderingMode

rise	back to summary
private float rise

wordSpacing	back to summary
private float wordSpacing

PDTextState	back to summary
public PDTextState()

Method Detail

clone back to summary

clone	back to summary
public PDTextState clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:PDTextState a clone of this instance. Annotations @Override

public PDTextState clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:PDTextState

a clone of this instance.

Annotations

@Override

getCharacterSpacing	back to summary
public float getCharacterSpacing() Get the value of the characterSpacing. Returns:float The current characterSpacing.

getCharacterSpacing

public Class PDTextState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail