FreeformTemplateData

class FreeformTemplateData

The semantic data required to build Freeform Template layouts

Summary

Public constructors
FreeformTemplateData(
    backgroundColor: ColorProvider,
    headerIcon: TemplateImageWithDescription,
    actionIcon: TemplateImageButton?,
    header: TemplateText?,
    title: TemplateText?,
    subtitle: TemplateText?,
    backgroundImage: ImageProvider?
)

Public functions
open operator Boolean
equals(other: Any?)
open Int

Public properties
TemplateImageButton?

Action icon button
ColorProvider

Glanceable background color
ImageProvider?

Background image, if set replaces the glanceable background
TemplateText?

Main header text
TemplateImageWithDescription

Logo icon, displayed in the glanceable header
TemplateText?

Text section subtitle, priority ordered
TemplateText?

Text section main title, priority ordered

Public constructors

FreeformTemplateData

Added in 1.0.0-alpha06
FreeformTemplateData(
    backgroundColor: ColorProvider,
    headerIcon: TemplateImageWithDescription,
    actionIcon: TemplateImageButton?,
    header: TemplateText? = null,
    title: TemplateText? = null,
    subtitle: TemplateText? = null,
    backgroundImage: ImageProvider? = null
)
Parameters
backgroundColor: ColorProvider

Glanceable background color
headerIcon: TemplateImageWithDescription

Logo icon, displayed in the glanceable header
actionIcon: TemplateImageButton?

Action icon button
header: TemplateText? = null

Main header text
title: TemplateText? = null

Text section main title, priority ordered
subtitle: TemplateText? = null

Text section subtitle, priority ordered
backgroundImage: ImageProvider? = null

Background image, if set replaces the glanceable background

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

actionIcon

Added in 1.0.0-alpha06
val actionIcon: TemplateImageButton?

Action icon button

backgroundColor

Added in 1.0.0-alpha06
val backgroundColor: ColorProvider

Glanceable background color

backgroundImage

Added in 1.0.0-alpha06
val backgroundImage: ImageProvider?

Background image, if set replaces the glanceable background

header

Added in 1.0.0-alpha06
val header: TemplateText?

Main header text

headerIcon

Added in 1.0.0-alpha06
val headerIcon: TemplateImageWithDescription

Logo icon, displayed in the glanceable header

subtitle

Added in 1.0.0-alpha06
val subtitle: TemplateText?

Text section subtitle, priority ordered

title

Added in 1.0.0-alpha06
val title: TemplateText?

Text section main title, priority ordered