com.adyen.threeds2.customization

Class UiCustomization

java.lang.Object

com.adyen.threeds2.customization.UiCustomization

All Implemented Interfaces:

android.os.Parcelable

public final class UiCustomization
extends java.lang.Object
implements android.os.Parcelable

This class provides the functionality required to customize the 3DS SDK UI elements.
An object of this class holds various UI-related parameters.

Created by Ran Haveshush on 24/08/2018.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UiCustomization.ButtonType This enum represents the ButtonCustomization button's type.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<UiCustomization>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
UiCustomization()

Method Summary

Modifier and Type	Method and Description
int	describeContents()
ButtonCustomization	getButtonCustomization(UiCustomization.ButtonType buttonType) Returns a ButtonCustomization instance for a specified button type UiCustomization.ButtonType.
ExpandableInfoCustomization	getExpandableInfoCustomization()
LabelCustomization	getLabelCustomization()
ScreenCustomization	getScreenCustomization()
SelectionItemCustomization	getSelectionItemCustomization()
TextBoxCustomization	getTextBoxCustomization()
ToolbarCustomization	getToolbarCustomization()
void	setBorderColor(java.lang.String hexColorCode) This utility method sets the border color for all of the specific customizations.
void	setButtonCustomization(ButtonCustomization buttonCustomization, UiCustomization.ButtonType buttonType) Sets the ButtonCustomization for a specific UiCustomization.ButtonType. The 3DS SDK uses this object for customizing buttons.
void	setExpandableInfoCustomization(ExpandableInfoCustomization expandableInfoCustomization) Sets the expandable infos customization. The 3DS SDK uses this object for customizing expandable infos.
void	setHighlightedBackgroundColor(java.lang.String hexColorCode) This utility method sets the highlighted background color for all of the specific customizations.
void	setLabelCustomization(LabelCustomization labelCustomization) The setLabelCustomization method shall accept a LabelCustomization object.
void	setScreenBackgroundColor(java.lang.String hexColorCode) This utility method sets the challenge Activity's background color by setting the ScreenCustomization background color.
void	setScreenCustomization(ScreenCustomization screenCustomization) Sets the screen customization. The 3DS SDK uses this object for customizing the challenge Activity screen.
void	setSelectionItemCustomization(SelectionItemCustomization selectionItemCustomization) Sets the selection items customization. The 3DS SDK uses this object for customizing selection items.
void	setStatusBarColor(java.lang.String hexColorCode) This utility method sets the status bar color by setting the ScreenCustomization status bar color.
void	setTextBoxCustomization(TextBoxCustomization textBoxCustomization) Sets the text boxes (EditText) customization. The 3DS SDK uses this object for customizing text boxes (EditText).
void	setTextColor(java.lang.String hexColorCode) This utility method sets the text color for all of the specific customizations.
void	setTintColor(java.lang.String hexColorCode) This utility method sets the tint color for all of the specific customizations.
void	setToolbarCustomization(ToolbarCustomization toolbarCustomization) Sets the toolbar customization. The 3DS SDK uses this object for customizing toolbars.
void	setToolbarTitle(java.lang.String title) This utility method sets the toolbar title by setting the ToolbarCustomization header text.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<UiCustomization> CREATOR

Constructor Detail

UiCustomization

public UiCustomization()

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

getButtonCustomization

public ButtonCustomization getButtonCustomization(UiCustomization.ButtonType buttonType)
                                           throws InvalidInputException

Returns a ButtonCustomization instance for a specified button type UiCustomization.ButtonType.

Parameters:

buttonType - A UiCustomization.ButtonType that represents a specific button type to retrieve.

Returns:

A ButtonCustomization for the specified UiCustomization.ButtonType.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setButtonCustomization

public void setButtonCustomization(ButtonCustomization buttonCustomization,
                                   UiCustomization.ButtonType buttonType)
                            throws InvalidInputException

Sets the ButtonCustomization for a specific UiCustomization.ButtonType.
The 3DS SDK uses this object for customizing buttons.

Parameters:

buttonCustomization - A ButtonCustomization that represents button customization object.

buttonType - A UiCustomization.ButtonType that represents button type.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

getScreenCustomization

public ScreenCustomization getScreenCustomization()

Returns:

A ScreenCustomization that represents the screen customization object.

setScreenCustomization

public void setScreenCustomization(ScreenCustomization screenCustomization)
                            throws InvalidInputException

Sets the screen customization.
The 3DS SDK uses this object for customizing the challenge Activity screen.

Parameters:

screenCustomization - A ScreenCustomization that represents the screen customization object.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

getToolbarCustomization

public ToolbarCustomization getToolbarCustomization()

Returns:

A ToolbarCustomization that represents the toolbar customization object.

setToolbarCustomization

