TextCalculator (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.TextCalculator

```
public class TextCalculator
extends Object
```
TextCalculator is a collection of static methods that operate as the Microsoft Excel function calls do. All methods are called with an array of ptg's, which are then acted upon. A Ptg of the type that makes sense (ie boolean, number) is returned after each method.

Constructor Summary

Constructors
Constructor and Description

TextCalculator()

Constructors
Constructor and Description
`TextCalculator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Ptg`	`calcAsc(Ptg[] operands)` ASC function For Double-byte character set (DBCS) languages, changes full-width (double-byte) characters to half-width (single-byte) characters.
`protected static Ptg`	`calcChar(Ptg[] operands)` CHAR Returns the character specified by the code number
`protected static Ptg`	`calcClean(Ptg[] operands)` CLEAN Removes all nonprintable characters from text.
`protected static Ptg`	`calcCode(Ptg[] operands)` CODE Returns a numeric code for the first character in a text string
`protected static Ptg`	`calcConcatenate(Ptg[] operands)` CONCATENATE Joins several text items into one text item
`protected static Ptg`	`calcDollar(Ptg[] operands)` DOLLAR Converts a number to text, using currency format.
`protected static Ptg`	`calcExact(Ptg[] operands)` EXACT Checks to see if two text values are identical
`protected static Ptg`	`calcFind(Ptg[] operands)` FIND Finds one text value within another (case-sensitive)
`protected static Ptg`	`calcFindB(Ptg[] operands)` FINDB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language.
`protected static Ptg`	`calcFixed(Ptg[] operands)` FIXED Formats a number as text with a fixed number of decimals
`protected static Ptg`	`calcJIS(Ptg[] operands)` JIS function The function described in this Help topic converts half-width (single-byte) letters within a character string to full-width (double-byte) characters.
`protected static Ptg`	`calcLeft(Ptg[] operands)` LEFT Returns the leftmost characters from a text value
`protected static Ptg`	`calcLeftB(Ptg[] operands)` LEFTB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language.
`protected static Ptg`	`calcLen(Ptg[] operands)` LEN Returns the number of characters in a text string
`protected static Ptg`	`calcLenB(Ptg[] operands)` LENB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language.
`protected static Ptg`	`calcLower(Ptg[] operands)` LOWER Converts text to lowercase
`protected static Ptg`	`calcMid(Ptg[] operands)` MID Returns a specific number of characters from a text string starting at the position you specify
`protected static Ptg`	`calcProper(Ptg[] operands)` PROPER Capitalizes the first letter in each word of a text value
`protected static Ptg`	`calcReplace(Ptg[] operands)` REPLACE Replaces characters within text
`protected static Ptg`	`calcRept(Ptg[] operands)` REPT Repeats text a given number of times
`protected static Ptg`	`calcRight(Ptg[] operands)` RIGHT Returns the rightmost characters from a text value
`protected static Ptg`	`calcSearch(Ptg[] operands)` SEARCH Finds one text value within another (not case-sensitive)
`protected static Ptg`	`calcSearchB(Ptg[] operands)` SEARCHB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language.
`protected static Ptg`	`calcSubstitute(Ptg[] operands)` SUBSTITUTE Substitutes new text for old text in a text string
`protected static Ptg`	`calcT(Ptg[] operands)` T According to documentation converts its arguments to text - not really though, it just returns value if they are text
`protected static Ptg`	`calcText(Ptg[] operands)` TEXT Formats a number and converts it to text Converts a value to text in a specific number format.
`protected static Ptg`	`calcTrim(Ptg[] operands)` TRIM According to documentation Trim() removes leading and trailing spaces from the cell value.
`protected static Ptg`	`calcUpper(Ptg[] operands)` UPPER Converts text to uppercase
`protected static Ptg`	`calcValue(Ptg[] operands)` VALUE Converts a text argument to a number

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

- Constructor Detail
  - TextCalculator
```
public TextCalculator()
```
- Method Detail
  - calcAsc
```
protected static Ptg calcAsc(Ptg[] operands)
```
    ASC function For Double-byte character set (DBCS) languages, changes full-width (double-byte) characters to half-width (single-byte) characters. ASC(text) Text is the text or a reference to a cell that contains the text you want to change. If text does not contain any full-width letters, text is not changed. NOTE: in order to use this and other DBCS Methods in Excel, the input language must be set to a DBCS language such as Japanese Otherwise, the ASC function does nothing (apparently)
  - calcChar
```
protected static Ptg calcChar(Ptg[] operands)
```
    CHAR Returns the character specified by the code number
  - calcClean
```
protected static Ptg calcClean(Ptg[] operands)
```
    CLEAN Removes all nonprintable characters from text. Use CLEAN on text imported from other applications that contains characters that may not print with your operating system. For example, you can use CLEAN to remove some low-level computer code that is frequently at the beginning and end of data files and cannot be printed. Syntax CLEAN(text) Text is any worksheet information from which you want to remove nonprintable characters. The CLEAN function was designed to remove the first 32 nonprinting characters in the 7-bit ASCII code (values 0 through 31) from text. In the Unicode character set (Unicode: A character encoding standard developed by the Unicode Consortium. By using more than one byte to represent each character, Unicode enables almost all of the written languages in the world to be represented by using a single character set.), there are additional nonprinting characters (values 127, 129, 141, 143, 144, and 157). By itself, the CLEAN function does not remove these additional nonprinting characters.
  - calcCode
```
protected static Ptg calcCode(Ptg[] operands)
```
    CODE Returns a numeric code for the first character in a text string
  - calcConcatenate
```
protected static Ptg calcConcatenate(Ptg[] operands)
```
    CONCATENATE Joins several text items into one text item
  - calcDollar
```
protected static Ptg calcDollar(Ptg[] operands)
```
    DOLLAR Converts a number to text, using currency format. Can have a separate operand to determine POP.
  - calcExact
```
protected static Ptg calcExact(Ptg[] operands)
```
    EXACT Checks to see if two text values are identical
  - calcFind
```
protected static Ptg calcFind(Ptg[] operands)
```
    FIND Finds one text value within another (case-sensitive)
  - calcFindB
```
protected static Ptg calcFindB(Ptg[] operands)
```
    FINDB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language. Otherwise, FINDB counts each character as 1. NOTES: search is case sensitive and doesn't allow for wildcards
  - calcFixed
```
protected static Ptg calcFixed(Ptg[] operands)
```
    FIXED Formats a number as text with a fixed number of decimals
  - calcJIS
```
protected static Ptg calcJIS(Ptg[] operands)
```
    JIS function The function described in this Help topic converts half-width (single-byte) letters within a character string to full-width (double-byte) characters. The name of the function (and the characters that it converts) depends upon your language settings. For Japanese, this function changes half-width (single-byte) English letters or katakana within a character string to full-width (double-byte) characters. JIS(text) Text is the text or a reference to a cell that contains the text you want to change. If text does not contain any half-width English letters or katakana, text is not changed. TODO: STRING ENCODING IS NOT CORRECT **************
  - calcLeft
```
protected static Ptg calcLeft(Ptg[] operands)
```
    LEFT Returns the leftmost characters from a text value
  - calcLeftB
```
protected static Ptg calcLeftB(Ptg[] operands)
```
    LEFTB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language. Otherwise, LEFTB counts each character as 1.
  - calcLen
```
protected static Ptg calcLen(Ptg[] operands)
```
    LEN Returns the number of characters in a text string
  - calcLenB
```
protected static Ptg calcLenB(Ptg[] operands)
```
    LENB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language. Otherwise, LENB counts each character as 1.
  - calcLower
```
protected static Ptg calcLower(Ptg[] operands)
```
    LOWER Converts text to lowercase
  - calcMid
```
protected static Ptg calcMid(Ptg[] operands)
```
    MID Returns a specific number of characters from a text string starting at the position you specify
  - calcProper
```
protected static Ptg calcProper(Ptg[] operands)
```
    PROPER Capitalizes the first letter in each word of a text value
  - calcReplace
```
protected static Ptg calcReplace(Ptg[] operands)
```
    REPLACE Replaces characters within text
  - calcRept
```
protected static Ptg calcRept(Ptg[] operands)
```
    REPT Repeats text a given number of times
  - calcRight
```
protected static Ptg calcRight(Ptg[] operands)
```
    RIGHT Returns the rightmost characters from a text value
  - calcSearch
```
protected static Ptg calcSearch(Ptg[] operands)
```
    SEARCH Finds one text value within another (not case-sensitive)
  - calcSearchB
```
protected static Ptg calcSearchB(Ptg[] operands)
```
    SEARCHB counts each double-byte character as 2 when you have enabled the editing of a language that supports DBCS and then set it as the default language. Otherwise, SEARCHB counts each character as 1. TODO: THIS IS NOT COMPLETE
  - calcSubstitute
```
protected static Ptg calcSubstitute(Ptg[] operands)
```
    SUBSTITUTE Substitutes new text for old text in a text string
  - calcT
```
protected static Ptg calcT(Ptg[] operands)
```
    T According to documentation converts its arguments to text - not really though, it just returns value if they are text
  - calcText
```
protected static Ptg calcText(Ptg[] operands)
```
    TEXT Formats a number and converts it to text Converts a value to text in a specific number format. Syntax TEXT(value,format_text) Value is a numeric value, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value. Format_text is a number format in text form from in the Category box on the Number tab in the Format Cells dialog box. Remarks Format_text cannot contain an asterisk (*). Formatting a cell with an option on the Number tab (Cells command, Format menu) changes only the format, not the value. Using the TEXT function converts a value to formatted text, and the result is no longer calculated as a number. Salesperson Sales Buchanan 2800 Dodsworth 40% Formula Description (Result) =A2&" sold "&TEXT(B2, "$0.00")&" worth of units." Combines contents above into a phrase (Buchanan sold $2800.00 worth of units.) =A3&" sold "&TEXT(B3,"0%")&" of the total sales." Combines contents above into a phrase (Dodsworth sold 40% of the total sales.)
  - calcTrim
```
protected static Ptg calcTrim(Ptg[] operands)
```
    TRIM According to documentation Trim() removes leading and trailing spaces from the cell value. Actually it removes all spaces except for single spaces between words.
  - calcUpper
```
protected static Ptg calcUpper(Ptg[] operands)
```
    UPPER Converts text to uppercase
  - calcValue
```
protected static Ptg calcValue(Ptg[] operands)
```
    VALUE Converts a text argument to a number

Class TextCalculator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextCalculator

Method Detail

calcAsc

calcChar

calcClean

calcCode

calcConcatenate

calcDollar

calcExact

calcFind

calcFindB

calcFixed

calcJIS

calcLeft

calcLeftB

calcLen

calcLenB

calcLower

calcMid

calcProper

calcReplace

calcRept

calcRight

calcSearch

calcSearchB

calcSubstitute

calcT

calcText

calcTrim

calcUpper

calcValue