Class CardBuilder

CardBuilder

Card オブジェクトのビルダー。

Methods

メソッド戻り値の型概要
addCardAction(cardAction)CardBuilderこのカードに CardAction を追加します。
addSection(section)CardBuilderこのカードにセクションを追加します。
build()Card現在のカードを作成して検証します。
setDisplayStyle(displayStyle)CardBuilderこのカードの表示スタイルを設定します。
setFixedFooter(fixedFooter)CardBuilderこのカードの固定フッターを設定します。
setHeader(cardHeader)CardBuilderこのカードのヘッダーを設定します。
setName(name)CardBuilderこのカードの名前を設定します。
setPeekCardHeader(peekCardHeader)CardBuilderピークカードのヘッダーを設定します。

詳細なドキュメント

addCardAction(cardAction)

このカードに CardAction を追加します。

パラメータ

名前説明
cardActionCardAction使用する CardAction

リターン

CardBuilder - このオブジェクト(チェーン用)。


addSection(section)

このカードにセクションを追加します。カードに追加できるセクションは 100 個までです。

パラメータ

名前説明
sectionCardSection使用する CardSection

リターン

CardBuilder - このオブジェクト(チェーン用)。


build()

現在のカードを作成して検証します。

リターン

Card - 検証済みのカード。

例外

Error - 作成されたカードが有効でない場合。


setDisplayStyle(displayStyle)

このカードの表示スタイルを設定します。

表示スタイルが DisplayStyle.REPLACE に設定されている場合、カードスタック内の一番上のカードのビューを置き換えることでカードが表示されます。

表示スタイルが DisplayStyle.PEEK に設定されている場合、カードのヘッダーはサイドバーの下部に表示され、スタックの現在の一番上のカードを部分的に覆います。ヘッダーをクリックすると、カードがカードスタックにポップされます。カードにヘッダーがない場合は、生成されたヘッダーが代わりに使用されます。

DisplayStyle は、コンテキスト トリガー関数から返されたカードに対してのみ機能します。

パラメータ

名前説明
displayStyleDisplayStyle設定する DisplayStyle

リターン

CardBuilder - このオブジェクト(チェーン用)。


setFixedFooter(fixedFooter)

このカードの固定フッターを設定します。

パラメータ

名前説明
fixedFooterFixedFooter使用する FixedFooter

リターン

CardBuilder - このオブジェクト(チェーン用)。


setHeader(cardHeader)

このカードのヘッダーを設定します。

パラメータ

名前説明
cardHeaderCardHeader使用する CardHeader

リターン

CardBuilder - このオブジェクト(チェーン用)。


setName(name)

このカードの名前を設定します。この名前は ナビゲーションに使用できます。

パラメータ

名前説明
nameString名前。

リターン

CardBuilder - このオブジェクト(チェーン用)。


setPeekCardHeader(peekCardHeader)

ピークカードのヘッダーを設定します。

ピークカードは、コンテキスト トリガー関数から返された最初のカードに設定されます。ユーザーがホームページのスタックからコンテキスト スタックに移動できるように、わかりやすいプレースホルダ ウィジェットとして使用されます。

パラメータ

名前説明
peekCardHeaderCardHeader設定する CardHeader

リターン

CardBuilder - このオブジェクト(チェーン用)。