Class UiCustomization
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class UiCustomization implements 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 Description public enum
UiCustomization.ButtonType
This enum represents the ButtonCustomization button's type.
-
Field Summary
Fields Modifier and Type Field Description public final static Parcelable.Creator<UiCustomization>
CREATOR
public final static int
CONTENTS_FILE_DESCRIPTOR
public final static int
PARCELABLE_WRITE_RETURN_VALUE
-
Constructor Summary
Constructors Constructor Description UiCustomization()
-
Method Summary
Modifier and Type Method Description int
describeContents()
void
writeToParcel(Parcel dest, int flags)
ButtonCustomization
getButtonCustomization(UiCustomization.ButtonType buttonType)
Returns a ButtonCustomization instance for a specified button type ButtonType. void
setButtonCustomization(ButtonCustomization buttonCustomization, UiCustomization.ButtonType buttonType)
Sets the ButtonCustomization for a specific ButtonType. ScreenCustomization
getScreenCustomization()
void
setScreenCustomization(ScreenCustomization screenCustomization)
Sets the screen customization. ToolbarCustomization
getToolbarCustomization()
void
setToolbarCustomization(ToolbarCustomization toolbarCustomization)
Sets the toolbar customization. LabelCustomization
getLabelCustomization()
void
setLabelCustomization(LabelCustomization labelCustomization)
The setLabelCustomization method shall accept a LabelCustomization object. TextBoxCustomization
getTextBoxCustomization()
void
setTextBoxCustomization(TextBoxCustomization textBoxCustomization)
Sets the text boxes (EditText) customization. SelectionItemCustomization
getSelectionItemCustomization()
void
setSelectionItemCustomization(SelectionItemCustomization selectionItemCustomization)
Sets the selection items customization. ExpandableInfoCustomization
getExpandableInfoCustomization()
void
setExpandableInfoCustomization(ExpandableInfoCustomization expandableInfoCustomization)
Sets the expandable infos customization. void
setToolbarTitle(String title)
This utility method sets the toolbar title by setting the ToolbarCustomization header text. void
setStatusBarColor(String hexColorCode)
This utility method sets the status bar color by setting the ScreenCustomization status bar color. void
setScreenBackgroundColor(String hexColorCode)
This utility method sets the challenge Activity's background color by setting the ScreenCustomization background color. void
setTextColor(String hexColorCode)
This utility method sets the text color for all of the specific customizations. void
setBorderColor(String hexColorCode)
This utility method sets the border color for all of the specific customizations. void
setTintColor(String hexColorCode)
This utility method sets the tint color for all of the specific customizations. void
setHighlightedBackgroundColor(String hexColorCode)
This utility method sets the highlighted background color for all of the specific customizations. -
-
Method Detail
-
describeContents
int describeContents()
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
-
getButtonCustomization
ButtonCustomization getButtonCustomization(UiCustomization.ButtonType buttonType)
Returns a ButtonCustomization instance for a specified button type ButtonType.
- Parameters:
buttonType
- A ButtonType that represents a specific button type to retrieve.- Returns:
A ButtonCustomization for the specified ButtonType.
-
setButtonCustomization
void setButtonCustomization(ButtonCustomization buttonCustomization, UiCustomization.ButtonType buttonType)
Sets the ButtonCustomization for a specific ButtonType. The 3DS SDK uses this object for customizing buttons.
- Parameters:
buttonCustomization
- A ButtonCustomization that represents button customization object.buttonType
- A ButtonType that represents button type.
-
getScreenCustomization
ScreenCustomization getScreenCustomization()
- Returns:
A ScreenCustomization that represents the screen customization object.
-
setScreenCustomization
void setScreenCustomization(ScreenCustomization screenCustomization)
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.
-
getToolbarCustomization
ToolbarCustomization getToolbarCustomization()
- Returns:
A ToolbarCustomization that represents the toolbar customization object.
-
setToolbarCustomization
void setToolbarCustomization(ToolbarCustomization toolbarCustomization)
Sets the toolbar customization. The 3DS SDK uses this object for customizing toolbars.
- Parameters:
toolbarCustomization
- A ToolbarCustomization that represents the toolbar customization object.
-
getLabelCustomization
LabelCustomization getLabelCustomization()
- Returns:
A LabelCustomization that represents the label customization object.
-
setLabelCustomization
void setLabelCustomization(LabelCustomization labelCustomization)
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.
-
getTextBoxCustomization
TextBoxCustomization getTextBoxCustomization()
- Returns:
A TextBoxCustomization that represents the text box (EditText) customization object.
-
setTextBoxCustomization
void setTextBoxCustomization(TextBoxCustomization textBoxCustomization)
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.
-
getSelectionItemCustomization
SelectionItemCustomization getSelectionItemCustomization()
- Returns:
A SelectionItemCustomization that represents the selection item customization object.
-
setSelectionItemCustomization
void setSelectionItemCustomization(SelectionItemCustomization selectionItemCustomization)
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.
-
getExpandableInfoCustomization
ExpandableInfoCustomization getExpandableInfoCustomization()
- Returns:
A ExpandableInfoCustomization that represents the expandable info customization object.
-
setExpandableInfoCustomization
void setExpandableInfoCustomization(ExpandableInfoCustomization expandableInfoCustomization)
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.
-
setToolbarTitle
void setToolbarTitle(String title)
This utility method sets the toolbar title by setting the ToolbarCustomization header text.
- Parameters:
title
- The toolbar title.
-
setStatusBarColor
@Deprecated(message = "Deprecated in Android. Has no effect starting from Android 15.") void setStatusBarColor(String hexColorCode)
This utility method sets the status bar color by setting the ScreenCustomization status bar color.
- Parameters:
hexColorCode
- The color code in Hex format.
-
setScreenBackgroundColor
void setScreenBackgroundColor(String hexColorCode)
This utility method sets the challenge Activity's background color by setting the ScreenCustomization background color.
- Parameters:
hexColorCode
- The color code in Hex format.
-
setTextColor
void setTextColor(String hexColorCode)
This utility method sets the text color for all of the specific customizations.
- Parameters:
hexColorCode
- The color code in Hex format.
-
setBorderColor
void setBorderColor(String hexColorCode)
This utility method sets the border color for all of the specific customizations.
- Parameters:
hexColorCode
- The color code in Hex format.
-
setTintColor
void setTintColor(String hexColorCode)
This utility method sets the tint color for all of the specific customizations.
- ToolbarCustomization
- SelectionItemCustomization
- ButtonCustomization for the borderless buttons RESEND and CANCEL
- Parameters:
hexColorCode
- The color code in Hex format.
-
setHighlightedBackgroundColor
void setHighlightedBackgroundColor(String hexColorCode)
This utility method sets the highlighted background color for all of the specific customizations.
- SelectionItemCustomization
- ExpandableInfoCustomization
- ButtonCustomization for the borderless buttons RESEND and CANCEL
- Parameters:
hexColorCode
- The color code in Hex format.
-
-
-
-