com.gemalto.idp.mobile.ui.secureinput

Interface SecureInputBuilder

Deprecated.

Will be removed future major release, the replacement interface is SecureInputBuilderV2

@Deprecated
public interface SecureInputBuilder

An interface that represents Secure Pin Pad.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
android.support.v4.app.DialogFragment	buildPinpad(boolean isScramble, boolean isDoublePassword, boolean isDialog, SecurePinpadListener listener) Deprecated. Will be removed future major release.
void	setAutomaticEnabledOk(boolean automaticEnabledOk) Deprecated. Will be removed future major release.
void	setAutomaticOk(boolean automaticOk) Deprecated. Will be removed future major release.
void	setButtonCharacterColorDisabled(int buttonCharacterColorDisabled) Deprecated. Will be removed future major release.
void	setButtonCharacterColorNormal(int buttonCharacterColorNormal) Deprecated. Will be removed future major release.
void	setButtonCharacterColorSelected(int buttonCharacterColorSelected) Deprecated. Will be removed future major release.
void	setButtonGradientDisabledEnd(int buttonGradientDisabledEnd) Deprecated. Will be removed future major release.
void	setButtonGradientDisabledStart(int buttonGradientDisabledStart) Deprecated. Will be removed future major release.
void	setButtonGradientNormalEnd(int buttonGradientNormalEnd) Deprecated. Will be removed future major release.
void	setButtonGradientNormalStart(int buttonGradientNormalStart) Deprecated. Will be removed future major release.
void	setButtonGradientSelectedEnd(int buttonGradientSelectedEnd) Deprecated. Will be removed future major release.
void	setButtonGradientSelectedStart(int buttonGradientSelectedStart) Deprecated. Will be removed future major release.
void	setButtonSpacing(int buttonSpacing) Deprecated. Will be removed future major release.
void	setCharacterArray(java.lang.String characters) Deprecated. Will be removed future major release.
void	setDialogHeightToScreenRatio(double ratio) Deprecated. Will be removed future major release.
void	setDialogWidthToScreenRatio(double ratio) Deprecated. Will be removed future major release.
void	setEncoding(java.lang.String encoding) Deprecated. Will be removed future major release.
void	setKeypadHeight(int height) Deprecated. Will be removed future major release.
void	setKeypadWidth(int width) Deprecated. Will be removed future major release.
void	setLabelTextColor(int labelTextColor) Deprecated. Will be removed future major release.
void	setMaximumInputLength(int maximumInputLength) Deprecated. Will be removed future major release.
void	setMinimumInputLength(int minimumInputLength) Deprecated. Will be removed future major release.
void	setNumberOfColumns(int numberOfColumns) Deprecated. Will be removed future major release.
void	setNumberOfRows(int numberOfRows) Deprecated. Will be removed future major release.
void	setScreenBackGroundColor(int screenBackgroundColor) Deprecated. Will be removed future major release.
void	setSecondTextLabel(java.lang.String secondTextLabel) Deprecated. Will be removed future major release.
void	setTextBorderFocusColor(int textBorderColor) Deprecated. Will be removed future major release.
void	setTextBorderUnfocusColor(int textBorderColor) Deprecated. Will be removed future major release.
void	setTextLabel(java.lang.String textLabel) Deprecated. Will be removed future major release.
void	setVisibleButtonPress(boolean visibleButtonPress) Deprecated. Will be removed future major release.
void	wipe() Deprecated. Will be removed future major release.

Method Detail

buildPinpad

@Deprecated
android.support.v4.app.DialogFragment buildPinpad(boolean isScramble,
                                                              boolean isDoublePassword,
                                                              boolean isDialog,
                                                              SecurePinpadListener listener)

Deprecated. Will be removed future major release.

Create a pinpad.

Notice: The Secure Pin Pad is designed for one-time use, this function is expected to be called once all the necessary configurations have been done when each time the Pin Pad being used.

Parameters:

isScramble - If this Boolean value is true then secure keypad will generate scrambled keypad. And if it is false it will show its default behavior (unscramble keypad).

isDoublePassword - If this Boolean value is true then secure keypad will show two edit box. And if it is false it will show only one edit boxes.

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 - is Interface to create the communication channel between library and the main application. This interface will be used when user press Ok Button and provide the secure pin as a callback value.

