Class CardBuilder

CardBuilder

Ein Builder für Card-Objekte.

Methoden

MethodeRückgabetypKurzbeschreibung
addCardAction(cardAction)CardBuilderFügt dieser Karte eine CardAction hinzu.
addExpressionData(expressionData)CardBuilderFügt dieser Karte Ausdrucksdaten hinzu.
addSection(section)CardBuilderFügt dieser Karte einen Abschnitt hinzu.
build()CardErstellt die aktuelle Karte und validiert sie.
setDisplayStyle(displayStyle)CardBuilderLegt den Anzeigestil für diese Karte fest.
setFixedFooter(fixedFooter)CardBuilderLegt eine feste Fußzeile für diese Karte fest.
setHeader(cardHeader)CardBuilderLegt den Header für diese Karte fest.
setName(name)CardBuilderLegt den Namen für diese Karte fest.
setPeekCardHeader(peekCardHeader)CardBuilderLegt die Kopfzeile der Übersichtskarte fest.

Detaillierte Dokumentation

addCardAction(cardAction)

Fügt dieser Karte eine CardAction hinzu.

Parameter

NameTypBeschreibung
cardActionCardActionDer zu verwendende CardAction.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


addExpressionData(expressionData)

Fügt dieser Karte Ausdrucksdaten hinzu.

ExpressionData definiert die CEL-Logik und -Bedingung sowie das Ereignis, das ausgelöst werden soll, wenn eine Bedingung erfüllt ist.

Parameter

NameTypBeschreibung
expressionDataExpressionDataDer zu verwendende ExpressionData.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


addSection(section)

Fügt dieser Karte einen Abschnitt hinzu. Sie können einer Karte maximal 100 Abschnitte hinzufügen.

Parameter

NameTypBeschreibung
sectionCardSectionDer zu verwendende CardSection.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


build()

Erstellt die aktuelle Karte und validiert sie.

Rückflug

Card: Eine bestätigte Karte.

Löst

Error: Wenn die erstellte Karte ungültig ist.


setDisplayStyle(displayStyle)

Legt den Anzeigestil für diese Karte fest.

Wenn der Anzeigestil auf DisplayStyle.REPLACE festgelegt ist, wird die Karte angezeigt, indem die Ansicht der obersten Karte im Kartenstapel ersetzt wird.

Wenn die Darstellungsart auf DisplayStyle.PEEK festgelegt ist, wird die Kopfzeile der Karte unten in der Seitenleiste angezeigt und verdeckt teilweise die aktuelle oberste Karte des Stapels. Wenn Sie auf die Kopfzeile klicken, wird die Karte im Kartenstapel angezeigt. Wenn die Karte keinen Header hat, wird stattdessen ein generierter Header verwendet.

DisplayStyle funktioniert nur für Karten, die von der kontextbezogenen Triggerfunktion zurückgegeben werden.

Parameter

NameTypBeschreibung
displayStyleDisplayStyleDie festzulegende DisplayStyle.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


setFixedFooter(fixedFooter)

Legt eine feste Fußzeile für diese Karte fest.

Parameter

NameTypBeschreibung
fixedFooterFixedFooterDer zu verwendende FixedFooter.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


setHeader(cardHeader)

Legt den Header für diese Karte fest.

Parameter

NameTypBeschreibung
cardHeaderCardHeaderDer zu verwendende CardHeader.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


setName(name)

Legt den Namen für diese Karte fest. Der Name kann für die Navigation verwendet werden.

Parameter

NameTypBeschreibung
nameStringDer Name.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.


setPeekCardHeader(peekCardHeader)

Legt die Kopfzeile der Übersichtskarte fest.

Die Übersichtskarte wird auf der ersten Karte festgelegt, die von einer kontextbezogenen Triggerfunktion zurückgegeben wird. Es wird als beschreibendes Platzhalter-Widget verwendet, damit Nutzer von einem Homepage-Stack zum Kontext-Stack navigieren können.

Parameter

NameTypBeschreibung
peekCardHeaderCardHeaderDie festzulegende CardHeader.

Rückflug

CardBuilder: Dieses Objekt zur Verkettung.