Class DefaultConfigTab
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.web.models.DefaultConfigTab
-
- All Implemented Interfaces:
IConfigTab
,INamedTab
,java.io.Serializable
,org.apache.wicket.extensions.markup.html.tabs.ITab
,org.apache.wicket.util.io.IClusterable
- Direct Known Subclasses:
TaskPage.TaskPageTab
public class DefaultConfigTab extends java.lang.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, java.lang.String name, java.lang.String titleKey, java.lang.Class<? extends ConfigPanel> panelClass)
DefaultConfigTab(org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> menuLocation, java.lang.String titleKey, java.lang.Class<? extends ConfigPanel> panelClass)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultConfigTab.Builder
builder()
java.lang.String
getCategoryName()
Get the non-localized, brief (id) of the category this tab belongs to.org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>
getMenuLocation()
ConfigPanel
getPanel(IConfigPage configPage)
Create the config panel that this tab represents.java.lang.Iterable<java.lang.String>
getSearchTerms()
Get a list of terms that when searched for should cause this tab to be highlighted.java.lang.String
getTabName()
Get the non-localized, brief name of the tab.org.apache.wicket.model.IModel<java.lang.String>
getTitle()
boolean
isVisible()
void
setSearchTerms(java.util.List<java.lang.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 Detail
-
DefaultConfigTab
public DefaultConfigTab(ConfigCategory category, java.lang.String name, java.lang.String titleKey, java.lang.Class<? extends ConfigPanel> panelClass)
-
DefaultConfigTab
public DefaultConfigTab(org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> menuLocation, java.lang.String titleKey, java.lang.Class<? extends ConfigPanel> panelClass)
-
-
Method Detail
-
builder
public static DefaultConfigTab.Builder builder()
-
getSearchTerms
public java.lang.Iterable<java.lang.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 interfaceINamedTab
-
setSearchTerms
public void setSearchTerms(java.util.List<java.lang.String> terms)
-
getTabName
public java.lang.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 interfaceINamedTab
-
getCategoryName
public java.lang.String getCategoryName()
Description copied from interface:INamedTab
Get the non-localized, brief (id) of the category this tab belongs to.- Specified by:
getCategoryName
in interfaceINamedTab
-
getMenuLocation
public org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> getMenuLocation()
- Specified by:
getMenuLocation
in interfaceIConfigTab
-
getTitle
public org.apache.wicket.model.IModel<java.lang.String> getTitle()
- Specified by:
getTitle
in interfaceorg.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 interfaceIConfigTab
- 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 interfaceorg.apache.wicket.extensions.markup.html.tabs.ITab
-
-