Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Overview

getToolbarCustomization()Gets toolbar customization

Excerpt

userinterfaces.

Modifier and Type	Method and Description

com.cardinalcommerce.shared.

Description
`ButtonCustomization`	getButtonCustomization: (

ButtonType buttonType

ButtonType)

Gets button customization.

com.cardinalcommerce.shared.

userinterfaces.ButtonCustomization

getButtonCustomization(String buttonType)

Gets button customization.

com.cardinalcommerce.shared.

userinterfaces.LabelCustomization

getLabelCustomization()

Gets label customization.

com.cardinalcommerce.shared.

userinterfaces.TextBoxCustomization

getTextBoxCustomization()

Gets text box customization.

com.cardinalcommerce.shared.

userinterfaces.ToolbarCustomization

buttonType	Returns a ButtonCustomization object for a pre-defined list of button types.
`ButtonCustomization`	getButtonCustomizationFromString: (NSString *) buttonType	Returns a ButtonCustomization object for an implementer-specific button type.
`LabelCustomization`	getLabelCustomization	Returns a LabelCustomization object.
`TextBoxCustomization`	getTextBoxCustomization	Returns a TextBoxCustomization object.
`ToolbarCustomization`	getToolbarCustomization	Returns a ToolbarCustomization object.
`void`	setButtonCustomization

(ButtonCustomization buttonCustomization,ButtonType buttonType)Sets button customization

: (ButtonCustomization *) buttonCustomization

buttonType: (ButtonType) buttonType

Set the attributes of a ButtonCustomization object for a particular predefined button type.

void

setButtonCustomization

(ButtonCustomization buttonCustomization, java.lang.String buttonType)Sets button customization

: (ButtonCustomization *) buttonCustomization

buttonTypeString: (NSString *) buttonType

Set the attributes of a ButtonCustomization object for an implementer-specific button type.

void

setLabelCustomization: (

LabelCustomization labelCustomization

LabelCustomization *) labelCustomization

Sets

label customization

the attributes of a LabelCustomization object.
`void`	setTextBoxCustomization: (

TextBoxCustomization textBoxCustomization

TextBoxCustomization *) textBoxCustomization

Sets

text box customization

the attributes of a TextBoxCustomization object.
`void`	setToolbarCustomization: (

ToolbarCustomization toolbarCustomization

ToolbarCustomization *) toolbarCustomization

Sets

toolbar customization

the attributes of a ToolbarCustomization object.

`Customization`

Modifier and Properties	Type	Method and Description
`java.lang.String`	`getTextColor()` Gets text color.
`java.lang.String`	`getTextFontName()` Gets text font name.
`int`	`getTextFontSize()` Gets text font size.
`void`	`setTextColor(java.lang.String textColor)` Sets text color.
`void`	`setTextFontName(java.lang.String textFontName)` Sets text font name.
`void`	`setTextFontSize(int textFontSize)` Sets text font size.

`ButtonCustomization`

Methods inherited from Customization

getTextColor, getTextFontName, getTextFontSize, setTextColor, setTextFontName, setTextFontSizeModifier and TypeMethod and Descriptionjava.lang.StringgetBackgroundColor()

This method shall return the background color of the button

intgetCornerRadius()

The getCornerRadius method shall return the radius of the button corners.

voidsetBackgroundColor(java.lang.String hexColorCode)

Sets background color.

voidsetCornerRadius(int cornerRadius)

Sets corner radius.

`LabelCustomization`

Methods inherited from Customization
getTextColor, getTextFontName, getTextFontSize, setTextColor, setTextFontName, setTextFontSize
Modifier and Type	Method and Description
`java.lang.String`	`getHeadingTextColor()` Gets heading text color.
`java.lang.String`	`getHeadingTextFontName()` Gets heading text font name.
`int`	`getHeadingTextFontSize()` Gets heading text font size.
`void`	`setHeadingTextColor(java.lang.String hexColorCode)` set the background color
`void`	`setHeadingTextFontName(java.lang.String fontName)` set the font type of the heading label text
`void`	`setHeadingTextFontSize(int fontSize)`set the font size of textFontName	NSString	Font type for the UI element.
textColor	NSString	Color code in Hex format. For example, the color code can be “#999999”.
textFontSize	int	Font size for the UI element.

`ButtonCustomization`

Properties Inherited from Customization
textFontName, textColor, textFontSize

Properties	Type	Description
backgroundColor	NSString	Colour code in Hex format. For example, the color code can be “#999999”.
cornerRadius	int	Radius (integer value) for the button corners.