Returns:

A dialogFragment that contains the secure keypad.

Throws:

java.lang.NullPointerException - when the listener is null

Since:

4.0

See Also:

SecureInputBuilderV2

setKeypadHeight

@Deprecated
void setKeypadHeight(int height)

Deprecated. Will be removed future major release.

Set the height of keypad for a View.

Parameters:

height - an integer indicates the height of the keypad in pixels.

Throws:

java.lang.IllegalArgumentException - when height less or equal to zero.

Since:

4.0

See Also:

SecureInputBuilderV2

setKeypadWidth

@Deprecated
void setKeypadWidth(int width)

Deprecated. Will be removed future major release.

Set the width of keypad for a View.

Parameters:

width - an integer indicates the width of the keypad in pixels.

Throws:

java.lang.IllegalArgumentException - when width less or equal to zero.

Since:

4.0

See Also:

SecureInputBuilderV2

setDialogHeightToScreenRatio

@Deprecated
void setDialogHeightToScreenRatio(double ratio)

Deprecated. Will be removed future major release.

Set the height of keypad for a Dialog. This method is only applicable if keypad is shown as Dialog (isDialog == true).

Parameters:

ratio - a double type data indicates the ratio of the height of the keypad when compared with the full screen.

Throws:

java.lang.IllegalArgumentException - when height less or equal to zero.

Since:

4.0

See Also:

SecureInputBuilderV2

setDialogWidthToScreenRatio

@Deprecated
void setDialogWidthToScreenRatio(double ratio)

Deprecated. Will be removed future major release.

Set the width of keypad for a Dialog. This method is only applicable if keypad is shown as Dialog (isDialog == true).

Parameters:

ratio - a double type data indicates the ratio of the width of the keypad when compared with the full screen.

Throws:

java.lang.IllegalArgumentException - when width less or equal to zero.

Since:

4.0

See Also:

SecureInputBuilderV2

setEncoding

@Deprecated
void setEncoding(java.lang.String encoding)

Deprecated. Will be removed future major release.

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 : "UTF-8".

Since:

4.0

See Also:

SecureInputBuilderV2

setCharacterArray

@Deprecated
void setCharacterArray(java.lang.String characters)

Deprecated. Will be removed future major release.

Set Character choices for the constitution of the PIN. This is a character set indicating the possible characters that can be displayed.

Parameters:

characters - Only digits and alphabets(both lower and upper case) are supported. Default : SecureInputConstant.DEFAULT_CHARACTER_ARRAY.

Throws:

java.lang.IllegalArgumentException - when this character array contains anything other than digits.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonSpacing

@Deprecated
void setButtonSpacing(int buttonSpacing)

Deprecated. Will be removed future major release.

Sets the space between buttons of the Keypad (must be greater than 0 and less or equal to 10)

Parameters:

buttonSpacing - Default : SecureInputConstant.DEFAULT_BUTTON_SPACING.

Throws:

java.lang.IllegalArgumentException - when this spacing is less or equal to 0, or greater than 10.

Since:

4.0

See Also:

SecureInputBuilderV2

setScreenBackGroundColor

@Deprecated
void setScreenBackGroundColor(int screenBackgroundColor)

Deprecated. Will be removed future major release.

Sets the screen background color of the Keypad.

Parameters:

screenBackgroundColor - Default : SecureInputConstant.DEFAULT_BACKGROUND_COLOR.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonCharacterColorNormal

@Deprecated
void setButtonCharacterColorNormal(int buttonCharacterColorNormal)

Deprecated. Will be removed future major release.

Sets the color of the character to be displayed on the button in the normal state.

Parameters:

buttonCharacterColorNormal - Default : SecureInputConstant.DEFAULT_CHARACTER_COLOR.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonCharacterColorSelected

@Deprecated
void setButtonCharacterColorSelected(int buttonCharacterColorSelected)

Deprecated. Will be removed future major release.

Sets the color of the character to be displayed on the button in the selected state.

Parameters:

buttonCharacterColorSelected - Default : SecureInputConstant.DEFAULT_CHARACTER_COLOR_SELECTED.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonCharacterColorDisabled

