Package com.hellosign.sdk.resource.support

Class WhiteLabelingOptions

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.support.WhiteLabelingOptions

public class WhiteLabelingOptions
extends AbstractResource

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LEGAL_VERSION_1
static java.lang.String	LEGAL_VERSION_2
static java.lang.String	WHITE_LABELING_OPTIONS_HEADER_BACKGROUND_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_KEY
static java.lang.String	WHITE_LABELING_OPTIONS_LEGAL_VERSION
static java.lang.String	WHITE_LABELING_OPTIONS_LINK_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_PAGE_BACKGROUND_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_COLOR_HOVER
static java.lang.String	WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_TEXT_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_TEXT_COLOR_HOVER
static java.lang.String	WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_COLOR_HOVER
static java.lang.String	WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_TEXT_COLOR
static java.lang.String	WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_TEXT_COLOR_HOVER
static java.lang.String	WHITE_LABELING_OPTIONS_TEXT_COLOR_1
static java.lang.String	WHITE_LABELING_OPTIONS_TEXT_COLOR_2

Fields inherited from class com.hellosign.sdk.resource.AbstractResource

dataObj, warnings

Constructor Summary

Constructors

Constructor	Description
WhiteLabelingOptions()
WhiteLabelingOptions(org.json.JSONObject json)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHeaderBackgroundColor()	Get the signer page header background color.
java.lang.String	getLinkColor()	Get the signer page link color.
java.lang.String	getPageBackgroundColor()	Get the signer page background color.
java.lang.String	getPrimaryButtonColor()	Get the signer page primary button color.
java.lang.String	getPrimaryButtonHoverColor()	Get the signer page primary button hover color.
java.lang.String	getPrimaryButtonTextColor()	Get the signer page primary button text color.
java.lang.String	getPrimaryButtonTextHoverColor()	Get the signer page primary button text hover color.
java.lang.String	getSecondaryButtonColor()	Get the signer page secondary button color.
java.lang.String	getSecondaryButtonHoverColor()	Get the signer page secondary button hover color.
java.lang.String	getSecondaryButtonTextColor()	Get the signer page secondary button text color.
java.lang.String	getSecondaryButtonTextHoverColor()	Get the signer page secondary button text hover color.
java.lang.String	getTextColor1()	Get the signer page text 1 color.
java.lang.String	getTextColor2()	Get the signer page text 2 color.
void	setHeaderBackgroundColor(java.lang.String color)	Set the signer page header background color.
void	setLegalVersion(java.lang.String version)	Set the legal terms version.
void	setLinkColor(java.lang.String color)	Set the signer page link color.
void	setPageBackgroundColor(java.lang.String color)	Set the signer page background color.
void	setPrimaryButtonColor(java.lang.String color)	Set the signer page primary button color.
void	setPrimaryButtonHoverColor(java.lang.String color)	Set the signer page primary button hover color.
void	setPrimaryButtonTextColor(java.lang.String color)	Set the signer page primary button text color.
void	setPrimaryButtonTextHoverColor(java.lang.String color)	Set the signer page primary button text hover color.
void	setSecondaryButtonColor(java.lang.String color)	Set the signer page secondary button color.
void	setSecondaryButtonHoverColor(java.lang.String color)	Set the signer page secondary button hover color.
void	setSecondaryButtonTextColor(java.lang.String color)	Set the signer page secondary button text color.
void	setSecondaryButtonTextHoverColor(java.lang.String color)	Set the signer page secondary button text hover color.
void	setTextColor1(java.lang.String color)	Set the signer page text 1 color.
void	setTextColor2(java.lang.String color)	Set the signer page text 2 color.
boolean	validateColor(java.lang.String hex)	Validate hex with regular expression

Methods inherited from class com.hellosign.sdk.resource.AbstractResource

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getObject, getString, getWarnings, has, hasString, set, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

WHITE_LABELING_OPTIONS_KEY

public static final java.lang.String WHITE_LABELING_OPTIONS_KEY

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_PAGE_BACKGROUND_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_PAGE_BACKGROUND_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_HEADER_BACKGROUND_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_HEADER_BACKGROUND_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_TEXT_COLOR_1

public static final java.lang.String WHITE_LABELING_OPTIONS_TEXT_COLOR_1

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_TEXT_COLOR_2

public static final java.lang.String WHITE_LABELING_OPTIONS_TEXT_COLOR_2

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_LINK_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_LINK_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_TEXT_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_TEXT_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_COLOR_HOVER

public static final java.lang.String WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_COLOR_HOVER

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_TEXT_COLOR_HOVER

public static final java.lang.String WHITE_LABELING_OPTIONS_PRIMARY_BUTTON_TEXT_COLOR_HOVER

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_TEXT_COLOR

public static final java.lang.String WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_TEXT_COLOR

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_COLOR_HOVER

public static final java.lang.String WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_COLOR_HOVER

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_TEXT_COLOR_HOVER

public static final java.lang.String WHITE_LABELING_OPTIONS_SECONDARY_BUTTON_TEXT_COLOR_HOVER