`LabelCustomization`

Properties Inherited from Customization
textFontName, textColor, textFontSize

Properties	Type	Description
headingTextColor	NSString	Colour code in Hex format. For example, the color code can be “#999999”.
headingTextFontName	NSString	Font type for the heading label text.
headingTextFontSize	int	Font size for the heading label text.

`TextBoxCustomization`

Methods inherited Properties Inherited from Customization
getTextColortextFontName, getTextFontName, getTextFontSize, setTextColor, setTextFontName, setTextFontSize
Modifier and Type	Method and Description
`java.lang.String`	`getBackgroundColor()` Gets background color.
`java.lang.String`	`getButtonText()` Gets button text.
`java.lang.String`	`getHeaderText()` Gets header text.
`void`	`setBackgroundColor(java.lang.String hexColorCode)` set the background color for the toolbar
`void`	`setButtonText(java.lang.String buttonText)` Sets button text.
`void`	`setHeaderText(java.lang.String headerText)` Sets header text.

`ToolbarCustomization`

Methods inherited from Customization

getTextColor, getTextFontName, getTextFontSize, setTextColor, setTextFontName, setTextFontSizeModifier and TypeMethod and Descriptionjava.lang.StringgetBorderColor()

Gets border color.

intgetBorderWidth()

Gets border width.

intgetCornerRadius()

Gets corner radius.

voidsetBorderColor(java.lang.String hexColorCode)

set the background color for the toolbar

voidsetBorderWidth(int borderWidth)

Sets border width.

voidsetCornerRadius(int cornerRadius)

Sets corner radius.

Sample Code

Code Block

language	java
title	Sample Code Java
collapse	true

//Verify Button Customization
ButtonCustomization verifyButton = new ButtonCustomization();
verifyButton.setTextColor("#ffffff");
verifyButton.setBackgroundColor("#5585a2");
verifyButton.setTextFontName("font/amaticsc.ttf");
verifyButton.setCornerRadius(1);
verifyButton.setTextFontSize(16);
//Resend Button Customization
ButtonCustomization resendButton = new ButtonCustomization();
resendButton.setTextColor("#ffffff");
resendButton.setBackgroundColor("#5585a2");
resendButton.setTextFontName("font/amaticsc.ttf");
resendButton.setCornerRadius(1);
resendButton.setTextFontSize(16);

//Toolbar Customization
ToolbarCustomization toolbarCustomization = new ToolbarCustomization();
toolbarCustomization.setBackgroundColor("#003759");
toolbarCustomization.setButtonText("CANCEL");
toolbarCustomization.setHeaderText("DEMO CHECKOUT");
toolbarCustomization.setTextColor("#ffffff");
toolbarCustomization.setTextFontName("font/amaticsc.ttf");
toolbarCustomization.setTextFontSize(20);

//Textbox Customization
TextBoxCustomization textBoxCustomization = new TextBoxCustomization();
textBoxCustomization.setBorderColor("#000000");
textBoxCustomization.setBorderWidth(5);
textBoxCustomization.setCornerRadius(1);
textBoxCustomization.setTextColor("#00ff2a");
textBoxCustomization.setTextFontName("font/amaticsc.ttf");
textBoxCustomization.setTextFontSize(25);

//Label Customization
LabelCustomization labelCustomization = new LabelCustomization();
labelCustomization.setHeadingTextColor("#660000");
labelCustomization.setHeadingTextFontName("font/amaticsc.ttf");
labelCustomization.setHeadingTextFontSize(35);
labelCustomization.setTextColor("#000000");
labelCustomization.setTextFontName("font/amaticsc.ttf");
labelCustomization.setTextFontSize(15);

uiCustomization.setButtonCustomization(verifyButton, ButtonType.VERIFY);
uiCustomization.setButtonCustomization(resendButton, ButtonType.RESEND);
uiCustomization.setToolbarCustomization(toolbarCustomization);
uiCustomization.setTextBoxCustomization(textBoxCustomization);
uiCustomization.setLabelCustomization(labelCustomization);

Code Block

language	java
title	Sample Code Kotlin
collapse	true

//Verify Button Customization
val verifyButton = ButtonCustomization()
verifyButton.textColor = "#ffffff"
verifyButton.backgroundColor = "#5585a2"
verifyButton.textFontName = "font/amaticsc.ttf"
verifyButton.cornerRadius = 1
verifyButton.textFontSize = 16

//Resend Button Customization
val resendButton = ButtonCustomization()
resendButton.textColor = "#ffffff"
resendButton.backgroundColor = "#5585a2"
resendButton.textFontName = "font/amaticsc.ttf"
resendButton.cornerRadius = 1
resendButton.textFontSize = 16

