abstract | |
|---|---|
implements |
Ui5ValueHelpInterface |
uses |
HasArtifactIdentity |
Base for SDK-owned {@see Ui5ValueHelpInterface} artifacts — a provider-owned
search-help modal (a sap.m.Dialog-rooted view) that returns a selection.
A ValueHelp is a Dialog that returns a selection: it rides the Global Dialog
mechanism verbatim (see {@see AbstractUi5Dialog}) and adds only a client-side
return channel, so this base is a near-copy of the Dialog base — the sole
difference is getType() → ArtifactType::ValueHelp. The enum case and the
interface live in Core (the interface is Core-expressible, its contract being
the inherited getViewName(): string); this base and the open runtime (the
shell ValueHelpAdapter, LaravelUi5.openValueHelp,
AbstractValueHelpController) live in the SDK, because a value help only
does anything with the shell to agitate it.
A concrete value help declares five constants and nothing else:
public const NAMESPACE = 'com.acme.foo.valuehelps.pickBar'; public const VERSION = '1.0.0'; public const TITLE = 'Pick a Bar'; public const DESCRIPTION = 'Browse and select a bar.'; public const VIEW = 'com.acme.foo.view.valuehelps.PickBar';
mirroring {@see AbstractUi5Dialog}. The view's single root control MUST be a
sap.m.Dialog. #[Access] is optional and boundary-scoped (v1.0 D11): omit
it on same-app pickers (transitive gating from the host tree); declare one on
a foreign-openable picker, where it is the sole authorization point.
| Methods | ||
|---|---|---|
public
|
__construct(Ui5ModuleInterface $module)
|
# |
public
|
getModule(): Ui5ModuleInterface
|
# |
public
|
getType(): ArtifactType
|
# |
public
|
getViewName(): string
|
# |
public
|
declaredEntityType(): EntityTypeInterface
|
# |
public
|
scopes(): string[]
|
# |