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

Interface Section

public interface Section

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Section.CategoryBuilder
static interface	Section.PageBuilder
static interface	Section.TabBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTIONS	Label of well-known section "Connections"
static final String	DIAGNOSTICS	Label of well-known section "Diagnostics"
static final String	HOME	Label of well-known section "Home"
static final String	NETWORK	Label of well-known section "Network"
static final String	PLATFORM	Label of well-known section "Platform"
static final String	SERVICES	Label of well-known section "Services"

Method Summary

Modifier and Type	Method	Description
Section	addCategory(String categoryKey, Consumer<Section.CategoryBuilder> build)	Create a category builder to add a new (or append to an existing) category.
List<Category>	getCategories()
String	getLabel()

Field Details

HOME

static final String HOME

Label of well-known section "Home"

See Also:

• Constant Field Values

PLATFORM

static final String PLATFORM

Label of well-known section "Platform"

See Also:

• Constant Field Values

CONNECTIONS

static final String CONNECTIONS

Label of well-known section "Connections"

See Also:

• Constant Field Values

NETWORK

static final String NETWORK

Label of well-known section "Network"

See Also:

• Constant Field Values

SERVICES

static final String SERVICES

Label of well-known section "Services"

See Also:

• Constant Field Values

DIAGNOSTICS

static final String DIAGNOSTICS

Label of well-known section "Diagnostics"

See Also:

• Constant Field Values

Method Details

getLabel

String getLabel()

getCategories

List<Category> getCategories()

Returns:

A list of categories, ordered by their position. Categories with equal position values will be sorted alphabetically by label.

addCategory

Section addCategory(String categoryKey,
 Consumer<Section.CategoryBuilder> build)

Create a category builder to add a new (or append to an existing) category. The category will be added to this section (or the existing category will be updated) when Section.CategoryBuilder.build() is invoked.

Parameters:

categoryKey - Key that identifies the category. If no label is further specified, will also be the display label for this category.