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

Interface Section.CategoryBuilder

Enclosing interface:

Section

public static interface Section.CategoryBuilder

Method Summary

Modifier and Type	Method	Description
Section.CategoryBuilder	addAssociatedResourceType(ResourceType resourceType)	If this category contains items that are resources that have a ResourceTypeMeta, invoke this to let these items be found via the gateway's search functionality.
Section.CategoryBuilder	addPage(String label, Consumer<Section.PageBuilder> builder)
Section	build()
Section.CategoryBuilder	label(String label)
Section.CategoryBuilder	mount(String url, WebUiComponent component)
default Section.CategoryBuilder	mount(String url, String componentId)
default Section.CategoryBuilder	mount(String url, String componentId, SystemJsModule module)
Section.CategoryBuilder	position(int position)
Section.CategoryBuilder	requiredPermission(PermissionType requiredPermission)
Section.CategoryBuilder	searchDelegate(ItemSearchDelegate searchDelegate)	Add a custom search delegate that can be used to search for items that reside on this category.

Method Details

label

Section.CategoryBuilder label(String label)

requiredPermission

Section.CategoryBuilder requiredPermission(PermissionType requiredPermission)

position

Section.CategoryBuilder position(int position)

mount

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

mount

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

mount

Section.CategoryBuilder mount(String url,
 WebUiComponent component)

addPage

Section.CategoryBuilder addPage(String label,
 Consumer<Section.PageBuilder> builder)

searchDelegate

Section.CategoryBuilder searchDelegate(ItemSearchDelegate searchDelegate)

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

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

addAssociatedResourceType

Section.CategoryBuilder addAssociatedResourceType(ResourceType resourceType)

If this category 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 category mounts a component directly. If this category has sub-pages, associate them instead.

build

Section build()