TextHelper (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.internal.fxg.dom.richtext.TextHelper

```
public class TextHelper
extends Object
```
Utilities to help create Text.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static double`	`ALPHA_MAX_INCLUSIVE`
`protected static double`	`ALPHA_MIN_INCLUSIVE`
`protected static Pattern`	`tabstopsDNumericPattern`
`protected static Pattern`	`tabstopsDScientificPattern`
`protected static Pattern`	`tabstopsExceptDNumericPattern`
`protected static Pattern`	`tabstopsExceptDScientificPattern`
`protected static Pattern`	`tabstopsNumberPattern`
`protected static Pattern`	`whitespacePattern`

Constructor Summary

Constructors
Constructor and Description

TextHelper()

Constructors
Constructor and Description
`TextHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`static AlignmentBaseline`	`getAlignmentBaseline(IFXGNode node, String value, AlignmentBaseline defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a AlignmentBaseline enumeration.
`static BlockProgression`	`getBlockProgression(IFXGNode node, String value, BlockProgression defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a BlockProgression enumeration.
`static BreakOpportunity`	`getBreakOpportunity(IFXGNode node, String value, BreakOpportunity defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a BreakOpportunity enumeration.
`static DigitCase`	`getDigitCase(IFXGNode node, String value, DigitCase defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a DigitCase enumeration.
`static DigitWidth`	`getDigitWidth(IFXGNode node, String value, DigitWidth defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a DigitWidth enumeration.
`static Direction`	`getDirection(IFXGNode node, String value, Direction defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a Direction enumeration.
`static DominantBaseline`	`getDominantBaseline(IFXGNode node, String value, DominantBaseline defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a DominantBaseline enumeration.
`static FontStyle`	`getFontStyle(IFXGNode node, String value, FontStyle defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a FontStyle enumeration.
`static FontWeight`	`getFontWeight(IFXGNode node, String value, FontWeight defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a FontWeight enumeration.
`static JustificationRule`	`getJustificationRule(IFXGNode node, String value, JustificationRule defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a JustificationRule enumeration.
`static JustificationStyle`	`getJustificationStyle(IFXGNode node, String value, JustificationStyle defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a JustificationStyle enumeration.
`static Kerning`	`getKerning(IFXGNode node, String value, Kerning defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a Kerning enumeration.
`static LeadingModel`	`getLeadingModel(IFXGNode node, String value, LeadingModel defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a LeadingModel enumeration.
`static LigatureLevel`	`getLigatureLevel(IFXGNode node, String value, LigatureLevel defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a LigatureLevel enumeration.
`static LineBreak`	`getLineBreak(IFXGNode node, String value, LineBreak defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a LineBreak enumeration.
`static TextAlign`	`getTextAlign(IFXGNode node, String value, TextAlign defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a TextAlign enumeration.
`static TextDecoration`	`getTextDecoration(IFXGNode node, String value, TextDecoration defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a TextDecoration enumeration.
`static TextJustify`	`getTextJustify(IFXGNode node, String value, TextJustify defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a TextJustify enumeration.
`static TextRotation`	`getTextRotation(IFXGNode node, String value, TextRotation defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a TextRotation enumeration.
`static TypographicCase`	`getTypographicCase(IFXGNode node, String value, TypographicCase defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a TypographicCase enumeration.
`static VerticalAlign`	`getVerticalAlign(IFXGNode node, String value, VerticalAlign defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a VerticalAlign enumeration.
`static WhiteSpaceCollapse`	`getWhiteSpaceCollapse(IFXGNode node, String value, WhiteSpaceCollapse defaultValue, Collection<ICompilerProblem> problems)` Convert an FXG String value to a WhiteSpaceCollapse enumeration.
`static boolean`	`ignorableWhitespace(String value)` Determine if a string contains only ignorable white spaces.
`static String`	`parseTabStops(IFXGNode node, String value, String defaultValue, Collection<ICompilerProblem> problems)`

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

Field Detail

ALPHA_MIN_INCLUSIVE

protected static final double ALPHA_MIN_INCLUSIVE

See Also:: Constant Field Values

ALPHA_MAX_INCLUSIVE

protected static final double ALPHA_MAX_INCLUSIVE

See Also:: Constant Field Values

whitespacePattern

protected static Pattern whitespacePattern

tabstopsExceptDNumericPattern

protected static Pattern tabstopsExceptDNumericPattern

tabstopsExceptDScientificPattern

protected static Pattern tabstopsExceptDScientificPattern

tabstopsDNumericPattern

protected static Pattern tabstopsDNumericPattern

tabstopsDScientificPattern

protected static Pattern tabstopsDScientificPattern

tabstopsNumberPattern

protected static Pattern tabstopsNumberPattern

Constructor Detail
- TextHelper
```
public TextHelper()
```

Method Detail

ignorableWhitespace
```
public static boolean ignorableWhitespace(String value)
```
Determine if a string contains only ignorable white spaces.

Parameters:
value - - value to be checked.

Returns:
true if value contains only ignorable white spaces, else, return false.

getFontStyle
```
public static FontStyle getFontStyle(IFXGNode node,
                     String value,
                     FontStyle defaultValue,
                     Collection<ICompilerProblem> problems)
```
Convert an FXG String value to a FontStyle enumeration.

Parameters:
value - - the FXG String value.
defaultValue - default value to use in case of any problem
problems - problem collection used to collect problems occurred within this method

Returns:
the matching FontStyle value.

getFontWeight

public static FontWeight getFontWeight(IFXGNode node,
                       String value,
                       FontWeight defaultValue,
                       Collection<ICompilerProblem> problems)

Convert an FXG String value to a FontWeight enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching FontWeight value.

getTextDecoration

public static TextDecoration getTextDecoration(IFXGNode node,
                               String value,
                               TextDecoration defaultValue,
                               Collection<ICompilerProblem> problems)

Convert an FXG String value to a TextDecoration enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching TextDecoration value.

getKerning
```
public static Kerning getKerning(IFXGNode node,
                 String value,
                 Kerning defaultValue,
                 Collection<ICompilerProblem> problems)
```
Convert an FXG String value to a Kerning enumeration.

Parameters:
value - - the FXG String value.
defaultValue - default value to use in case of any problem
problems - problem collection used to collect problems occurred within this method

Returns:
the matching Kerning value.

getWhiteSpaceCollapse

public static WhiteSpaceCollapse getWhiteSpaceCollapse(IFXGNode node,
                                       String value,
                                       WhiteSpaceCollapse defaultValue,
                                       Collection<ICompilerProblem> problems)

Convert an FXG String value to a WhiteSpaceCollapse enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching WhiteSpaceCollapse rule.

getBreakOpportunity

public static BreakOpportunity getBreakOpportunity(IFXGNode node,
                                   String value,
                                   BreakOpportunity defaultValue,
                                   Collection<ICompilerProblem> problems)

Convert an FXG String value to a BreakOpportunity enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching BreakOpportunity rule.

getDigitCase
```
public static DigitCase getDigitCase(IFXGNode node,
                     String value,
                     DigitCase defaultValue,
                     Collection<ICompilerProblem> problems)
```
Convert an FXG String value to a DigitCase enumeration.

Parameters:
value - - the FXG String value.
defaultValue - default value to use in case of any problem
problems - problem collection used to collect problems occurred within this method

Returns:
the matching DigitCase rule.

getDigitWidth

public static DigitWidth getDigitWidth(IFXGNode node,
                       String value,
                       DigitWidth defaultValue,
                       Collection<ICompilerProblem> problems)

Convert an FXG String value to a DigitWidth enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching DigitWidth rule.

getDominantBaseline

public static DominantBaseline getDominantBaseline(IFXGNode node,
                                   String value,
                                   DominantBaseline defaultValue,
                                   Collection<ICompilerProblem> problems)

Convert an FXG String value to a DominantBaseline enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching DominantBaseline rule.

getAlignmentBaseline

public static AlignmentBaseline getAlignmentBaseline(IFXGNode node,
                                     String value,
                                     AlignmentBaseline defaultValue,
                                     Collection<ICompilerProblem> problems)

Convert an FXG String value to a AlignmentBaseline enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching AlignmentBaseline rule.

getLigatureLevel

public static LigatureLevel getLigatureLevel(IFXGNode node,
                             String value,
                             LigatureLevel defaultValue,
                             Collection<ICompilerProblem> problems)

Convert an FXG String value to a LigatureLevel enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching LigatureLevel rule.

getTypographicCase

public static TypographicCase getTypographicCase(IFXGNode node,
                                 String value,
                                 TypographicCase defaultValue,
                                 Collection<ICompilerProblem> problems)

Convert an FXG String value to a TypographicCase enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching TypographicCase rule.

getTextRotation

public static TextRotation getTextRotation(IFXGNode node,
                           String value,
                           TextRotation defaultValue,
                           Collection<ICompilerProblem> problems)

Convert an FXG String value to a TextRotation enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching TextRotation rule.

getTextAlign
```
public static TextAlign getTextAlign(IFXGNode node,
                     String value,
                     TextAlign defaultValue,
                     Collection<ICompilerProblem> problems)
```
Convert an FXG String value to a TextAlign enumeration.

Parameters:
value - - the FXG String value.
defaultValue - default value to use in case of any problem
problems - problem collection used to collect problems occurred within this method

Returns:
the matching TextAlign rule.

getDirection
```
public static Direction getDirection(IFXGNode node,
                     String value,
                     Direction defaultValue,
                     Collection<ICompilerProblem> problems)
```
Convert an FXG String value to a Direction enumeration.

Parameters:
value - - the FXG String value.
defaultValue - default value to use in case of any problem
problems - problem collection used to collect problems occurred within this method

Returns:
the matching Direction rule.

getJustificationRule

public static JustificationRule getJustificationRule(IFXGNode node,
                                     String value,
                                     JustificationRule defaultValue,
                                     Collection<ICompilerProblem> problems)

Convert an FXG String value to a JustificationRule enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching JustificationRule rule.

getJustificationStyle

public static JustificationStyle getJustificationStyle(IFXGNode node,
                                       String value,
                                       JustificationStyle defaultValue,
                                       Collection<ICompilerProblem> problems)

Convert an FXG String value to a JustificationStyle enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching JustificationStyle rule.

getTextJustify

public static TextJustify getTextJustify(IFXGNode node,
                         String value,
                         TextJustify defaultValue,
                         Collection<ICompilerProblem> problems)

Convert an FXG String value to a TextJustify enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching TextJustify rule.

getLeadingModel

public static LeadingModel getLeadingModel(IFXGNode node,
                           String value,
                           LeadingModel defaultValue,
                           Collection<ICompilerProblem> problems)

Convert an FXG String value to a LeadingModel enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching LeadingModel rule.

getBlockProgression

public static BlockProgression getBlockProgression(IFXGNode node,
                                   String value,
                                   BlockProgression defaultValue,
                                   Collection<ICompilerProblem> problems)

Convert an FXG String value to a BlockProgression enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching BlockProgression enum.

getLineBreak
```
public static LineBreak getLineBreak(IFXGNode node,
                     String value,
                     LineBreak defaultValue,
                     Collection<ICompilerProblem> problems)
```
Convert an FXG String value to a LineBreak enumeration.

Parameters:
value - - the FXG String value.
defaultValue - default value to use in case of any problem
problems - problem collection used to collect problems occurred within this method

Returns:
the matching LineBreak enum.

getVerticalAlign

public static VerticalAlign getVerticalAlign(IFXGNode node,
                             String value,
                             VerticalAlign defaultValue,
                             Collection<ICompilerProblem> problems)

Convert an FXG String value to a VerticalAlign enumeration.

Parameters:: value - - the FXG String value.; defaultValue - default value to use in case of any problem; problems - problem collection used to collect problems occurred within this method
Returns:: the matching VerticalAlign rule.

parseTabStops

public static String parseTabStops(IFXGNode node,
                   String value,
                   String defaultValue,
                   Collection<ICompilerProblem> problems)

Class TextHelper