@Deprecated
void setButtonCharacterColorDisabled(int buttonCharacterColorDisabled)

Deprecated. Will be removed future major release.

Sets the color of the character to be displayed on the button in the disabled state.

Parameters:

buttonCharacterColorDisabled - Default : SecureInputConstant.DEFAULT_CHARACTER_COLOR_DISABLED.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonGradientNormalStart

@Deprecated
void setButtonGradientNormalStart(int buttonGradientNormalStart)

Deprecated. Will be removed future major release.

Sets the keypad button start color gradient value in normal state.

Parameters:

buttonGradientNormalStart - Default : SecureInputConstant.DEFAULT_BUTTON_GRADIENT_START.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonGradientNormalEnd

@Deprecated
void setButtonGradientNormalEnd(int buttonGradientNormalEnd)

Deprecated. Will be removed future major release.

Sets the keypad button end color gradient value in normal state.

Parameters:

buttonGradientNormalEnd - Default : SecureInputConstant.DEFAULT_BUTTON_GRADIENT_END.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonGradientSelectedStart

@Deprecated
void setButtonGradientSelectedStart(int buttonGradientSelectedStart)

Deprecated. Will be removed future major release.

Sets the keypad button start color gradient value in selected state.

Parameters:

buttonGradientSelectedStart - Default : SecureInputConstant.DEFAULT_BUTTON_GRADIENT_SELECTED_START.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonGradientSelectedEnd

@Deprecated
void setButtonGradientSelectedEnd(int buttonGradientSelectedEnd)

Deprecated. Will be removed future major release.

Sets the keypad button end color gradient value in selected state.

Parameters:

buttonGradientSelectedEnd - Default : SecureInputConstant.DEFAULT_BUTTON_GRADIENT_SELECTED_END.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonGradientDisabledStart

@Deprecated
void setButtonGradientDisabledStart(int buttonGradientDisabledStart)

Deprecated. Will be removed future major release.

Sets the keypad button start color gradient value in disabled state.

Parameters:

buttonGradientDisabledStart - Default : SecureInputConstant.DEFAULT_BUTTON_GRADIENT_DISABLED_START.

Since:

4.0

See Also:

SecureInputBuilderV2

setButtonGradientDisabledEnd

@Deprecated
void setButtonGradientDisabledEnd(int buttonGradientDisabledEnd)

Deprecated. Will be removed future major release.

Sets the keypad button end color gradient value in disabled state.

Parameters:

buttonGradientDisabledEnd - Default : SecureInputConstant.DEFAULT_BUTTON_GRADIENT_DISABLED_END.

Since:

4.0

See Also:

SecureInputBuilderV2

setLabelTextColor

@Deprecated
void setLabelTextColor(int labelTextColor)

Deprecated. Will be removed future major release.

Sets the text color of the label.

Parameters:

labelTextColor - Default : SecureInputConstant.DEFAULT_TEXT_LABEL_COLOR.

Since:

4.0

See Also:

SecureInputBuilderV2

setTextBorderFocusColor

@Deprecated
void setTextBorderFocusColor(int textBorderColor)

Deprecated. Will be removed future major release.

Sets the color of the text border when being focused.

Parameters:

textBorderColor - Default : SecureInputConstant.DEFAULT_TEXT_BORDER_FOCUS_COLOR.

Since:

4.0

See Also:

SecureInputBuilderV2

setTextBorderUnfocusColor

@Deprecated
void setTextBorderUnfocusColor(int textBorderColor)

Deprecated. Will be removed future major release.

Sets the color of the text border when being un-focused.

Parameters:

textBorderColor - Default : SecureInputConstant.DEFAULT_TEXT_BORDER_UNFOCUS_COLOR.

Since:

4.0

See Also:

SecureInputBuilderV2

setTextLabel

@Deprecated
void setTextLabel(java.lang.String textLabel)

Deprecated. Will be removed future major release.

Sets the text label.

Parameters:

textLabel - Default : SecureInputConstant.DEFAULT_TEXT_LABEL.

Throws:

java.lang.IllegalArgumentException - when the text string is null.

Since:

4.0

See Also:

SecureInputBuilderV2

