com.itextpdf.typography.config

Class StandardScriptConfig

java.lang.Object

com.itextpdf.typography.config.StandardScriptConfig

All Implemented Interfaces:

IFeaturesConfig

Direct Known Subclasses:

LatinScriptConfig

public class StandardScriptConfig
extends Object
implements IFeaturesConfig

An IFeaturesConfig implementation for convenient configuration of any standard script.

Standard Script - any non-complex script; any script that does not require re-ordering or contextual analysis in the shaping process. According to Open Font File specification such scripts are Character.UnicodeScript#ARMENIAN, Character.UnicodeScript#CYRILLIC, Character.UnicodeScript#GEORGIAN, Character.UnicodeScript#GREEK, Character.UnicodeScript#LATIN, Character.UnicodeScript#RUNIC, Character.UnicodeScript#OGHAM.

See also STANDARD_SCRIPTS set.

See Also:

Developing OpenType Fonts for Standard Scripts at docs.microsoft.com

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Character.UnicodeScript>	STANDARD_SCRIPTS

Constructor Summary

Constructors

Constructor and Description
StandardScriptConfig(Set<Character.UnicodeScript> scripts)

Method Summary

Modifier and Type	Method and Description
StandardScriptConfig	appendCustomFeature(String feature) Adds a custom feature to the end of the list of features that are to be applied.
Set<Character.UnicodeScript>	getScripts() Gets scripts that are affected by this instance of IFeaturesConfig.
List<String>	listFeatures() Enlists OpenType features that are applied in given order to the scripts defined by IFeaturesConfig.getScripts().
StandardScriptConfig	prependCustomFeature(String feature) Adds a custom feature to the beginning of the list of features that are to be applied.
StandardScriptConfig	removeCustomFeature(String feature) Removes custom feature added to the features list via appendCustomFeature(String) or prependCustomFeature(String).
StandardScriptConfig	setCharacterCompositionDecompositionSubstitution(boolean enabled) Enables or disables characters composition/decomposition substitution.
StandardScriptConfig	setDistancesAdjustment(boolean enabled) Enables or disables distance adjustment.
StandardScriptConfig	setKerningFeature(boolean enabled) Enables or disables pair kerning.
StandardScriptConfig	setLigaturesApplying(boolean enabled) Enables or disables standard ligatures substitution.
StandardScriptConfig	setMarkToBasePositioning(boolean enabled) Enables or disables mark to base positioning.
StandardScriptConfig	setMarkToMarkPositioning(boolean enabled) Enables or disables mark to mark positioning.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_SCRIPTS

public static final Set<Character.UnicodeScript> STANDARD_SCRIPTS

Constructor Detail

StandardScriptConfig

public StandardScriptConfig(Set<Character.UnicodeScript> scripts)

Method Detail

getScripts

public Set<Character.UnicodeScript> getScripts()

Description copied from interface: IFeaturesConfig

Gets scripts that are affected by this instance of IFeaturesConfig.

Specified by:

getScripts in interface IFeaturesConfig

Returns:

an unmodifiable Set of scripts which processing is defined by this IFeaturesConfig.

setLigaturesApplying

public StandardScriptConfig setLigaturesApplying(boolean enabled)

Enables or disables standard ligatures substitution.

If enabled the "liga" feature tag will be present in the list of features to be applied (see IFeaturesConfig.listFeatures()). It will appear after custom features added by prependCustomFeature(String) (if any) and before custom features added by appendCustomFeature(String) (if any). The order of not custom features is fixed and defined by the Open Font File specification.

By default it's disabled.

Parameters:

enabled - true in order to enable the feature, otherwise false.

Returns:

this StandardScriptConfig instance.

setCharacterCompositionDecompositionSubstitution

public StandardScriptConfig setCharacterCompositionDecompositionSubstitution(boolean enabled)

Enables or disables characters composition/decomposition substitution.