//Toolbar Customization
val toolbarCustomization = ToolbarCustomization()
toolbarCustomization.backgroundColor = "#003759"
toolbarCustomization.buttonText = "CANCEL"
toolbarCustomization.headerText = "DEMO CHECKOUT"
toolbarCustomization.textColor = "#ffffff"
toolbarCustomization.textFontName = "font/amaticsc.ttf"
toolbarCustomization.textFontSize = 20

//Textbox Customization
val textBoxCustomization = TextBoxCustomization()
textBoxCustomization.borderColor = "#000000"
textBoxCustomization.borderWidth = 5
textBoxCustomization.cornerRadius = 1
textBoxCustomization.textColor = "#00ff2a"
textBoxCustomization.textFontName = "font/amaticsc.ttf"
textBoxCustomization.textFontSize = 25

//Label Customization
val labelCustomization = LabelCustomization()
labelCustomization.headingTextColor = "#660000"
labelCustomization.headingTextFontName = "font/amaticsc.ttf"
labelCustomization.headingTextFontSize = 35
labelCustomization.textColor = "#000000"
labelCustomization.textFontName = "font/amaticsc.ttf"
labelCustomization.textFontSize = 15

uiCustomization.setButtonCustomization(verifyButton, ButtonType.VERIFY)
uiCustomization.setButtonCustomization(resendButton, ButtonType.RESEND)
uiCustomization.toolbarCustomization = toolbarCustomization
uiCustomization.textBoxCustomization = textBoxCustomization
uiCustomization.labelCustomization = labelCustomization

Note
Fonts have to be added to the application and the path should be provided in the UI customization

Sample Screenshots

Image Removed

Image Removed

textColor, textFontSize

Properties	Type	Description
borderWidth	int	Width (integer value) of the text box border.
borderColor	NSString	Colour code in Hex format. For example, the color code can be “#999999”.
cornerRadius	int	Radius (integer value) for the text box corners.

`ToolbarCustomization`

Properties Inherited from Customization
textFontName, textColor, textFontSize

Properties	Type	Description
backgroundColor	NSString	Colour code in Hex format. For example, the color code can be “#999999”.
headerText	NSString	Text for the header.
buttonText	NSString	Text for the button. For example, “Cancel”.

Sample Code

Code Block

language	c#
title	Objective-C Sample code
collapse	true

	UiCustomization *ui = [[UiCustomization alloc] init];
    
    ToolbarCustomization *toolbarCustomization = [[ToolbarCustomization alloc] init];
    [toolbarCustomization setHeaderText:@"My Secure Checkout"];
    [toolbarCustomization setBackgroundColor:@"#a5d6a7"];
    [toolbarCustomization setButtonText:@"Close"];
    [toolbarCustomization setTextColor:@"#222222"];
    [toolbarCustomization setTextFontSize:18];
    [toolbarCustomization setTextFontName:@"Noteworthy"];
    
    [ui setToolbarCustomization:toolbarCustomization];
    
    LabelCustomization *labelCustomization = [[LabelCustomization alloc] init];
    [labelCustomization setTextFontName:@"Noteworthy"];
    [labelCustomization setTextColor:@"#75a478"];
    [labelCustomization setTextFontSize:18];
    [labelCustomization setHeadingTextColor:@"#75a478"];
    [labelCustomization setHeadingTextFontName:@"Noteworthy"];
    [labelCustomization setHeadingTextFontSize:24];
    
    [ui setLabelCustomization:labelCustomization];
    
    ButtonCustomization *verifyCustomization = [[ButtonCustomization alloc] init];
    [verifyCustomization setBackgroundColor:@"#a5d6a7"];
    [verifyCustomization setCornerRadius:10];
    [verifyCustomization setTextFontName:@"Noteworthy"];
    [verifyCustomization setTextColor:@"#222222"];
    [verifyCustomization setTextFontSize:12];
    
    [ui setButtonCustomization:verifyCustomization buttonType:ButtonTypeVerify];
    
    ButtonCustomization *continueCustomization = [[ButtonCustomization alloc] init];
    [continueCustomization setBackgroundColor:@"#FF0000"];
    [continueCustomization setCornerRadius:10];
    [continueCustomization setTextFontName:@"Noteworthy"];
    [continueCustomization setTextColor:@"#FFFFFF"];
    [continueCustomization setTextFontSize:16];
    
    [ui setButtonCustomization:continueCustomization buttonType:ButtonTypeContinue];
    
    ButtonCustomization *resendCustomization = [[ButtonCustomization alloc] init];
    [resendCustomization setBackgroundColor:@"#d7ffd9"];
    [resendCustomization setCornerRadius:10];
    [resendCustomization setTextFontName:@"Noteworthy"];
    [resendCustomization setTextColor:@"#000000"];
    [resendCustomization setTextFontSize:12];
    
    [ui setButtonCustomization:resendCustomization buttonType:ButtonTypeResend];
    
    ButtonCustomization *cancelCustomization = [[ButtonCustomization alloc] init];
    [cancelCustomization setBackgroundColor:@"#d7ffd9"];
    [cancelCustomization setCornerRadius:4];
    [cancelCustomization setTextFontName:@"Noteworthy"];
    [cancelCustomization setTextColor:@"#222222"];
    [cancelCustomization setTextFontSize:16];
    
    [ui setButtonCustomization:cancelCustomization buttonType:ButtonTypeCancel];
    
    TextBoxCustomization *textboxCustomization = [[TextBoxCustomization alloc] init];
    [textboxCustomization setTextFontName:@"Noteworthy"];
    [textboxCustomization setTextColor:@"#a5d6a7"];
    [textboxCustomization setTextFontSize:12];
    [textboxCustomization setBorderWidth:2];
    [textboxCustomization setBorderColor:@"#a5d6a7"];
    [textboxCustomization setCornerRadius:4];
    
    [ui setTextBoxCustomization:textboxCustomization];
    
    cardinalConfig.uiCustomization = ui;

