SecureInputBuilderV2 (Ezio Mobile SDK API Documentation (5.0.0))

```
public interface SecureInputBuilderV2
```
An interface that represents secure input V2.

Since:

4.4

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SecureInputBuilderV2.ButtonTouchVisual` The visual response for keypad button touch.
`static class`	`SecureInputBuilderV2.LabelAlignment` Secure input UI label alignment.
`static class`	`SecureInputBuilderV2.LogoPosition` Secure input UI logo position.
`static class`	`SecureInputBuilderV2.OkButtonBehavior` Secure input UI OK button behavior.
`static class`	`SecureInputBuilderV2.UiControlFocusState` Secure input UI control focus state.
`static class`	`SecureInputBuilderV2.UiControlState` Secure input UI control state.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`SecureInputUi`	`buildPinpad(boolean isScrambled, boolean isDoubleInputField, boolean isDialog, SecurePinpadListenerV2 listener)` Create a new secure keypad.
`void`	`setButtonBackgroundColor(SecureInputBuilderV2.UiControlState state, int color)` Set the background color for all the buttons.
`void`	`setButtonBackgroundImage(android.graphics.Bitmap image)` Set background image for all the buttons.
`void`	`setButtonBackgroundImage(int resourceId)` Set Button background image resource id for all the buttons.
`void`	`setButtonBackgroundImageOpacity(SecureInputBuilderV2.UiControlState state, float opacity)` Set the background image opacity for normal and disabled state for all the buttons.
`void`	`setButtonBorderColor(int color)` Deprecated. Will be removed future major release. The API is split into two APIs; `setKeypadFrameColor(int)` and `setKeypadGridGradientColors(int, int)`
`void`	`setButtonBorderWidth(int width)` Set the button border width for all the buttons (must be greater than 0 and less than or equal to 8)
`void`	`setButtonGradientColor(SecureInputBuilderV2.UiControlState state, int buttonGradientColorStart, int buttonGradientColorEnd)` Set the start and end color of the button gradient for corresponding control state.
`void`	`setButtonHighlightColorOpacity(float opacity)` Set the highlight color opacity of all the buttons.
`void`	`setButtonPressVisibility(boolean isVisible)` Set whether the buttons should be highlighted when pressed.
`void`	`setButtonTouchVisualEffect(SecureInputBuilderV2.ButtonTouchVisual buttonTouchVisual)` Set the visual effect for keypad button touch like highlight or ripple.
`void`	`setDeleteButtonFont(android.graphics.Typeface font)` Set the font type for delete button text.
`void`	`setDeleteButtonFontSize(int size)` Set the font size for delete button text.
`void`	`setDeleteButtonGradientColor(SecureInputBuilderV2.UiControlState state, int deleteButtonGradientColorStart, int deleteButtonGradientColorEnd)` Set the start and end color of the delete button gradient for corresponding control state.
`void`	`setDeleteButtonImage(int resourceId)` Set the image on the delete button.
`void`	`setDeleteButtonImageOpacity(SecureInputBuilderV2.UiControlState state, float opacity)` Set the Delete button image opacity value for normal and disabled state.
`void`	`setDeleteButtonText(java.lang.String text)` Set the text on the delete button.
`void`	`setDeleteButtonTextColor(SecureInputBuilderV2.UiControlState state, int color)` Set the color of the delete button text to be displayed for corresponding control state.
`void`	`setDialogHeightToScreenRatio(float ratio)` Set the height to screen ratio of keypad in dialog mode.
`void`	`setDialogWidthToScreenRatio(float ratio)` Set the width to screen ratio of keypad in dialog mode.
`void`	`setDistanceBetweenKeyAndSubscript(int distance)` Set the distance between key and subscripts.
`void`	`setEncoding(java.lang.String encoding)` Set the encoding format, the encoding types available include UTF-8, UTF-16, UTF-16LE, UTF-16BE, ISO-8859-1 and US-ASCII.
`void`	`setFirstLabel(java.lang.String label)` Set the text of the first label.
`void`	`setInputFieldBackgroundColor(SecureInputBuilderV2.UiControlFocusState state, int color)` Set the background color of the input field for for corresponding focus states.
`void`	`setInputFieldBorderColor(SecureInputBuilderV2.UiControlFocusState focusState, int color)` Set the color of the input field border for for corresponding focus states.
`void`	`setInputFieldFontSize(int size)` Set the font size of the input field.
`void`	`setIsDeleteButtonAlwaysEnabled(boolean alwaysEnabledDelete)` Set whether the Delete button should always be enabled even when there is nothing to delete.
`void`	`setIsDeleteButtonVisible(boolean visible)` Set the DELETE button visible or not.
`void`	`setIsOkButtonDisabled(boolean disabled)` Set the OK button disabled state when the OK button behavior is configured as `SecureInputBuilderV2.OkButtonBehavior.CUSTOM` or `SecureInputBuilderV2.OkButtonBehavior.ALWAYS_ENABLED`.
`void`	`setKeyColor(SecureInputBuilderV2.UiControlState state, int color)` Set the text color of the keys for normal and selected state.
`void`	`setKeyFont(android.graphics.Typeface font)` Set the custom font for buttons including key and the subscript of key.
`void`	`setKeyFontSize(int size)` Set the key font size.
`void`	`setKeypadFrameColor(int color)` Set the frame color of the keypad.
`void`	`setKeypadGridGradientColors(int gridGradientStartColor, int gridGradientEndColor)` Set the grid gradient start and end color for keypad grids.
`void`	`setKeypadHeight(float height)` Set keypad height.
`void`	`setKeypadHeightRatio(float heightRatio)` Set the height ratio of the keypad against the entire secure keypad (keypad + top screen).
`void`	`setKeypadMatrix(int rows, int columns)` Set the matrix (number of rows and columns) of keypad.
`void`	`setKeypadWidth(float width)` Set keypad width.
`void`	`setKeys(java.lang.String keys)` Set Character choices for the constitution of the PIN.
`void`	`setLabelAlignment(SecureInputBuilderV2.LabelAlignment alignment)` Set the label text position.
`void`	`setLabelColor(int color)` Set the text color of the label.
`void`	`setLabelFontSize(int size)` Set the label font size.
`void`	`setLogoBarBackgroundColor(int color)` Set the top logo bar background color.
`void`	`setLogoImage(android.graphics.Bitmap image)` Set the bitmap for the top logo.
`void`	`setLogoImage(int resourceId)` Set the resource id for the top logo image.
`void`	`setLogoPosition(SecureInputBuilderV2.LogoPosition logoPosition)` Set the logo position.
`void`	`setMaximumAndMinimumInputLength(int maximumLength, int minimumLength)` Set the maximum and minimum input length for the input field.
`void`	`setOkButtonBehavior(SecureInputBuilderV2.OkButtonBehavior okButtonBehavior)` Set the OK button behavior.
`void`	`setOkButtonFont(android.graphics.Typeface font)` Set the font for OK button text.
`void`	`setOkButtonFontSize(int size)` Set the font size for OK button text.
`void`	`setOkButtonGradientColor(SecureInputBuilderV2.UiControlState state, int okButtonGradientColorStart, int okButtonGradientColorEnd)` Set the start and end color of the OK button gradient for corresponding control state.
`void`	`setOkButtonImage(int resourceId)` Set the image on the OK button.
`void`	`setOkButtonImageOpacity(SecureInputBuilderV2.UiControlState state, float opacity)` Set the OK button image opacity value for normal and disabled state.
`void`	`setOkButtonText(java.lang.String text)` Set text for OK button.
`void`	`setOkButtonTextColor(SecureInputBuilderV2.UiControlState state, int color)` Set the color of the OK button text to be displayed for corresponding control state.
`void`	`setRippleEffectParameters(int color, long durationMs)` API to set the ripple effect parameters like duration and color.
`void`	`setScreenBackgroundColor(int color)` Set the screen background color of the keypad.
`void`	`setScreenBackgroundImage(android.graphics.Bitmap image)` Set the the screen background image of the keypad.
`void`	`setSecondLabel(java.lang.String label)` Set the text of the second label.
`void`	`setSubscriptColor(SecureInputBuilderV2.UiControlState state, int color)` Set the color of subscripts for normal and selected state.
`void`	`setSubscriptFontSize(int size)` Set the font size of subscripts.
`void`	`setSubscripts(java.util.List<java.lang.String> subscripts)` Set the subscripts to be displayed aside of keys on the keypad.
`void`	`showTopScreen(boolean show)` Set whether to display the top screen of secure keypad.
`void`	`swapOkAndDeleteButton()` Set whether to swap the position of OK button and Delete button.
`void`	`validateKeypadConfiguration()` Validate all the keypad configuration.
`void`	`wipe()` Wipe away all the sensitive data of the Secure Input Builder.

- Method Detail
  - buildPinpad
```
SecureInputUi buildPinpad(boolean isScrambled,
                          boolean isDoubleInputField,
                          boolean isDialog,
                          SecurePinpadListenerV2 listener)