See Also:

Constant Field Values

WHITE_LABELING_OPTIONS_LEGAL_VERSION

public static final java.lang.String WHITE_LABELING_OPTIONS_LEGAL_VERSION

See Also:

Constant Field Values

LEGAL_VERSION_1

public static final java.lang.String LEGAL_VERSION_1

See Also:

Constant Field Values

LEGAL_VERSION_2

public static final java.lang.String LEGAL_VERSION_2

See Also:

Constant Field Values

Constructor Detail

WhiteLabelingOptions

public WhiteLabelingOptions()

WhiteLabelingOptions

public WhiteLabelingOptions(org.json.JSONObject json)
                     throws HelloSignException

Throws:

HelloSignException

Method Detail

validateColor

public boolean validateColor(java.lang.String hex)

Validate hex with regular expression

Parameters:

hex - string for validation

Returns:

true valid hex, false invalid hex

getPageBackgroundColor

public java.lang.String getPageBackgroundColor()

Get the signer page background color.

Returns:

String hex color code

setPageBackgroundColor

public void setPageBackgroundColor(java.lang.String color)
                            throws HelloSignException

Set the signer page background color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getHeaderBackgroundColor

public java.lang.String getHeaderBackgroundColor()

Get the signer page header background color.

Returns:

String hex color code

setHeaderBackgroundColor

public void setHeaderBackgroundColor(java.lang.String color)
                              throws HelloSignException

Set the signer page header background color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getTextColor1

public java.lang.String getTextColor1()

Get the signer page text 1 color.

Returns:

String hex color code

setTextColor1

public void setTextColor1(java.lang.String color)
                   throws HelloSignException

Set the signer page text 1 color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getTextColor2

public java.lang.String getTextColor2()

Get the signer page text 2 color.

Returns:

String hex color code

setTextColor2

public void setTextColor2(java.lang.String color)
                   throws HelloSignException

Set the signer page text 2 color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getLinkColor

public java.lang.String getLinkColor()

Get the signer page link color.

Returns:

String hex color code

setLinkColor

public void setLinkColor(java.lang.String color)
                  throws HelloSignException

Set the signer page link color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getPrimaryButtonColor

public java.lang.String getPrimaryButtonColor()

Get the signer page primary button color.

Returns:

String hex color code

setPrimaryButtonColor

public void setPrimaryButtonColor(java.lang.String color)
                           throws HelloSignException

Set the signer page primary button color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getPrimaryButtonTextColor

public java.lang.String getPrimaryButtonTextColor()

Get the signer page primary button text color.

Returns:

String hex color code

setPrimaryButtonTextColor

public void setPrimaryButtonTextColor(java.lang.String color)
                               throws HelloSignException

Set the signer page primary button text color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getPrimaryButtonHoverColor

public java.lang.String getPrimaryButtonHoverColor()

Get the signer page primary button hover color.

Returns:

String hex color code

setPrimaryButtonHoverColor

public void setPrimaryButtonHoverColor(java.lang.String color)
                                throws HelloSignException

Set the signer page primary button hover color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getPrimaryButtonTextHoverColor

public java.lang.String getPrimaryButtonTextHoverColor()

Get the signer page primary button text hover color.

Returns:

String hex color code

setPrimaryButtonTextHoverColor

public void setPrimaryButtonTextHoverColor(java.lang.String color)
                                    throws HelloSignException

Set the signer page primary button text hover color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getSecondaryButtonColor

public java.lang.String getSecondaryButtonColor()

Get the signer page secondary button color.

Returns:

String hex color code

setSecondaryButtonColor

public void setSecondaryButtonColor(java.lang.String color)
                             throws HelloSignException

Set the signer page secondary button color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getSecondaryButtonTextColor

public java.lang.String getSecondaryButtonTextColor()

Get the signer page secondary button text color.

Returns:

String hex color code

setSecondaryButtonTextColor

public void setSecondaryButtonTextColor(java.lang.String color)
                                 throws HelloSignException

Set the signer page secondary button text color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getSecondaryButtonHoverColor

public java.lang.String getSecondaryButtonHoverColor()

Get the signer page secondary button hover color.

Returns:

String hex color code

setSecondaryButtonHoverColor

public void setSecondaryButtonHoverColor(java.lang.String color)
                                  throws HelloSignException

Set the signer page secondary button hover color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

getSecondaryButtonTextHoverColor

public java.lang.String getSecondaryButtonTextHoverColor()

Get the signer page secondary button text hover color.

Returns:

String hex color code

setSecondaryButtonTextHoverColor

public void setSecondaryButtonTextHoverColor(java.lang.String color)
                                      throws HelloSignException

Set the signer page secondary button text hover color.

Parameters:

color - String hex color code

Throws:

HelloSignException - thrown if the color string is an invalid hex string

setLegalVersion

public void setLegalVersion(java.lang.String version)

Set the legal terms version.

Parameters:

version - String use constants LEGAL_VERSION_1 or LEGAL_VERSION_2