Code Block

language	c#
title	Swift Sample code
collapse	true

		let ui = UiCustomization()

        let toolbarCust = ToolbarCustomization()
        toolbarCust.headerText = "Cardinal Checkout"
        toolbarCust.textColor = "#ffffff"
        toolbarCust.backgroundColor = "#080269"
        toolbarCust.buttonText = "Cancel"
        toolbarCust.textFontSize = 18
        toolbarCust.textFontName = "Noteworthy"

        ui.setToolbar(toolbarCust)

        let labelCust = LabelCustomization()
        labelCust.textFontName = "Noteworthy"
        labelCust.textColor = "#75a478"
        labelCust.textFontSize = 18
        labelCust.headingTextColor = "#75a478"
        labelCust.headingTextFontName = "Noteworthy"
        labelCust.headingTextFontSize = 24

        ui.setLabel(labelCust)

        let verifyCustomization = ButtonCustomization()
        verifyCustomization.backgroundColor = "#a5d6a7"
        verifyCustomization.cornerRadius = 10
        verifyCustomization.textFontName = "Noteworthy"
        verifyCustomization.textColor = "#222222"
        verifyCustomization.textFontSize = 12

        ui.setButton(verifyCustomization, buttonType:ButtonTypeVerify)

        let continueCustomization = ButtonCustomization()
        continueCustomization.backgroundColor = "#FF0000"
        continueCustomization.cornerRadius = 10
        continueCustomization.textFontName = "Noteworthy"
        continueCustomization.textColor = "#FFFFFF"
        continueCustomization.textFontSize = 16

        ui.setButton(continueCustomization, buttonType:ButtonTypeContinue)

        let resendCustomization = ButtonCustomization()
        resendCustomization.backgroundColor = "#d7ffd9"
        resendCustomization.cornerRadius = 10
        resendCustomization.textFontName = "Noteworthy"
        resendCustomization.textColor = "#000000"
        resendCustomization.textFontSize = 12

        ui.setButton(resendCustomization, buttonType:ButtonTypeResend)

        let cancelCustomization = ButtonCustomization()
        cancelCustomization.backgroundColor = "#d7ffd9"
        cancelCustomization.cornerRadius = 4
        cancelCustomization.textFontName = "Noteworthy"
        cancelCustomization.textColor = "#222222"
        cancelCustomization.textFontSize = 16

        ui.setButton(cancelCustomization, buttonType:ButtonTypeCancel)

        let textboxCustomization = TextBoxCustomization()
        textboxCustomization.textFontName = "Noteworthy"
        textboxCustomization.textColor = "#a5d6a7"
        textboxCustomization.textFontSize = 12
        textboxCustomization.borderWidth = 2
        textboxCustomization.borderColor = "#a5d6a7"
        textboxCustomization.cornerRadius = 4

        ui.setTextBox(textboxCustomization)

        cardinalConfig.uiCustomization = ui

Sample Screenshots

Image AddedImage AddedImage Added

Table of Contents