```
    Create a new secure keypad.
    Notice: This method should be called once all the necessary configurations have been done. Note that the default configuration will be applied for attributes that have not been set to custom values.
    
    Parameters:
    
    isScrambled - This boolean value indicates whether the keypad would have a scrambled key locations. The scrambling is completely random and different for each time the keypad is shown.
    
    isDoubleInputField - If this Boolean value is true then secure keypad will show two input box. And if it is false it will show only one input box.
    
    isDialog - If this Boolean value is true then secure keypad will shown as Dialog (Popup). And if it is false it will shown as View (FullScreen).
    
    listener - Interface to create the communication channel between library and the main application. This interface will be used when user press keypad button. Secure pin will be provided as a callback value once the user input is finished.
    
    Returns:
    
    A SecureInputUi that contains the secure keypad DialogFragment and method selectInputField.
    
    Throws:
    
    java.lang.NullPointerException - when the listener is null
    
    Since:
    
    4.4
  - setEncoding
```
void setEncoding(java.lang.String encoding)
```
    Set the encoding format, the encoding types available include UTF-8, UTF-16, UTF-16LE, UTF-16BE, ISO-8859-1 and US-ASCII.
    
    Parameters:
    
    encoding - Default value is "UTF-8".
    
    Since:
    
    4.4
  - setScreenBackgroundColor
```
void setScreenBackgroundColor(int color)
```
    Set the screen background color of the keypad.
    
    Parameters:
    
    color - Default value is SecureInputDefaultSettings.SCREEN_BACKGROUND_COLOR.
    
    Since:
    
    4.4
  - setScreenBackgroundImage
```
void setScreenBackgroundImage(android.graphics.Bitmap image)
```
    Set the the screen background image of the keypad.
    
    Parameters:
    
    image - the screen background image.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the image is null.
    
    Since:
    
    4.4
  - setLogoImage
```
void setLogoImage(android.graphics.Bitmap image)
```
    Set the bitmap for the top logo.
    
    Parameters:
    
    image - the logo image to be set.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the image is null.
    
    Since:
    
    4.4
  - setLogoImage
```
void setLogoImage(@DrawableRes
                  int resourceId)
