[intro]     [up]

Class FieldBuilder


The FieldBuilder helps creating individual fields to use in the InputMask.
There is a default instance called fieldBuilder. There is no need to create other instances of this class.

Example
new InputMask([fieldBuilder.inputNumbers(2), fieldBuilder.literal("-"), fieldBuilder.inputLetters(4)], "input");



Methods
capitalize Creates a field that capitalizes the characters
capitalizeAll Creates a field that accepts any characters and capitalizes them
capitalizeLetters Creates a field that accepts only letters, capitalizing them
input Creates a generic field
inputAll Creates a field that accepts any characters
inputLetters Creates a field that accepts only letters
inputNumbers Creates a field that accepts only numbers
literal Creates a literal field
lower Creates a field that transforms the characters to lowercase
lowerAll Creates a field that accepts any characters and transforms them to lowercase
lowerLetters Creates a field that accepts only lowercase letters
upper Creates a field that transforms the characters to uppercase
upperAll Creates a field that accepts any characters and transforms them to uppercase
upperLetters Creates a field that accepts only uppercase letters



Methods
 
capitalize
Creates a field that capitalizes the characters
Arguments
Name Type Default Description
accepted String   The String containing the accepted characters
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
capitalizeAll
Creates a field that accepts any characters and capitalizes them
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
capitalizeLetters
Creates a field that accepts only letters, capitalizing them
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
input
Creates a generic field
Arguments
Name Type Default Description
accepted String   The String containing the accepted characters
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
inputAll
Creates a field that accepts any characters
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
inputLetters
Creates a field that accepts only letters
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
inputNumbers
Creates a field that accepts only numbers
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
literal
Creates a literal field
Arguments
Name Type Default Description
text String   The literal text
 
lower
Creates a field that transforms the characters to lowercase
Arguments
Name Type Default Description
accepted String   The String containing the accepted characters
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
lowerAll
Creates a field that accepts any characters and transforms them to lowercase
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
lowerLetters
Creates a field that accepts only lowercase letters
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
upper
Creates a field that transforms the characters to uppercase
Arguments
Name Type Default Description
accepted String   The String containing the accepted characters
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
upperAll
Creates a field that accepts any characters and transforms them to uppercase
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional
 
upperLetters
Creates a field that accepts only uppercase letters
Arguments
Name Type Default Description
min Numeric 0 The minimum number of characters
max Numeric min if it's set, otherwise, -1 The maximum number of characters. -1 means no limit
padFunction Function A function that calls lpad() A function used to complete the field size
optional Boolean false Indicates if the field is optional