Package io.quarkus.devui.spi.page

Class AbstractPageBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.devui.spi.AbstractDevUIBuildItem

io.quarkus.devui.spi.page.AbstractPageBuildItem

Direct Known Subclasses:

CardPageBuildItem, FooterPageBuildItem, MenuPageBuildItem, SettingPageBuildItem, UnlistedPageBuildItem

public abstract class AbstractPageBuildItem
extends AbstractDevUIBuildItem

Any of card, menu or footer pages

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,BuildTimeData>	buildTimeData
protected String	headlessComponentLink
protected final List<PageBuilder>	pageBuilders

Fields inherited from class io.quarkus.devui.spi.AbstractDevUIBuildItem

DEV_UI

Constructor Summary

Constructors

Constructor	Description
AbstractPageBuildItem()
AbstractPageBuildItem(PageBuilder... pageBuilder)
AbstractPageBuildItem(String customIdentifier)
AbstractPageBuildItem(String customIdentifier, PageBuilder... pageBuilder)

Method Summary

Modifier and Type	Method	Description
void	addBuildTimeData(String fieldName, Object fieldData)
void	addBuildTimeData(String fieldName, Object fieldData, String description)
void	addBuildTimeData(String fieldName, Object fieldData, String description, boolean mcpEnabledByDefault)
void	addPage(PageBuilder page)
Map<String,BuildTimeData>	getBuildTimeData()
String	getHeadlessComponentLink()
List<PageBuilder>	getPages()
boolean	hasBuildTimeData()
boolean	hasPages()
void	setHeadlessComponentLink(String headlessComponentLink)

Methods inherited from class io.quarkus.devui.spi.AbstractDevUIBuildItem

getArtifactKey, getExtensionPathName, isInternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

buildTimeData

protected final Map<String,BuildTimeData> buildTimeData

pageBuilders

protected final List<PageBuilder> pageBuilders

headlessComponentLink

protected String headlessComponentLink

Constructor Details

AbstractPageBuildItem

public AbstractPageBuildItem()

AbstractPageBuildItem

public AbstractPageBuildItem(PageBuilder... pageBuilder)

AbstractPageBuildItem

public AbstractPageBuildItem(String customIdentifier)

AbstractPageBuildItem

public AbstractPageBuildItem(String customIdentifier,
 PageBuilder... pageBuilder)

Method Details

addPage

public void addPage(PageBuilder page)

getPages

public List<PageBuilder> getPages()

hasPages

public boolean hasPages()

addBuildTimeData

public void addBuildTimeData(String fieldName,
 Object fieldData)

addBuildTimeData

public void addBuildTimeData(String fieldName,
 Object fieldData,
 String description)

addBuildTimeData

public void addBuildTimeData(String fieldName,
 Object fieldData,
 String description,
 boolean mcpEnabledByDefault)

getBuildTimeData

public Map<String,BuildTimeData> getBuildTimeData()

hasBuildTimeData

public boolean hasBuildTimeData()

setHeadlessComponentLink

public void setHeadlessComponentLink(String headlessComponentLink)

getHeadlessComponentLink

public String getHeadlessComponentLink()