```
    Set the resource id for the top logo image.
    
    Parameters:
    
    resourceId - the resource id of the logo image to be set.
    
    Since:
    
    4.4
  - setLogoPosition
```
void setLogoPosition(SecureInputBuilderV2.LogoPosition logoPosition)
```
    Set the logo position.
    
    Parameters:
    
    logoPosition - the logo position. Default value is SecureInputDefaultSettings.LOGO_IMAGE_POSITION
    
    Since:
    
    4.4
  - setLogoBarBackgroundColor
```
void setLogoBarBackgroundColor(int color)
```
    Set the top logo bar background color.
    
    Parameters:
    
    color - Default value is SecureInputDefaultSettings.LOGOBAR_BACKGROUND_COLOR.
    
    Since:
    
    4.4
  - showTopScreen
```
void showTopScreen(boolean show)
```
    Set whether to display the top screen of secure keypad.
    
    Parameters:
    
    show - true to show the top screen and false to hide the top screen. Default is true.
    
    Since:
    
    4.4
  - setKeys
```
void setKeys(java.lang.String keys)
```
    Set Character choices for the constitution of the PIN. This is a character set indicating the possible characters that can be displayed.
    
    Parameters:
    
    keys - The keys to be set, cannot be null or empty. Don't allow duplicate characters. And only digits and alphabets (both lower and upper case) are supported. Default value is SecureInputDefaultSettings.DEFAULT_KEYS.
    
    Throws:
    
    java.lang.IllegalArgumentException - when this character array is null, empty, non-alphanumeric or contains duplicate characters.
    
    Since:
    
    4.4
  - setKeyFont
```
void setKeyFont(android.graphics.Typeface font)
```
    Set the custom font for buttons including key and the subscript of key.
    Note: This function only applies to keys and the subscripts of keys. The control buttons, i.e. OK button and delete button, are not affected by calling this method. Call the methods setOkButtonFont(Typeface) and setDeleteButtonFont(Typeface) to configure the OK button and delete button font respectively.
    
    Parameters:
    
    font - the typeface of the button text.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font is null.
    
    Since:
    
    4.4
  - setKeyFontSize
```
void setKeyFontSize(int size)
```
    Set the key font size.
    
    Parameters:
    
    size - the font size of keys. Default value is SecureInputDefaultSettings.BUTTON_FONT_SIZE
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font size is NOT in the range of 1 to 100.
    
    Since:
    
    4.4
  - setKeyColor
```
void setKeyColor(SecureInputBuilderV2.UiControlState state,
                 int color)
```
    Set the text color of the keys for normal and selected state. Note that OK and delete buttons are not included. Call the methods setOkButtonTextColor(UiControlState, int)} and setDeleteButtonTextColor(UiControlState, int)} to configure the OK button and delete button text color respectively.
    Parameters:
    
    state - The button state, there is no SecureInputBuilderV2.UiControlState.DISABLED for the keys to be displayed on the button.
    color - the color to be set. Default value
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.KEY_COLOR_NORMAL
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.KEY_COLOR_SELECTED
    Since:
    
    4.4
  - setSubscripts
```
void setSubscripts(java.util.List<java.lang.String> subscripts)
```
    Set the subscripts to be displayed aside of keys on the keypad.
    
    Parameters:
    
    subscripts - The subscript strings to be configured, can be null or empty. Default is not set.
    Note: The keys must have been set in order to set the subscripts.
    
    Since:
    
    4.4
  - setSubscriptFontSize
```
void setSubscriptFontSize(int size)
```
    Set the font size of subscripts.
    
    Parameters:
    
    size - The size of subscripts to be configured.Default value is SecureInputDefaultSettings.SUBSCRIPT_FONT_SIZE
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font size is NOT in the range of 1 to 100, or the font size is bigger than key font size.
    
    Since:
    
    4.4
  - setSubscriptColor
```
void setSubscriptColor(SecureInputBuilderV2.UiControlState state,
                       int color)
