1.12.0+1.0.31-sesl8+rev0

SESL Material/com.google.android.material.appbar/CollapsingToolbarLayout

CollapsingToolbarLayout

open class CollapsingToolbarLayout : FrameLayout

(SESL Variant) CollapsingToolbarLayout is a wrapper for Toolbar which implements a collapsing app bar. It is designed to be used as a direct child of a AppBarLayout. CollapsingToolbarLayout contains the following features:

Collapsing title A title which is larger when the layout is fully visible but collapses and becomes smaller as the layout is scrolled off screen. You can set the title to display via setTitle. The title appearance can be tweaked via the


collapsedTextAppearance

and expandedTextAppearance attributes. Content scrim A full-bleed scrim which is show or hidden when the scroll position has hit a certain threshold. You can change this via setContentScrim. Status bar scrim A scrim which is shown or hidden behind the status bar when the scroll position has hit a certain threshold. You can change this via setStatusBarScrim. This only works on LOLLIPOP devices when we set to fit system windows. Parallax scrolling children Child views can opt to be scrolled within this layout in a parallax fashion. See COLLAPSE_MODE_PARALLAX and setParallaxMultiplier. Pinned position children Child views can opt to be pinned in space globally. This is useful when implementing a collapsing as it allows the Toolbar to be fixed in place even though this layout is moving. See COLLAPSE_MODE_PIN.

Do not manually add views to the Toolbar at run time. We will add a 'dummy view' to the Toolbar which allows us to work out the available space for the title. This can interfere with any views which you add.

For more information, see the component developer guidance and design guidelines.

Constructors

CollapsingToolbarLayout

constructor(@NonNull context: Context)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

Types

open class LayoutParams : FrameLayout.LayoutParams

StaticLayoutBuilderConfigurer

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

interface StaticLayoutBuilderConfigurer : StaticLayoutBuilderConfigurer

Interface that allows for further customization of the provided .

TitleCollapseMode

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class TitleCollapseMode

Properties

open var contentScrim: Drawable

scrimAnimationDuration

open var scrimAnimationDuration: Long

scrimVisibleHeightTrigger

open var scrimVisibleHeightTrigger: Int

open var statusBarScrim: Drawable

TITLE_COLLAPSE_MODE_FADE

val TITLE_COLLAPSE_MODE_FADE: Int = 1

The expanded title will fade out and translate, and the collapsed title will fade in.

TITLE_COLLAPSE_MODE_SCALE

val TITLE_COLLAPSE_MODE_SCALE: Int = 0

The expanded title will continuously scale and translate to its final collapsed position.

titleCollapseMode

open var titleCollapseMode: Int

Functions

open fun addView(child: View, params: ViewGroup.LayoutParams)

open fun draw(@NonNull canvas: Canvas)

generateLayoutParams

open fun generateLayoutParams(attrs: AttributeSet): FrameLayout.LayoutParams

getCollapsedTitleGravity

open fun getCollapsedTitleGravity(): Int

Returns the horizontal and vertical alignment for title when collapsed.

getCollapsedTitleTextSize

open fun getCollapsedTitleTextSize(): Float

Returns the text size of the collapsed title.

getCollapsedTitleTypeface

open fun getCollapsedTitleTypeface(): Typeface

Returns the typeface used for the collapsed title.

getExpandedTitleGravity

open fun getExpandedTitleGravity(): Int

Returns the horizontal and vertical alignment for title when expanded.

getExpandedTitleMarginBottom

open fun getExpandedTitleMarginBottom(): Int

getExpandedTitleMarginEnd

open fun getExpandedTitleMarginEnd(): Int

getExpandedTitleMarginStart

open fun getExpandedTitleMarginStart(): Int

getExpandedTitleMarginTop

open fun getExpandedTitleMarginTop(): Int

getExpandedTitleTextSize

open fun getExpandedTitleTextSize(): Float

Returns the text size of the expanded title.

getExpandedTitleTypeface

open fun getExpandedTitleTypeface(): Typeface

Returns the typeface used for the expanded title.

getHyphenationFrequency

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun getHyphenationFrequency(): Int

Gets the hyphenation frequency of the title text, or -1 if not set.

@RestrictTo(value = LIBRARY_GROUP)

open fun getLineCount(): Int

Gets the current number of lines of the title text.

getLineSpacingAdd

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun getLineSpacingAdd(): Float

Gets the line spacing addition of the title text, or -1 if not set.

getLineSpacingMultiplier

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun getLineSpacingMultiplier(): Float