If enabled the "ccmp" feature tag will be present in the list of features to be applied (see IFeaturesConfig.listFeatures()). It will appear after custom features added by prependCustomFeature(String) (if any) and before custom features added by appendCustomFeature(String) (if any). The order of not custom features is fixed and defined by the Open Font File specification.

By default it's disabled.

Parameters:

enabled - true in order to enable the feature, otherwise false.

Returns:

this StandardScriptConfig instance.

setKerningFeature

public StandardScriptConfig setKerningFeature(boolean enabled)

Enables or disables pair kerning.

If enabled the "kern" feature tag will be present in the list of features to be applied (see IFeaturesConfig.listFeatures()). It will appear after custom features added by prependCustomFeature(String) (if any) and before custom features added by appendCustomFeature(String) (if any). The order of not custom features is fixed and defined by the Open Font File specification.

By default it's disabled.

Parameters:

enabled - true in order to enable the feature, false - to disable.

Returns:

this StandardScriptConfig instance.

setDistancesAdjustment

public StandardScriptConfig setDistancesAdjustment(boolean enabled)

Enables or disables distance adjustment.

If enabled the "dist" feature tag will be present in the list of features to be applied (see IFeaturesConfig.listFeatures()). It will appear after custom features added by prependCustomFeature(String) (if any) and before custom features added by appendCustomFeature(String) (if any). The order of not custom features is fixed and defined by the Open Font File specification.

By default it's disabled.

Parameters:

enabled - true in order to enable the feature, false - to disable.

Returns:

this StandardScriptConfig instance.

setMarkToBasePositioning

public StandardScriptConfig setMarkToBasePositioning(boolean enabled)

Enables or disables mark to base positioning. It's usually used for combining diacritics with the base glyphs.

If enabled the "liga" feature tag will be present in the list of features to be applied (see IFeaturesConfig.listFeatures()). It will appear after custom features added by prependCustomFeature(String) (if any) and before custom features added by appendCustomFeature(String) (if any). The order of not custom features is fixed and defined by the Open Font File specification.

By default it's enabled.

Parameters:

enabled - true in order to enable the feature, false - to disable.

Returns:

this StandardScriptConfig instance.

setMarkToMarkPositioning

public StandardScriptConfig setMarkToMarkPositioning(boolean enabled)

Enables or disables mark to mark positioning. It's usually used for combining diacritics with other diacritics.

If enabled the "liga" feature tag will be present in the list of features to be applied (see IFeaturesConfig.listFeatures()). It will appear after custom features added by prependCustomFeature(String) (if any) and before custom features added by appendCustomFeature(String) (if any). The order of not custom features is fixed and defined by the Open Font File specification.

By default it's enabled.

Parameters:

enabled - true in order to enable the feature, false - to disable.

Returns:

this StandardScriptConfig instance.

appendCustomFeature

public StandardScriptConfig appendCustomFeature(String feature)

Adds a custom feature to the end of the list of features that are to be applied.

See also IFeaturesConfig.listFeatures()

Parameters:

feature - the feature tag denoting feature in the font.

Returns:

this StandardScriptConfig instance.

prependCustomFeature

public StandardScriptConfig prependCustomFeature(String feature)

Adds a custom feature to the beginning of the list of features that are to be applied.

See also IFeaturesConfig.listFeatures()

Parameters:

feature - the feature tag denoting feature in the font.

Returns:

this StandardScriptConfig instance.

removeCustomFeature

public StandardScriptConfig removeCustomFeature(String feature)

Removes custom feature added to the features list via appendCustomFeature(String) or prependCustomFeature(String).

See also IFeaturesConfig.listFeatures()

Parameters:

feature - the feature tag denoting feature in the font.

Returns:

this StandardScriptConfig instance.

listFeatures

public List<String> listFeatures()

Description copied from interface: IFeaturesConfig

Enlists OpenType features that are applied in given order to the scripts defined by IFeaturesConfig.getScripts().

Specified by:

listFeatures in interface IFeaturesConfig

Returns:

an unmodifiable List of OpenType features tags to be applied.