```
    Set the color of subscripts for normal and selected state.
    Parameters:
    
    state - The button state, there is no SecureInputBuilderV2.UiControlState.DISABLED for the subscript to be displayed on the button.
    color - The color of subscripts to be configured. Default value
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.KEY_COLOR_NORMAL
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.KEY_COLOR_SELECTED
    Since:
    
    4.4
  - setDistanceBetweenKeyAndSubscript
```
void setDistanceBetweenKeyAndSubscript(int distance)
```
    Set the distance between key and subscripts.
    
    Parameters:
    
    distance - the distance, should be in the range from 0 to 4. Default value is SecureInputDefaultSettings.DISTANCE_BETWEEN_KEY_AND_SUBSCRIPT
    
    Throws:
    
    java.lang.IllegalArgumentException - when the distance is less than 0 or greater than 4.
    
    Since:
    
    4.4
  - setKeypadWidth
```
void setKeypadWidth(float width)
```
    Set keypad width.
    Notice: This method must be called if developers want to call setLogoImage(Bitmap) or setLogoImage(int). Otherwise, this method is not compulsory.
    
    Parameters:
    
    width - the keypad width, should be a value >= 0.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the width is less than 0.
    
    Since:
    
    4.4
  - setKeypadHeight
```
void setKeypadHeight(float height)
```
    Set keypad height.
    Notice: This method must be called if developers wish to call setLogoImage(Bitmap) or setLogoImage(int). Otherwise, this method is not compulsory.
    
    Parameters:
    
    height - the keypad width, should be a value >= 0.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the height is less than 0.
    
    Since:
    
    4.4
  - setKeypadMatrix
```
void setKeypadMatrix(int rows,
                     int columns)
```
    Set the matrix (number of rows and columns) of keypad.
    
    Parameters:
    
    rows - Default value is SecureInputDefaultSettings.NO_OF_ROWS.
    
    columns - Default value is SecureInputDefaultSettings.NO_OF_COLUMNS.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the number of rows is NOT in the range of 1 to 8, or number of columns is not in the range of 2 to 8.
    
    Since:
    
    4.4
  - setKeypadHeightRatio
```
void setKeypadHeightRatio(float heightRatio)
```
    Set the height ratio of the keypad against the entire secure keypad (keypad + top screen).
    Notice: This attribute only takes effect when secure keypad top screen is enabled.
    
    Parameters:
    
    heightRatio - the height ratio of the keypad, should be in the range of 0.25 to 0.5. Default value is SecureInputDefaultSettings.KEYPAD_HEIGHT_RATIO
    
    Throws:
    
    java.lang.IllegalArgumentException - when the height ratio value is NOT in the range of 0.25 to 0.5
    
    Since:
    
    4.4
  - setButtonBorderColor
```
@Deprecated
void setButtonBorderColor(int color)
```
    Deprecated. Will be removed future major release. The API is split into two APIs; setKeypadFrameColor(int) and setKeypadGridGradientColors(int, int)
    
    Set the border color of all the buttons.
    
    Parameters:
    
    color - the color, default value is SecureInputDefaultSettings.BUTTON_BORDER_COLOR
    
    Since:
    
    4.4
  - setKeypadFrameColor
```
void setKeypadFrameColor(int color)
```
    Set the frame color of the keypad.
    
    Parameters:
    
    color - the color, default value is SecureInputDefaultSettings.BUTTON_BORDER_COLOR
    
    Since:
    
    4.6
  - setKeypadGridGradientColors
```
void setKeypadGridGradientColors(int gridGradientStartColor,
                                 int gridGradientEndColor)