public void setToolbarCustomization(ToolbarCustomization toolbarCustomization)
                             throws InvalidInputException

Sets the toolbar customization.
The 3DS SDK uses this object for customizing toolbars.

Parameters:

toolbarCustomization - A ToolbarCustomization that represents the toolbar customization object.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

getLabelCustomization

public LabelCustomization getLabelCustomization()

Returns:

A LabelCustomization that represents the label customization object.

setLabelCustomization

public void setLabelCustomization(LabelCustomization labelCustomization)
                           throws InvalidInputException

The setLabelCustomization method shall accept a LabelCustomization object. The 3DS SDK uses this object for customizing labels.

Parameters:

labelCustomization - A LabelCustomization that represents the label customization object.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

getTextBoxCustomization

public TextBoxCustomization getTextBoxCustomization()

Returns:

A TextBoxCustomization that represents the text box (EditText) customization object.

setTextBoxCustomization

public void setTextBoxCustomization(TextBoxCustomization textBoxCustomization)
                             throws InvalidInputException

Sets the text boxes (EditText) customization.
The 3DS SDK uses this object for customizing text boxes (EditText).

Parameters:

textBoxCustomization - A TextBoxCustomization that represents the text box customization object.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

getSelectionItemCustomization

public SelectionItemCustomization getSelectionItemCustomization()

Returns:

A SelectionItemCustomization that represents the selection item customization object.

setSelectionItemCustomization

public void setSelectionItemCustomization(SelectionItemCustomization selectionItemCustomization)
                                   throws InvalidInputException

Sets the selection items customization.
The 3DS SDK uses this object for customizing selection items.

Parameters:

selectionItemCustomization - A SelectionItemCustomization that represents the selection item customization object.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

getExpandableInfoCustomization

public ExpandableInfoCustomization getExpandableInfoCustomization()

Returns:

A ExpandableInfoCustomization that represents the expandable info customization object.

setExpandableInfoCustomization

public void setExpandableInfoCustomization(ExpandableInfoCustomization expandableInfoCustomization)
                                    throws InvalidInputException

Sets the expandable infos customization.
The 3DS SDK uses this object for customizing expandable infos.

Parameters:

expandableInfoCustomization - A ExpandableInfoCustomization that represents the expandable info customization object.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setToolbarTitle

public void setToolbarTitle(java.lang.String title)

This utility method sets the toolbar title by setting the ToolbarCustomization header text.

Parameters:

title - The toolbar title.

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setStatusBarColor

public void setStatusBarColor(java.lang.String hexColorCode)
                       throws InvalidInputException

This utility method sets the status bar color by setting the ScreenCustomization status bar color.

Parameters:

hexColorCode - The color code in Hex format. For example "#999999".

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setScreenBackgroundColor

public void setScreenBackgroundColor(java.lang.String hexColorCode)
                              throws InvalidInputException

This utility method sets the challenge Activity's background color by setting the ScreenCustomization background color.

Parameters:

hexColorCode - The color code in Hex format. For example "#999999".

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setTextColor

public void setTextColor(java.lang.String hexColorCode)
                  throws InvalidInputException

This utility method sets the text color for all of the specific customizations.

• ScreenCustomization
• ToolbarCustomization
• LabelCustomization
• TextBoxCustomization
• SelectionItemCustomization
• ExpandableInfoCustomization
• ButtonCustomization

Parameters:

hexColorCode - The color code in Hex format. For example "#999999".

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setBorderColor

public void setBorderColor(java.lang.String hexColorCode)
                    throws InvalidInputException

This utility method sets the border color for all of the specific customizations.

• TextBoxCustomization
• SelectionItemCustomization
• ExpandableInfoCustomization

Parameters:

hexColorCode - The color code in Hex format. For example "#999999".

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setTintColor

public void setTintColor(java.lang.String hexColorCode)
                  throws InvalidInputException

This utility method sets the tint color for all of the specific customizations.

• ToolbarCustomization
• SelectionItemCustomization
• ButtonCustomization for the borderless buttons UiCustomization.ButtonType.RESEND and UiCustomization.ButtonType.CANCEL

Parameters:

hexColorCode - The color code in Hex format. For example "#999999".

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.

setHighlightedBackgroundColor

public void setHighlightedBackgroundColor(java.lang.String hexColorCode)
                                   throws InvalidInputException

This utility method sets the highlighted background color for all of the specific customizations.

• SelectionItemCustomization
• ExpandableInfoCustomization
• ButtonCustomization for the borderless buttons UiCustomization.ButtonType.RESEND and UiCustomization.ButtonType.CANCEL

Parameters:

hexColorCode - The color code in Hex format. For example "#999999".

Throws:

InvalidInputException - This exception shall be thrown if an input parameter is invalid.