Gets the line spacing multiplier of the title text, or -1 if not set.

@RestrictTo(value = LIBRARY_GROUP)

open fun getMaxLines(): Int

Gets the maximum number of lines to display in the expanded state.

open fun getSubTitle(): CharSequence

Returns the subtitle of this view when expanded.

open fun getTitle(): CharSequence

Returns the title currently being displayed by this view.

getTitlePositionInterpolator

open fun getTitlePositionInterpolator(): TimeInterpolator

Returns the interpolator being used to animate the title position from collapsed to expanded and vice versa.

getTitleTextEllipsize

open fun getTitleTextEllipsize(): TextUtils.TruncateAt

Get ellipsizing currently applied on the title text.

isExtraMultilineHeightEnabled

@RestrictTo(value = LIBRARY_GROUP)

open fun isExtraMultilineHeightEnabled(): Boolean

Gets whether extra height should be added when the title text spans across multiple lines.

isForceApplySystemWindowInsetTop

@RestrictTo(value = LIBRARY_GROUP)

open fun isForceApplySystemWindowInsetTop(): Boolean

Gets whether the top system window inset should be respected regardless of what the layout_height of the CollapsingToolbarLayout is set to.

isRtlTextDirectionHeuristicsEnabled

@RestrictTo(value = LIBRARY_GROUP)

open fun isRtlTextDirectionHeuristicsEnabled(): Boolean

Gets whether TextDirectionHeuristics should be used to determine whether the title text is RTL.

open fun isTitleEnabled(): Boolean

Returns whether this view is currently displaying its own title.

seslEnableFadeToolbarTitle

open fun seslEnableFadeToolbarTitle(enabled: Boolean)

Sets whether to enable or disable the fade effect of the collapsed title.

seslGetCustomSubtitle

open fun seslGetCustomSubtitle(): View

Retrieves the custom subtitle view.

seslGetMinimumHeightWithoutMargin

open fun seslGetMinimumHeightWithoutMargin(): Int

This method differs from getMinimumHeight in that it subtracts the top and bottom margins of the toolbar.

seslIsCustomAccessibility

open fun seslIsCustomAccessibility(): Boolean

Returns whether this field uses custom accessibility.

seslSetCustomSubtitle

open fun seslSetCustomSubtitle(view: View)

Sets a custom view to replace the expanded subtitle.

seslSetCustomTitleView

open fun seslSetCustomTitleView(view: View, params: CollapsingToolbarLayout.LayoutParams)

Sets a custom view to replace the expanded title.

seslSetSubtitle

open fun seslSetSubtitle(@StringRes resId: Int)

open fun seslSetSubtitle(subtitle: CharSequence)

Sets the subtitle of this view.

seslSetSuggestView

open fun seslSetSuggestView(@Nullable appBarModel: AppBarModel<out AppBarView>)

Sets the suggestion view for the AppBarLayout.

seslSetUseCustomAccessibility

open fun seslSetUseCustomAccessibility(enabled: Boolean)

Sets whether to use custom accessibility features.

setCollapsedTitleGravity

open fun setCollapsedTitleGravity(gravity: Int)

Sets the horizontal alignment of the collapsed title and the vertical gravity that will be used when there is extra space in the collapsed bounds beyond what is required for the title itself.

setCollapsedTitleTextAppearance

open fun setCollapsedTitleTextAppearance(@StyleRes resId: Int)

Sets the text color and size for the collapsed title from the specified TextAppearance resource.

setCollapsedTitleTextColor

open fun setCollapsedTitleTextColor(@NonNull colors: ColorStateList)

Sets the text colors of the collapsed title.

open fun setCollapsedTitleTextColor(@ColorInt color: Int)

Sets the text color of the collapsed title.

setCollapsedTitleTextSize

open fun setCollapsedTitleTextSize(textSize: Float)

Sets the text size of the collapsed title.

setCollapsedTitleTypeface

open fun setCollapsedTitleTypeface(@Nullable typeface: Typeface)

Set the typeface to use for the collapsed title.

setContentScrimColor

open fun setContentScrimColor(@ColorInt color: Int)

Set the color to use for the content scrim.

setContentScrimResource

open fun setContentScrimResource(@DrawableRes resId: Int)

Set the drawable to use for the content scrim from resources.

setExpandedTitleColor

open fun setExpandedTitleColor(@ColorInt color: Int)

Sets the text color of the expanded title.

setExpandedTitleGravity

open fun setExpandedTitleGravity(gravity: Int)