setSecondTextLabel

@Deprecated
void setSecondTextLabel(java.lang.String secondTextLabel)

Deprecated. Will be removed future major release.

Sets the second text label

Parameters:

secondTextLabel - Default : SecureInputConstant.DEFAULT_SECOND_TEXT_LABEL.

Throws:

java.lang.IllegalArgumentException - when the text string is null.

Since:

4.0

See Also:

SecureInputBuilderV2

setNumberOfRows

@Deprecated
void setNumberOfRows(int numberOfRows)

Deprecated. Will be removed future major release.

Sets the number of rows in the keypad.

Parameters:

numberOfRows - Default : SecureInputConstant.DEFAULT_NO_OF_ROWS.

Throws:

java.lang.IllegalArgumentException - when the number of rows is less or equal to zero.

Since:

4.0

See Also:

SecureInputBuilderV2

setNumberOfColumns

@Deprecated
void setNumberOfColumns(int numberOfColumns)

Deprecated. Will be removed future major release.

Sets the number of columns in the keypad.

Parameters:

numberOfColumns - Default : SecureInputConstant.DEFAULT_NO_OF_COLUMNS.

Throws:

java.lang.IllegalArgumentException - when the number of columns is less or equal to zero.

Since:

4.0

See Also:

SecureInputBuilderV2

setMaximumInputLength

@Deprecated
void setMaximumInputLength(int maximumInputLength)

Deprecated. Will be removed future major release.

Sets the maximum input length to be entered in the edit text.

Parameters:

maximumInputLength - Default : SecureInputConstant.DEFAULT_MAXIMUM_INPUT_LENGTH.

Throws:

java.lang.IllegalArgumentException - when the maximum length of the PIN is set as an integer less or equal to zero, or greater than 16.

Since:

4.0

See Also:

SecureInputBuilderV2

setMinimumInputLength

@Deprecated
void setMinimumInputLength(int minimumInputLength)

Deprecated. Will be removed future major release.

Sets the minimum input length to be entered in the edit text.

Parameters:

minimumInputLength - Default : SecureInputConstant.DEFAULT_MINIMUM_INPUT_LENGTH.

Throws:

java.lang.IllegalArgumentException - when the minimum length of the PIN is set as an integer less or equal to zero, or greater than 16.

Since:

4.0

See Also:

SecureInputBuilderV2

setAutomaticEnabledOk

@Deprecated
void setAutomaticEnabledOk(boolean automaticEnabledOk)

Deprecated. Will be removed future major release.

Sets the automatic enabling of OK button. if true: OK button in the Keypad is automatically enabled when minimum input length is entered. if false: OK button in the Keypad is always in enabled state

Parameters:

automaticEnabledOk - Default : SecureInputConstant.DEFAULT_AUTOMATIC_ENABLED_OK.

Since:

4.0

See Also:

SecureInputBuilderV2

setAutomaticOk

@Deprecated
void setAutomaticOk(boolean automaticOk)

Deprecated. Will be removed future major release.

Sets automatic OK state of the button. This is set as true only when the minimum input length == maximum input length. if true: OK button is not shown on the keypad, when minimum/maximum input length is entered OK button functionality is automatically executed. if false: OK button is shown and the minimum input length != maximum input length.

Parameters:

automaticOk - Default : SecureInputConstant.DEFAULT_AUTOMATIC_OK.

Since:

4.0

See Also:

SecureInputBuilderV2

setVisibleButtonPress

@Deprecated
void setVisibleButtonPress(boolean visibleButtonPress)

Deprecated. Will be removed future major release.

If this Boolean is true then when a button is pressed on the keypad, they become highlighted, if not, no highlight is enabled.

Parameters:

visibleButtonPress - Default : SecureInputConstant.DEFAULT_VISIBLE_BUTTON_PRESS.

Since:

4.0

See Also:

SecureInputBuilderV2

wipe

@Deprecated
void wipe()

Deprecated. Will be removed future major release.

Wipe away all the sensitive data of the Pin Pad builder. Including setting isScrambled to false, clearing the character array and erasing keypress 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 pin pad is required to be dismissed / closed and re-built before next time usage.

Since:

4.0

See Also:

SecureInputBuilderV2