Package com.inductiveautomation.ignition.gateway.web.nav

Interface Section.PageBuilder

Enclosing interface:

Section

public static interface Section.PageBuilder

Method Summary

Modifier and Type	Method	Description
Section.PageBuilder	addAssociatedResourceType(ResourceType resourceType)	If this page contains items that are resources that have a ResourceTypeMeta, invoke this to let these items be found via the gateway's search functionality.
Section.PageBuilder	addTab(String label, Consumer<Section.TabBuilder> builder)
Section.CategoryBuilder	build()
Section.PageBuilder	enabled(Predicate<GatewayContext> enabled)	A context-aware predicate function to determine if this page is enabled.
Section.PageBuilder	mount(String url, WebUiComponent component)
default Section.PageBuilder	mount(String url, String componentId)
default Section.PageBuilder	mount(String url, String componentId, SystemJsModule module)
Section.PageBuilder	position(int position)
Section.PageBuilder	requiredPermission(PermissionType requiredPermission)
Section.PageBuilder	searchDelegate(ItemSearchDelegate searchDelegate)	Add a custom search delegate that can be used to search for items that reside on this page.
Section.PageBuilder	title(String title)

Method Details

title

Section.PageBuilder title(String title)

requiredPermission

Section.PageBuilder requiredPermission(PermissionType requiredPermission)

mount

default Section.PageBuilder mount(String url,
 String componentId)

mount

default Section.PageBuilder mount(String url,
 String componentId,
 SystemJsModule module)

mount

Section.PageBuilder mount(String url,
 WebUiComponent component)

position

Section.PageBuilder position(int position)

addTab

Section.PageBuilder addTab(String label,
 Consumer<Section.TabBuilder> builder)

searchDelegate

Section.PageBuilder searchDelegate(ItemSearchDelegate searchDelegate)

Add a custom search delegate that can be used to search for items that reside on this page. If your page contains items that are resources that have a ResourceTypeMeta, you should use addAssociatedResourceType(ResourceType) instead.

Should only be used if this page mounts a component directly. If this page has sub-tabs, register search delegates for them instead.

addAssociatedResourceType

Section.PageBuilder addAssociatedResourceType(ResourceType resourceType)

If this page contains items that are resources that have a ResourceTypeMeta, invoke this to let these items be found via the gateway's search functionality.

Should only be used if this page mounts a component directly. If this page has sub-tabs, associate them instead.

May be invoked multiple times to associate multiple resource types with this page.

enabled

Section.PageBuilder enabled(Predicate<GatewayContext> enabled)

A context-aware predicate function to determine if this page is enabled. When not enabled, the page will not be included in the navigation model.

build

Section.CategoryBuilder build()