```
    Set the grid gradient start and end color for keypad grids.
    
    Parameters:
    
    gridGradientStartColor - the start color of grid gradient, default value is SecureInputDefaultSettings.BUTTON_BORDER_COLOR
    
    gridGradientEndColor - the end color of grid gradient, default value is SecureInputDefaultSettings.BUTTON_BORDER_COLOR
    
    Since:
    
    4.6
  - setButtonBackgroundImage
```
void setButtonBackgroundImage(android.graphics.Bitmap image)
```
    Set background image for all the buttons.
    
    Parameters:
    
    image - the button background image.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the image is null.
    
    Since:
    
    4.4
  - setDialogHeightToScreenRatio
```
void setDialogHeightToScreenRatio(float ratio)
```
    Set the height to screen ratio of keypad in dialog mode. This method is only applicable if keypad is shown as Dialog (i.e. isDialog is true when you build the secure keypad using buildPinpad(boolean, boolean, boolean, SecurePinpadListenerV2)).
    
    Parameters:
    
    ratio - ratio of the keypad height to full screen. Default value is SecureInputDefaultSettings.DIALOG_HEIGHT_TO_SCREEN_RATIO
    
    Throws:
    
    java.lang.IllegalArgumentException - when ratio is less or equal to zero.
    
    Since:
    
    4.4
  - setDialogWidthToScreenRatio
```
void setDialogWidthToScreenRatio(float ratio)
```
    Set the width to screen ratio of keypad in dialog mode. This method is only applicable if keypad is shown as Dialog (i.e. isDialog is true when you build the pin pad using buildPinpad(boolean, boolean, boolean, SecurePinpadListenerV2)).
    
    Parameters:
    
    ratio - ratio of the keypad width to full screen. Default value is SecureInputDefaultSettings.DIALOG_WIDTH_TO_SCREEN_RATIO
    
    Throws:
    
    java.lang.IllegalArgumentException - when ratio is less or equal to zero.
    
    Since:
    
    4.4
  - setFirstLabel
```
void setFirstLabel(java.lang.String label)
```
    Set the text of the first label.
    
    Parameters:
    
    label - The text for the first label. Default value is SecureInputDefaultSettings.FIRST_LABEL.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the label is null.
    
    Since:
    
    4.4
  - setSecondLabel
```
void setSecondLabel(java.lang.String label)
```
    Set the text of the second label.
    
    Parameters:
    
    label - The text for the second label. Default value is SecureInputDefaultSettings.SECOND_LABEL.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the label is null.
    
    Since:
    
    4.4
  - setLabelColor
```
void setLabelColor(int color)
```
    Set the text color of the label.
    
    Parameters:
    
    color - the color to be set. Default value is SecureInputDefaultSettings.LABEL_COLOR.
    
    Since:
    
    4.4
  - setLabelFontSize
```
void setLabelFontSize(int size)
```
    Set the label font size.
    
    Parameters:
    
    size - the label font size. Default: SecureInputDefaultSettings.LABEL_FONT_SIZE
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font size is NOT in the range of 1 to 100
    
    Since:
    
    4.4
  - setLabelAlignment
```
void setLabelAlignment(SecureInputBuilderV2.LabelAlignment alignment)
```
    Set the label text position.
    
    Parameters:
    
    alignment - the label alignment. Default is SecureInputDefaultSettings.LABEL_ALIGNMENT
    
    Since:
    
    4.4
  - setButtonBackgroundImageOpacity
```
void setButtonBackgroundImageOpacity(SecureInputBuilderV2.UiControlState state,
                                     float opacity)
```
    Set the background image opacity for normal and disabled state for all the buttons.
    
    Parameters:
    
    state - the state to be configured for. Not applicable for SecureInputBuilderV2.UiControlState.SELECTED
    
    opacity - the opacity, should be a value between 0 and 1.0. Default value is SecureInputDefaultSettings.DEFAULT_OPACITY
    
    Throws:
    
    java.lang.IllegalArgumentException - when the opacity is NOT in the range of 0 to 1.0
    
    Since:
    
    4.4
  - setButtonHighlightColorOpacity
```
void setButtonHighlightColorOpacity(float opacity)
```
    Set the highlight color opacity of all the buttons.
    
    Parameters:
    
    opacity - the opacity, should be a value between 0 and 1.0. Default value is SecureInputDefaultSettings.DEFAULT_OPACITY
    
    Throws:
    
    java.lang.IllegalArgumentException - when the opacity is NOT in the range of 0 to 1.0
    
    Since:
    
    4.4
  - setButtonBorderWidth
```
void setButtonBorderWidth(int width)
```
    Set the button border width for all the buttons (must be greater than 0 and less than or equal to 8)
    
    Parameters:
    
    width - button border width. Default : SecureInputDefaultSettings.BUTTON_BORDER_WIDTH.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the width is NOT in the range of 1 to 8.
    
    Since:
    
    4.4
  - setButtonBackgroundColor
```
void setButtonBackgroundColor(SecureInputBuilderV2.UiControlState state,
                              int color)
```
    Set the background color for all the buttons.
    Parameters:
    
    state - the button state.
    color - the color of the state. Default value
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED
    Since:
    
    4.4
  - setButtonPressVisibility
```
void setButtonPressVisibility(boolean isVisible)
```
    Set whether the buttons should be highlighted when pressed. For security reason, it's disabled by default. User won't be able to see the state change when the button is pressed.
    
    Parameters:
    
    isVisible - Default value is SecureInputDefaultSettings.BUTTON_PRESS_VISIBILITY.
    
    Since:
    
    4.4
  - setMaximumAndMinimumInputLength
```
void setMaximumAndMinimumInputLength(int maximumLength,
                                     int minimumLength)
