CeremonyLayoutSettingsBuilder (sdk 11.50 API)

java.lang.Object
- com.silanis.esl.sdk.builder.CeremonyLayoutSettingsBuilder

```
public class CeremonyLayoutSettingsBuilder
extends Object
```
Builder object used to customize the signing ceremony page's look-and-feel.
This object allows to customize whether or not certain visual elements should be presented and how they should be presented.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CeremonyLayoutSettings`	`build()` Builds the actual ceremony layout settings.
`static CeremonyLayoutSettingsBuilder`	`newCeremonyLayoutSettings()` Creates a new ceremony layout settings builder.
`CeremonyLayoutSettingsBuilder`	`withBreadCrumbs()` Enables displaying the Bread Crumb navigation UI element.
`CeremonyLayoutSettingsBuilder`	`withGlobalConfirmButton()` Enables displaying the Confirm button element within the Global Actions UI element.
`CeremonyLayoutSettingsBuilder`	`withGlobalDownloadButton()` Enables displaying the Download button element within the Global Actions UI element.
`CeremonyLayoutSettingsBuilder`	`withGlobalNavigation()` Enables displaying the Global Navigation menu.
`CeremonyLayoutSettingsBuilder`	`withGlobalSaveAsLayoutButton()` Enables displaying the Save Layout button element within the Global Actions UI element.
`CeremonyLayoutSettingsBuilder`	`withLogoLink(String logoImageLink)` Replaces the default ESL logo with a custom logo.
`CeremonyLayoutSettingsBuilder`	`withLogoSource(String logoImageSource)` Replaces the default ESL logo with a custom logo.
`CeremonyLayoutSettingsBuilder`	`withNavigator()` Enables displaying the Navigator, which directs the signer to the next available signature.
`CeremonyLayoutSettingsBuilder`	`withoutBreadCrumbs()` Disables displaying the Bread Crumb UI element.
`CeremonyLayoutSettingsBuilder`	`withoutGlobalConfirmButton()` Disables displaying the Confirm button element within the Global Actions UI element.
`CeremonyLayoutSettingsBuilder`	`withoutGlobalDownloadButton()` Disables displaying the Download button element within the Global Actions UI element.
`CeremonyLayoutSettingsBuilder`	`withoutGlobalNavigation()` Disables displaying the Global Navigation menu.
`CeremonyLayoutSettingsBuilder`	`withoutGlobalSaveAsLayoutButton()` Disables displaying the Save Layout button element within the Global Actions UI element.
`CeremonyLayoutSettingsBuilder`	`withoutNavigator()` Disables displaying the Navigator UI controls.
`CeremonyLayoutSettingsBuilder`	`withoutProgressBar()` Disables displaying the package Title UI element.
`CeremonyLayoutSettingsBuilder`	`withoutSessionBar()` Disables displaying the Session Bar navigation UI element.
`CeremonyLayoutSettingsBuilder`	`withoutTitle()` Disables displaying the package Title UI element.
`CeremonyLayoutSettingsBuilder`	`withProgressBar()` Enables displaying the Progress Bar indicator UI element.
`CeremonyLayoutSettingsBuilder`	`withSessionBar()` Enables displaying the Session Bar navigation UI element.
`CeremonyLayoutSettingsBuilder`	`withTitle()` Enables displaying the package Title UI element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newCeremonyLayoutSettings
```
public static CeremonyLayoutSettingsBuilder newCeremonyLayoutSettings()
```
    Creates a new ceremony layout settings builder.
    
    Returns:
    
    This
  - withNavigator
```
public CeremonyLayoutSettingsBuilder withNavigator()
```
    Enables displaying the Navigator, which directs the signer to the next available signature.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutNavigator
```
public CeremonyLayoutSettingsBuilder withoutNavigator()
```
    Disables displaying the Navigator UI controls.
    
    Returns:
    
    This
    
    See Also:
    
    withNavigator()
  - withGlobalNavigation
```
public CeremonyLayoutSettingsBuilder withGlobalNavigation()
```
    Enables displaying the Global Navigation menu.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutGlobalNavigation
```
public CeremonyLayoutSettingsBuilder withoutGlobalNavigation()
```
    Disables displaying the Global Navigation menu.
    
    Returns:
    
    This
    
    See Also:
    
    withGlobalNavigation()
  - withBreadCrumbs
```
public CeremonyLayoutSettingsBuilder withBreadCrumbs()
```
    Enables displaying the Bread Crumb navigation UI element.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutBreadCrumbs
```
public CeremonyLayoutSettingsBuilder withoutBreadCrumbs()
```
    Disables displaying the Bread Crumb UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withBreadCrumbs()
  - withSessionBar
```
public CeremonyLayoutSettingsBuilder withSessionBar()
```
    Enables displaying the Session Bar navigation UI element.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutSessionBar
```
public CeremonyLayoutSettingsBuilder withoutSessionBar()
```
    Disables displaying the Session Bar navigation UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withSessionBar()
  - withTitle
```
public CeremonyLayoutSettingsBuilder withTitle()
```
    Enables displaying the package Title UI element.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutTitle
```
public CeremonyLayoutSettingsBuilder withoutTitle()
```
    Disables displaying the package Title UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withTitle()
  - withProgressBar
```
public CeremonyLayoutSettingsBuilder withProgressBar()
```
    Enables displaying the Progress Bar indicator UI element.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutProgressBar
```
public CeremonyLayoutSettingsBuilder withoutProgressBar()
```
    Disables displaying the package Title UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withProgressBar()
  - withLogoLink
```
public CeremonyLayoutSettingsBuilder withLogoLink(String logoImageLink)
```
    Replaces the default ESL logo with a custom logo.
    Requires ESL support to change to custom logo. Please contact support.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withLogoSource
```
public CeremonyLayoutSettingsBuilder withLogoSource(String logoImageSource)
```
    Replaces the default ESL logo with a custom logo.
    Requires ESL support to change to custom logo. Please contact support.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withGlobalConfirmButton
```
public CeremonyLayoutSettingsBuilder withGlobalConfirmButton()
```
    Enables displaying the Confirm button element within the Global Actions UI element.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withoutGlobalConfirmButton
```
public CeremonyLayoutSettingsBuilder withoutGlobalConfirmButton()
```
    Disables displaying the Confirm button element within the Global Actions UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withGlobalConfirmButton()
  - withGlobalSaveAsLayoutButton
```
public CeremonyLayoutSettingsBuilder withGlobalSaveAsLayoutButton()
```
    Enables displaying the Save Layout button element within the Global Actions UI element.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutGlobalSaveAsLayoutButton
```
public CeremonyLayoutSettingsBuilder withoutGlobalSaveAsLayoutButton()
```
    Disables displaying the Save Layout button element within the Global Actions UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withGlobalSaveAsLayoutButton()
  - withGlobalDownloadButton
```
public CeremonyLayoutSettingsBuilder withGlobalDownloadButton()
```
    Enables displaying the Download button element within the Global Actions UI element.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withoutGlobalDownloadButton
```
public CeremonyLayoutSettingsBuilder withoutGlobalDownloadButton()
```
    Disables displaying the Download button element within the Global Actions UI element.
    
    Returns:
    
    This
    
    See Also:
    
    withGlobalDownloadButton()
  - build
```
public CeremonyLayoutSettings build()
```
    Builds the actual ceremony layout settings.
    
    Returns:
    
    the ceremony settings

Class CeremonyLayoutSettingsBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newCeremonyLayoutSettings

withNavigator

withoutNavigator

withGlobalNavigation

withoutGlobalNavigation

withBreadCrumbs

withoutBreadCrumbs

withSessionBar

withoutSessionBar

withTitle

withoutTitle

withProgressBar

withoutProgressBar

withLogoLink

withLogoSource

withGlobalConfirmButton

withoutGlobalConfirmButton

withGlobalSaveAsLayoutButton

withoutGlobalSaveAsLayoutButton

withGlobalDownloadButton

withoutGlobalDownloadButton

build