org.asciidoctor.gradle.model5.core.pdfthemes

Interface PdfTheme

All Superinterfaces:

org.gradle.api.Named

public interface PdfTheme
extends org.gradle.api.Named

PDF theme declaration.

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

org.gradle.api.Named.Namer

Method Summary

Modifier and Type	Method and Description
void	fromCollection(org.gradle.api.provider.Provider<PdfThemeCollection> collection) Extract the theme from the theme collection.
void	fromCollection(java.lang.String collectionName) Extract the theme from the named theme collection
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getThemeDir() Provider to where the theme is located.
org.gradle.api.provider.Provider<java.lang.String>	getThemeName() The theme name.
void	setThemeName(java.lang.Object name) Override the name of the theme as described by getThemeName().

Methods inherited from interface org.gradle.api.Named

getName

Method Detail

fromCollection

void fromCollection(org.gradle.api.provider.Provider<PdfThemeCollection> collection)

Extract the theme from the theme collection.

Parameters:

collection - The theme collection.

fromCollection

void fromCollection(java.lang.String collectionName)

Extract the theme from the named theme collection

Parameters:

collectionName - The name of the theme collection.

getThemeDir

org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getThemeDir()

Provider to where the theme is located.

Returns:

Provider to a Directory. If the provider is empty it indicates a built-in theme.

getThemeName

org.gradle.api.provider.Provider<java.lang.String> getThemeName()

The theme name.

By default, this is the name under which the theme was registered, but the location may contain more than one theme, and if so, the specific theme name can be set here.

Returns:

Provider to a theme name.

setThemeName

void setThemeName(java.lang.Object name)

Override the name of the theme as described by getThemeName().

Parameters:

name - Anything convertible to a string.