```
    Set the maximum and minimum input length for the input field. SecureInputBuilderV2.OkButtonBehavior.NONE and SecureInputBuilderV2.OkButtonBehavior.CUSTOM require minimum and maximum input length to be the same.
    
    Parameters:
    
    maximumLength - Default value is SecureInputDefaultSettings.MAXIMUM_INPUT_LENGTH.
    
    minimumLength - Default value is SecureInputDefaultSettings.MINIMUM_INPUT_LENGTH.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the minimum length is NOT in the range of 0 to 16, or maximum length is NOT in the range of 1 to 16, or minimum length is bigger than maximum length.
    
    Since:
    
    4.4
  - setDeleteButtonText
```
void setDeleteButtonText(java.lang.String text)
```
    Set the text on the delete button.
    
    Parameters:
    
    text - the text of delete button, Can NOT be null. Default value is SecureInputDefaultSettings.DELETE_BUTTON_NAME
    
    Throws:
    
    java.lang.IllegalArgumentException - when the text is null.
    
    Since:
    
    4.4
  - setDeleteButtonFont
```
void setDeleteButtonFont(android.graphics.Typeface font)
```
    Set the font type for delete button text.
    
    Parameters:
    
    font - the font of delete button
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font is null.
    
    Since:
    
    4.4
  - setDeleteButtonFontSize
```
void setDeleteButtonFontSize(int size)
```
    Set the font size for delete button text.
    
    Parameters:
    
    size - the font size, Default value is SecureInputDefaultSettings.BUTTON_FONT_SIZE
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font size is NOT in the range of 1 to 100.
    
    Since:
    
    4.4
  - setDeleteButtonTextColor
```
void setDeleteButtonTextColor(SecureInputBuilderV2.UiControlState state,
                              int color)
```
    Set the color of the delete button text to be displayed for corresponding control state.
    Parameters:
    
    state - the control state.
    color - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.DELETE_BUTTON_TEXT_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.DELETE_BUTTON_TEXT_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.DELETE_BUTTON_TEXT_COLOR_DISABLED,
    Since:
    
    4.4
  - setDeleteButtonImage
```
void setDeleteButtonImage(@DrawableRes
                          int resourceId)
```
    Set the image on the delete button.
    
    Parameters:
    
    resourceId - the resource id of delete button image.
    
    Since:
    
    4.4
  - setDeleteButtonImageOpacity
```
void setDeleteButtonImageOpacity(SecureInputBuilderV2.UiControlState state,
                                 float opacity)
```
    Set the Delete button image opacity value for normal and disabled state.
    
    Parameters:
    
    state - the state to be configured for. Not applicable for SecureInputBuilderV2.UiControlState.SELECTED
    
    opacity - the opacity, should be a value between 0 and 1.0. Default value is SecureInputDefaultSettings.DEFAULT_OPACITY
    
    Throws:
    
    java.lang.IllegalArgumentException - when the opacity is NOT in the range of 0 to 1.0
    
    Since:
    
    4.4
  - setIsDeleteButtonAlwaysEnabled
```
void setIsDeleteButtonAlwaysEnabled(boolean alwaysEnabledDelete)
```
    Set whether the Delete button should always be enabled even when there is nothing to delete. This setting is disabled by default.
    
    Parameters:
    
    alwaysEnabledDelete - Default value is false.
    
    Since:
    
    4.6
  - setOkButtonBehavior
```
void setOkButtonBehavior(SecureInputBuilderV2.OkButtonBehavior okButtonBehavior)
```
    Set the OK button behavior.
    
    Parameters:
    
    okButtonBehavior - the behavior to be set. Default value is SecureInputDefaultSettings.DEFAULT_OK_BUTTON_BEHAVIOR
    
    Throws:
    
    java.lang.IllegalArgumentException - when okButtonBehavior is set to SecureInputBuilderV2.OkButtonBehavior.NONE or SecureInputBuilderV2.OkButtonBehavior.CUSTOM and the maximum input length does not equal to the minimum input length set by setMaximumAndMinimumInputLength(int, int)
    
    Since:
    
    4.4
  - setOkButtonText
```
void setOkButtonText(java.lang.String text)
```
    Set text for OK button.
    
    Parameters:
    
    text - the text to be displayed on OK button. Default value is SecureInputDefaultSettings.OK_BUTTON_NAME
    
    Throws:
    
    java.lang.IllegalArgumentException - when the text is null.
    
    Since:
    
    4.4
  - setOkButtonFont
```
void setOkButtonFont(android.graphics.Typeface font)
```
    Set the font for OK button text.
    
    Parameters:
    
    font - the OK button font.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font is null.
    
    Since:
    
    4.4
  - setOkButtonFontSize
```
void setOkButtonFontSize(int size)
```
    Set the font size for OK button text.
    
    Parameters:
    
    size - the OK button font size. Default value is SecureInputDefaultSettings.BUTTON_FONT_SIZE
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font size NOT in the range of 1 to 100
    
    Since:
    
    4.4
  - setOkButtonTextColor
```
void setOkButtonTextColor(SecureInputBuilderV2.UiControlState state,
                          int color)
