Package com.inductiveautomation.ignition.gateway.web.models

Class DefaultConfigTab

java.lang.Object

com.inductiveautomation.ignition.gateway.web.models.DefaultConfigTab

All Implemented Interfaces:

IConfigTab, INamedTab, Serializable, org.apache.wicket.extensions.markup.html.tabs.ITab, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

TaskPage.TaskPageTab

public class DefaultConfigTab
extends Object
implements IConfigTab

Default implementation of IConfigPanelTab. Expects a Class of the config panel to instantiate, which MUST have a public constructor which accepts either no arguments or a single argument: an IConfigPage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultConfigTab.Builder	Builder, just for fun, because who can deal with a 3-arg constructor!?

Constructor Summary

Constructors

Constructor	Description
DefaultConfigTab(ConfigCategory category, String name, String titleKey, Class<? extends ConfigPanel> panelClass)
DefaultConfigTab(org.apache.commons.lang3.tuple.Pair<String,String> menuLocation, String titleKey, Class<? extends ConfigPanel> panelClass)

Method Summary

Modifier and Type	Method	Description
static DefaultConfigTab.Builder	builder()
String	getCategoryName()	Get the non-localized, brief (id) of the category this tab belongs to.
org.apache.commons.lang3.tuple.Pair<String,String>	getMenuLocation()
ConfigPanel	getPanel(IConfigPage configPage)	Create the config panel that this tab represents.
Iterable<String>	getSearchTerms()	Get a list of terms that when searched for should cause this tab to be highlighted.
String	getTabName()	Get the non-localized, brief name of the tab.
org.apache.wicket.model.IModel<String>	getTitle()
boolean	isVisible()
void	setSearchTerms(List<String> terms)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.web.models.IConfigTab

getPanel

Constructor Details

DefaultConfigTab

public DefaultConfigTab(ConfigCategory category,
 String name,
 String titleKey,
 Class<? extends ConfigPanel> panelClass)

DefaultConfigTab

public DefaultConfigTab(org.apache.commons.lang3.tuple.Pair<String,String> menuLocation,
 String titleKey,
 Class<? extends ConfigPanel> panelClass)

Method Details

builder

public static DefaultConfigTab.Builder builder()

getSearchTerms

public Iterable<String> getSearchTerms()

Description copied from interface: INamedTab

Get a list of terms that when searched for should cause this tab to be highlighted. The tab's name will automatically be a search term, so it does not need to be in this list.

Specified by:

getSearchTerms in interface INamedTab

setSearchTerms

public void setSearchTerms(List<String> terms)

getTabName

public String getTabName()

Description copied from interface: INamedTab

Get the non-localized, brief name of the tab. Should be URL friendly for bookmark-able navigation

Specified by:

getTabName in interface INamedTab

getCategoryName

public String getCategoryName()

Description copied from interface: INamedTab

Get the non-localized, brief (id) of the category this tab belongs to.

Specified by:

getCategoryName in interface INamedTab

getMenuLocation

public org.apache.commons.lang3.tuple.Pair<String,String> getMenuLocation()

Specified by:

getMenuLocation in interface IConfigTab

getTitle

public org.apache.wicket.model.IModel<String> getTitle()

Specified by:

getTitle in interface org.apache.wicket.extensions.markup.html.tabs.ITab

getPanel

public ConfigPanel getPanel(IConfigPage configPage)

Description copied from interface: IConfigTab

Create the config panel that this tab represents. Remember, all ConfigPanel's must have a wicket id of "config-contents"

Specified by:

getPanel in interface IConfigTab

Parameters:

configPage - The parent config page that this config panel will be a part of.

Returns:

the new ConfigPanel instance.

isVisible

public boolean isVisible()

Specified by:

isVisible in interface org.apache.wicket.extensions.markup.html.tabs.ITab