Sets the horizontal alignment of the expanded title and the vertical gravity that will be used when there is extra space in the expanded bounds beyond what is required for the title itself.

setExpandedTitleMargin

open fun setExpandedTitleMargin(start: Int, top: Int, end: Int, bottom: Int)

Sets the expanded title margins.

setExpandedTitleMarginBottom

open fun setExpandedTitleMarginBottom(margin: Int)

Sets the bottom expanded title margin in pixels.

setExpandedTitleMarginEnd

open fun setExpandedTitleMarginEnd(margin: Int)

Sets the ending expanded title margin in pixels.

setExpandedTitleMarginStart

open fun setExpandedTitleMarginStart(margin: Int)

Sets the starting expanded title margin in pixels.

setExpandedTitleMarginTop

open fun setExpandedTitleMarginTop(margin: Int)

Sets the top expanded title margin in pixels.

setExpandedTitleTextAppearance

open fun setExpandedTitleTextAppearance(@StyleRes resId: Int)

Sets the text color and size for the expanded title from the specified TextAppearance resource.

setExpandedTitleTextColor

open fun setExpandedTitleTextColor(@NonNull colors: ColorStateList)

Sets the text colors of the expanded title.

setExpandedTitleTextSize

open fun setExpandedTitleTextSize(textSize: Float)

Sets the text size of the expanded title.

setExpandedTitleTypeface

open fun setExpandedTitleTypeface(@Nullable typeface: Typeface)

Set the typeface to use for the expanded title.

setExtraMultilineHeightEnabled

@RestrictTo(value = LIBRARY_GROUP)

open fun setExtraMultilineHeightEnabled(extraMultilineHeightEnabled: Boolean)

Sets whether extra height should be added when the title text spans across multiple lines.

setForceApplySystemWindowInsetTop

@RestrictTo(value = LIBRARY_GROUP)

open fun setForceApplySystemWindowInsetTop(forceApplySystemWindowInsetTop: Boolean)

Sets whether the top system window inset should be respected regardless of what the layout_height of the CollapsingToolbarLayout is set to.

setHyphenationFrequency

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun setHyphenationFrequency(hyphenationFrequency: Int)

Sets the hyphenation frequency of the title text.

setLineSpacingAdd

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun setLineSpacingAdd(spacingAdd: Float)

Sets the line spacing addition of the title text.

setLineSpacingMultiplier

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun setLineSpacingMultiplier(@FloatRange(from = 0.0) spacingMultiplier: Float)

Sets the line spacing multiplier of the title text.

@RestrictTo(value = LIBRARY_GROUP)

open fun setMaxLines(maxLines: Int)

Sets the maximum number of lines to display in the expanded state.

setRtlTextDirectionHeuristicsEnabled

@RestrictTo(value = LIBRARY_GROUP)

open fun setRtlTextDirectionHeuristicsEnabled(rtlTextDirectionHeuristicsEnabled: Boolean)

Sets whether TextDirectionHeuristics should be used to determine whether the title text is RTL.

open fun setScrimsShown(shown: Boolean)

open fun setScrimsShown(shown: Boolean, animate: Boolean)

Set whether the content scrim and/or status bar scrim should be shown or not.

setStaticLayoutBuilderConfigurer

@RestrictTo(value = LIBRARY_GROUP)

@RequiresApi(value = VERSION_CODES.M)

open fun setStaticLayoutBuilderConfigurer(@Nullable staticLayoutBuilderConfigurer: CollapsingToolbarLayout.StaticLayoutBuilderConfigurer)

Sets the StaticLayoutBuilderConfigurer for the android.text.StaticLayout of the title text.

setStatusBarScrimColor

open fun setStatusBarScrimColor(@ColorInt color: Int)

Set the color to use for the status bar scrim.

setStatusBarScrimResource

open fun setStatusBarScrimResource(@DrawableRes resId: Int)

Set the drawable to use for the status bar scrim from resources.

open fun setTitle(@Nullable title: CharSequence)

Sets the title to be displayed by this view, if enabled.

setTitleEllipsize

open fun setTitleEllipsize(@NonNull ellipsize: TextUtils.TruncateAt)

Set ellipsizing on the title text.

setTitleEnabled

open fun setTitleEnabled(enabled: Boolean)

Sets whether this view should display its own title.

setTitlePositionInterpolator

open fun setTitlePositionInterpolator(@Nullable interpolator: TimeInterpolator)

Sets the interpolator to use when animating the title position from collapsed to expanded and vice versa.

open fun setVisibility(visibility: Int)