Package io.quarkus.devui.spi.page

Class Page

java.lang.Object

io.quarkus.devui.spi.page.Page

public class Page
extends Object

Define a page in Dev UI. This is not a full web page, but rather the section in the middle where extensions can display data. All pages (fragments) are rendered using Web components, but different builders exist to make it easy to define a page Navigation to this page is also defined here.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Page(String icon, String title, String staticLabel, String dynamicLabel, String streamingLabel, String componentName, String componentLink, Map<String,String> metadata, boolean embed, boolean includeInMenu, boolean internalComponent, String namespace, String namespaceLabel, String extensionId)

Method Summary

Modifier and Type	Method	Description
static ExternalPageBuilder	externalPageBuilder(String name)	Here you provide a url to an external resource.
String	getComponentLink()
String	getComponentName()
String	getComponentRef()
String	getDynamicLabel()
String	getExtensionId()
String	getIcon()
String	getId()
Map<String,String>	getMetadata()
String	getNamespace()
String	getNamespaceLabel()
String	getStaticLabel()
String	getStreamingLabel()
String	getTitle()
boolean	isEmbed()
boolean	isIncludeInMenu()
boolean	isInternal()
static QuteDataPageBuilder	quteDataPageBuilder(String name)	Here you can render the data with a qute template
static RawDataPageBuilder	rawDataPageBuilder(String name)	Here you provide the data that should be rendered in raw json format
static TableDataPageBuilder	tableDataPageBuilder(String name)	Here you provide the data that should be rendered in a table
String	toString()
static WebComponentPageBuilder	webComponentPageBuilder()	Here you provide the Web Component that should be rendered.

Methods inherited from class java.lang.Object

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

Constructor Details

Page

protected Page(String icon,
 String title,
 String staticLabel,
 String dynamicLabel,
 String streamingLabel,
 String componentName,
 String componentLink,
 Map<String,String> metadata,
 boolean embed,
 boolean includeInMenu,
 boolean internalComponent,
 String namespace,
 String namespaceLabel,
 String extensionId)

Method Details

getId

public String getId()

getComponentRef

public String getComponentRef()

getNamespace

public String getNamespace()

getNamespaceLabel

public String getNamespaceLabel()

getIcon

public String getIcon()

getTitle

public String getTitle()

getStaticLabel

public String getStaticLabel()

getDynamicLabel

public String getDynamicLabel()

getStreamingLabel

public String getStreamingLabel()

getComponentName

public String getComponentName()

getComponentLink

public String getComponentLink()

isEmbed

public boolean isEmbed()

isIncludeInMenu

public boolean isIncludeInMenu()

isInternal

public boolean isInternal()

getExtensionId

public String getExtensionId()

getMetadata

public Map<String,String> getMetadata()

toString

public String toString()

Overrides:

toString in class Object

webComponentPageBuilder

public static WebComponentPageBuilder webComponentPageBuilder()

Here you provide the Web Component that should be rendered. You have full control over the page. You can use build time data if you made it available

externalPageBuilder

public static ExternalPageBuilder externalPageBuilder(String name)

Here you provide a url to an external resource. When code/markup, if can be displayed in a code view, when HTML it can render the HTML

rawDataPageBuilder

public static RawDataPageBuilder rawDataPageBuilder(String name)

Here you provide the data that should be rendered in raw json format

quteDataPageBuilder

public static QuteDataPageBuilder quteDataPageBuilder(String name)

Here you can render the data with a qute template

tableDataPageBuilder

public static TableDataPageBuilder tableDataPageBuilder(String name)

Here you provide the data that should be rendered in a table