```
    Set the color of the OK button text to be displayed for corresponding control state.
    Parameters:
    
    state - the control state.
    color - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.OK_BUTTON_TEXT_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.OK_BUTTON_TEXT_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.OK_BUTTON_TEXT_COLOR_DISABLED,
    Since:
    
    4.4
  - setOkButtonImage
```
void setOkButtonImage(@DrawableRes
                      int resourceId)
```
    Set the image on the OK button.
    
    Parameters:
    
    resourceId - the image resource id for OK button.
    
    Since:
    
    4.4
  - setOkButtonImageOpacity
```
void setOkButtonImageOpacity(SecureInputBuilderV2.UiControlState state,
                             float opacity)
```
    Set the OK button image opacity value for normal and disabled state.
    
    Parameters:
    
    state - the state to be configured for. Not applicable for SecureInputBuilderV2.UiControlState.SELECTED
    
    opacity - the opacity, should be a value between 0 and 1.0. Default value is SecureInputDefaultSettings.DEFAULT_OPACITY
    
    Throws:
    
    java.lang.IllegalArgumentException - when the opacity is NOT in the range of 0 to 1.0
    
    Since:
    
    4.4
  - swapOkAndDeleteButton
```
void swapOkAndDeleteButton()
```
    Set whether to swap the position of OK button and Delete button. By default, OK button is on the left and the delete button is on the right.
    
    Since:
    
    4.4
  - setInputFieldFontSize
```
void setInputFieldFontSize(int size)
```
    Set the font size of the input field.
    
    Parameters:
    
    size - the font size of input field to be set. Default value is SecureInputDefaultSettings.INPUT_FIELD_FONT_SIZE
    
    Throws:
    
    java.lang.IllegalArgumentException - when the font size is NOT in the range of 1 to 100
    
    Since:
    
    4.4
  - setInputFieldBorderColor
```
void setInputFieldBorderColor(SecureInputBuilderV2.UiControlFocusState focusState,
                              int color)
```
    Set the color of the input field border for for corresponding focus states.
    Parameters:
    
    focusState - The state to be set.
    color - the color of the focus state. Default value
    
    for SecureInputBuilderV2.UiControlFocusState.FOCUSED is SecureInputDefaultSettings.INPUT_FIELD_COLOR_FOCUS,
    
    for SecureInputBuilderV2.UiControlFocusState.UNFOCUSED is SecureInputDefaultSettings.INPUT_FIELD_COLOR_UNFOCUS
    Since:
    
    4.4
  - setInputFieldBackgroundColor
```
void setInputFieldBackgroundColor(SecureInputBuilderV2.UiControlFocusState state,
                                  int color)
```
    Set the background color of the input field for for corresponding focus states.
    Parameters:
    
    state - the state of input field.
    color - the color of the focus state. Default value
    
    for SecureInputBuilderV2.UiControlFocusState.FOCUSED is SecureInputDefaultSettings.INPUT_FIELD_BACKGROUND_COLOR_FOCUS,
    
    for SecureInputBuilderV2.UiControlFocusState.UNFOCUSED is SecureInputDefaultSettings.INPUT_FIELD_BACKGROUND_COLOR_UNFOCUS
    Since:
    
    4.4
  - wipe
```
void wipe()
```
    Wipe away all the sensitive data of the Secure Input Builder. Including clearing the character array and erasing key press record.
    Notice: The wipe will only reset the character array and scramble option. other non-sensitive configuration such as color setting and text-label setting won't be reset in this function.
    Once wipe being called, the secure keypad is required to be dismissed / closed and re-built before next time usage.
    
    Since:
    
    4.4
  - setButtonGradientColor
```
void setButtonGradientColor(SecureInputBuilderV2.UiControlState state,
                            int buttonGradientColorStart,
                            int buttonGradientColorEnd)
```
    Set the start and end color of the button gradient for corresponding control state.
    Parameters:
    
    state - the control state.
    buttonGradientColorStart - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED,
    buttonGradientColorEnd - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED,
    Since:
    
    4.8
  - setOkButtonGradientColor
```
void setOkButtonGradientColor(SecureInputBuilderV2.UiControlState state,
                              int okButtonGradientColorStart,
                              int okButtonGradientColorEnd)
