final | |
|---|---|
readonly | |
extends |
AbstractControl |
Server-side mirror of sap.f.cards.Header + sap.f.cards.BaseHeader —
the header aggregation of a {@see AbstractCard}.
Faithfully carries every public field of the two UI5 classes. title is
the only field the UI5 docs flag as "always set"; we keep it optional
here too so the same DTO works for header-less variants when needed.
Every other field is emit-when-set — null falls through to UI5's own
default at apply-settings time.
To pair the chart artifact's getTitle() / getDescription() with this
Header, see {@see \LaravelUi5\Core\Ui5\Dashboard\Emitters\ChartEmitter} —
it auto-populates title and subtitle from artifact metadata when the
provider returned header: null.
toolbar is the BaseHeader-inherited action slot — typically holds a
{@see \LaravelUi5\Core\Ui5\Controls\Sap\M\OverflowToolbar} of
{@see \LaravelUi5\Core\Ui5\Controls\Sap\M\Button}s. Button
presses route through the Dashboard action event channel via stuffed
parameters (same convention as a Tile's press-intent). The toolbar is
the SAP-Fiori-idiomatic place for card-level actions ("Open workspace",
"Configure", …) — sap.f.Card has no footer aggregation, so action
surfaces live in the header rather than below content.
For a numeric-KPI variant of the header (number, scale, trend, side
indicators, microChart aggregation), a future NumericHeader DTO will
mirror sap.f.cards.NumericHeader similarly. Deferred until a real
consumer asks; not blocking v0.9.
| Methods | ||
|---|---|---|
public
|
__construct(
?string $title = null,
?int $titleMaxLines = null,
?string $subtitle = null,
?int $subtitleMaxLines = null,
?string $statusText = null,
?string $iconSrc = null,
?string $iconInitials = null,
?string $iconAlt = null,
?AvatarShape $iconDisplayShape = null,
?AvatarColor $iconBackgroundColor = null,
?bool $iconVisible = null,
?AvatarSize $iconSize = null,
?AvatarImageFitType $iconFitType = null,
?string $dataTimestamp = null,
?bool $statusVisible = null,
?WrappingType $wrappingType = null,
?string $href = null,
?string $target = null,
?AbstractControl $toolbar = null,
)
|
# |
public
|
ui5Class(): string
|
# |
| Methods inherited from LaravelUi5\Core\Ui5\Controls\AbstractControl |
|---|
jsonSerialize() |
| Properties | |||
|---|---|---|---|
public
|
?string
|
$title
|
# |
public
|
?int
|
$titleMaxLines
|
# |
public
|
?string
|
$subtitle
|
# |
public
|
?int
|
$subtitleMaxLines
|
# |
public
|
?string
|
$statusText
|
# |
public
|
?string
|
$iconSrc
|
# |
public
|
?string
|
$iconInitials
|
# |
public
|
?string
|
$iconAlt
|
# |
public
|
?AvatarShape
|
$iconDisplayShape
|
# |
public
|
?AvatarColor
|
$iconBackgroundColor
|
# |
public
|
?bool
|
$iconVisible
|
# |
public
|
?AvatarSize
|
$iconSize
|
# |
public
|
?AvatarImageFitType
|
$iconFitType
|
# |
public
|
?string
|
$dataTimestamp
|
# |
public
|
?bool
|
$statusVisible
|
# |
public
|
?WrappingType
|
$wrappingType
|
# |
public
|
?string
|
$href
|
# |
public
|
?string
|
$target
|
# |
public
|
?AbstractControl
|
$toolbar
|
# |