UI Customization

The UICustomization class exposes functionality to customize the 3DS SDK UI elements. This allows the 3DS Requestor application to have its own look-and-feel in the native challenge pages. The customization of Buttons, Labels, TextBoxes, and Toolbars is enabled via the various classes and subclasses outlined below.

UICustomization

Main class for configuring the customization of UI elements.

public class UiCustomization {
	enum ButtonType (VERIFY, CONTINUE, NEXT, CANCEL, RESEND)
	enum LabelType (INFO_HEADER, INFO_TEXT, INFO_LABEL, WHITELIST, WHY_INFO, WHY_INFO_TEXT, EXPANDABLE_INFO, EXPANDABLE_INFO_TEXT, SELECTION_LIST)

	void setButtonCustomization(ButtonCustomization buttonCustomization, ButtonType buttonType)
	void setToolbarCustomization(ToolbarCustomization toolbarCustomization)
	void setLabelCustomization(LabelCustomization labelCustomization)
	void setTextBoxCustomization(TextBoxCustomization textboxCustomization)
	void setBackground(String hexColorCode)
	void setInformationZoneIconPosition(int position) // 0: right, 1: left, 2: hide
	

	ButtonCustomization getButtonCustomization(ButtonType buttonType)
	ToolbarCustomization getToolbarCustomization()
	LabelCustomization getLabelCustomization()
	TextBoxCustomization getTextBoxCustomization()
	String getBackground(String hexColorCode)
	int getInformationZoneIconPosition(int position)
}

ButtonCustomization

The ButtonCustomization class enables the customization of various buttons presented to the cardholder during the challenge process.

public class ButtonCustomization {
	void setBackgroundColor(String hexColorCode)
	void setCornerRadius(int cornerRadius)
	void setTextFontName(String fontName)
	void setTextFontSize(int fontSize)
	void setTextColor(String hexColorCode)
	void setHeight(int pixels)
    void setPadding(int start, int top, int end, int bottom) // applicable only for ButtonType of CANCEL

	String getBackgroundColor()
	int getCornerRadius()
	String getTextFontName()
	int getTextFontSize()
	String getTextColor()
	int getHeight()
	int[] getPadding() // applicable only for ButtonType of CANCEL
}

For example, the following code will configure buttons with red backgrounds and white font:

	UiCustomization uiCustomization = new UiCustomization();

	ButtonCustomization customButton = new ButtonCustomization();
	customButton.setTextColor("#FFFFFF"); // White
	customButton.setBackgroundColor("#951728"); // Dark red

	uiCustomization.setButtonCustomization(customButton, UiCustomization.ButtonType.CANCEL);
	uiCustomization.setButtonCustomization(customButton, UiCustomization.ButtonType.CONTINUE);
	uiCustomization.setButtonCustomization(customButton, UiCustomization.ButtonType.NEXT);
	uiCustomization.setButtonCustomization(customButton, UiCustomization.ButtonType.RESEND);
	uiCustomization.setButtonCustomization(customButton, UiCustomization.ButtonType.SUBMIT);   

This results in the following Submit button for a Single-Select challenge:

LabelCustomization

The LabelCustomization class enables the customization of various labels displayed throughout the challenge process.

public class LabelCustomization {
	void setHeadingTextAlignment(int textAlignment)
	void setHeadingTextColor(String hexColorCode)
	void setHeadingTextFontName(String fontName)
	void setHeadingTextFontSize(int fontSize)
	void setInputTextColor(String hexColorCode)
	void setInputTextFontName(String fontName)
	void setInputTextFontSize(int fontSize)
	void setTextColor(String hexColorCode)
	void setTextColor(LabelType labelType, String hexColorCode)
	void setTextFontName(String fontName)
	void setTextFontName(LabelType labelType, String fontName)
	void setTextFontSize(int fontSize)
	void setTextFontSize(LabelType, labelType, int fontSize)
	void setBackgroundColor(LabelType labelType, String hexColorCode)
	void setPadding(LabelType labelType, int start, int top, int end, int bottom)

	int getHeadingTextAlignment()
	String getHeadingTextColor()
	String getHeadingTextFontName()
	int getHeadingTextFontSize()
	String getInputLabelTextColor()
	String getInputLabelTextFontName()
	int getInputLabelTextFontSize()
	String getTextColor()
	String getTextColor(LabelType labelType)
	String getTextFontName()
	String getTextFontName(LabelType labelType)
	int getTextFontSize()
	int getTextFontSize(LabelType labelType)
	String getBackgroundColor(LabelType labelType)
	int[] getPadding(LabelType labelType)
}

TextBoxCustomization

The TextBoxCustomization class enables the customization of textboxes displayed throughout the challenge process.

public class TextBoxCustomization {
	void setBorderColor(String hexColorCode)
	void setBorderWidth(int borderWidth)
	void setCornerRadius(int cornerRadius)
	void setTextColor(String hexColorCode)
	void setTextFontName(String fontName)
	void setTextFontSize(int fontSize)

	String getBorderColor()
	int getBorderWidth()
	int getCornerRadius()
	String getTextColor()
	String getTextFontName()
	int getTextFontSize()
}

ToolbarCustomization

The ToolbarCustomization class enables the customization of the toolbar displayed throughout the challenge process.

public class ToolbarCustomization {
	void setBackgroundColor(String hexColorCode)
	void setButtonText(String buttonText)
	void setHeaderText(String headerText)
	void setTextColor(String hexColorCode)
	void setTextFontName(String fontName)
	void setTextFontSize(int fontSize)

	String getBackgroundColor()
	String getButtonText()
	String getHeaderText()
	String getTextColor()
	String getTextFontName()
	int getTextFontSize()
}