```
    Set the start and end color of the OK button gradient for corresponding control state.
    Parameters:
    
    state - the control state.
    okButtonGradientColorStart - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED,
    okButtonGradientColorEnd - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED,
    Since:
    
    4.8
  - setDeleteButtonGradientColor
```
void setDeleteButtonGradientColor(SecureInputBuilderV2.UiControlState state,
                                  int deleteButtonGradientColorStart,
                                  int deleteButtonGradientColorEnd)
```
    Set the start and end color of the delete button gradient for corresponding control state.
    Parameters:
    
    state - the control state.
    deleteButtonGradientColorStart - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED,
    deleteButtonGradientColorEnd - the color to be set. Default values
    
    for SecureInputBuilderV2.UiControlState.NORMAL is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_NORMAL,
    
    for SecureInputBuilderV2.UiControlState.SELECTED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_SELECTED,
    
    for SecureInputBuilderV2.UiControlState.DISABLED is SecureInputDefaultSettings.BUTTON_BACKGROUND_COLOR_DISABLED,
    Since:
    
    4.8
  - setButtonBackgroundImage
```
void setButtonBackgroundImage(@DrawableRes
                              int resourceId)
```
    Set Button background image resource id for all the buttons.
    
    Parameters:
    
    resourceId - the resource id of the button background to be set.
    
    Since:
    
    4.8
  - setIsOkButtonDisabled
```
void setIsOkButtonDisabled(boolean disabled)
```
    Set the OK button disabled state when the OK button behavior is configured as SecureInputBuilderV2.OkButtonBehavior.CUSTOM or SecureInputBuilderV2.OkButtonBehavior.ALWAYS_ENABLED.
    
    Parameters:
    
    disabled - This boolean value indicates whether the OK button should be disabled.
    
    Since:
    
    5.0
  - setIsDeleteButtonVisible
```
void setIsDeleteButtonVisible(boolean visible)
```
    Set the DELETE button visible or not.
    
    Parameters:
    
    visible - This boolean value indicates whether the DELETE button should be visible.
    
    Since:
    
    5.0
  - setButtonTouchVisualEffect
```
void setButtonTouchVisualEffect(SecureInputBuilderV2.ButtonTouchVisual buttonTouchVisual)
```
    Set the visual effect for keypad button touch like highlight or ripple.
    
    Parameters:
    
    buttonTouchVisual - The visual effect for keypad button touch. Requires setButtonPressVisibility(boolean) be called first, set button press to be visible.
    
    Since:
    
    5.0
  - setRippleEffectParameters
```
void setRippleEffectParameters(int color,
                               long durationMs)
```
    API to set the ripple effect parameters like duration and color.
    
    Parameters:
    
    color - The color for ripple effect parameter.
    
    durationMs - The duration for ripple effect parameter, unit is in millisecond. Requires setButtonTouchVisualEffect(com.gemalto.idp.mobile.ui.secureinput.SecureInputBuilderV2.ButtonTouchVisual) be called first, set the visual effect be ripple.
    
    Since:
    
    5.0
  - validateKeypadConfiguration
```
void validateKeypadConfiguration()
```
    Validate all the keypad configuration.
    
    Since:
    
    5.0

Interface SecureInputBuilderV2

Nested Class Summary

Method Summary

Method Detail

buildPinpad

setEncoding

setScreenBackgroundColor

setScreenBackgroundImage

setLogoImage

setLogoImage

setLogoPosition

setLogoBarBackgroundColor

showTopScreen

setKeys

setKeyFont

setKeyFontSize

setKeyColor

setSubscripts

setSubscriptFontSize

setSubscriptColor

setDistanceBetweenKeyAndSubscript

setKeypadWidth

setKeypadHeight

setKeypadMatrix

setKeypadHeightRatio

setButtonBorderColor

setKeypadFrameColor

setKeypadGridGradientColors

setButtonBackgroundImage

setDialogHeightToScreenRatio

setDialogWidthToScreenRatio

setFirstLabel

setSecondLabel

setLabelColor

setLabelFontSize

setLabelAlignment

setButtonBackgroundImageOpacity

setButtonHighlightColorOpacity

setButtonBorderWidth

setButtonBackgroundColor

setButtonPressVisibility

setMaximumAndMinimumInputLength

setDeleteButtonText

setDeleteButtonFont

setDeleteButtonFontSize

setDeleteButtonTextColor

setDeleteButtonImage

setDeleteButtonImageOpacity

setIsDeleteButtonAlwaysEnabled

setOkButtonBehavior

setOkButtonText

setOkButtonFont

setOkButtonFontSize

setOkButtonTextColor

setOkButtonImage

setOkButtonImageOpacity

swapOkAndDeleteButton

setInputFieldFontSize

setInputFieldBorderColor

setInputFieldBackgroundColor

wipe

setButtonGradientColor

setOkButtonGradientColor

setDeleteButtonGradientColor

setButtonBackgroundImage

setIsOkButtonDisabled

setIsDeleteButtonVisible

setButtonTouchVisualEffect

setRippleEffectParameters

validateKeypadConfiguration