Package com.inductiveautomation.ignition.gateway.web.pages.config.overviewmeta

Class CommonTaskLink

java.lang.Object

com.inductiveautomation.ignition.gateway.web.pages.config.overviewmeta.CommonTaskLink

public class CommonTaskLink
extends Object

Displays a link whose text describes a task found in the Config section, and whose url leads to the page where that task can be performed.

Constructor Summary

Constructors

Constructor	Description
CommonTaskLink(ConfigOverviewCategory category, String text, String url)
CommonTaskLink(ConfigOverviewCategory category, String text, org.apache.commons.lang3.tuple.Pair<String,String> menuLocation)	Useful when dealing with MENU_ENTRY pairs

Method Summary

Modifier and Type	Method	Description
ConfigOverviewCategory	getCategory()
String	getText()
String	getUrl()

Methods inherited from class java.lang.Object

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

Constructor Details

CommonTaskLink

public CommonTaskLink(ConfigOverviewCategory category,
 String text,
 org.apache.commons.lang3.tuple.Pair<String,String> menuLocation)

Useful when dealing with MENU_ENTRY pairs

Parameters:

category - the category presented on the body of the overview page

text - the link text

menuLocation - the pair of representing (config menu category, config page)

CommonTaskLink

public CommonTaskLink(ConfigOverviewCategory category,
 String text,
 String url)

Parameters:

category - the category presented on the body of the overview page

text - the link text

url - can be relative to the configure section (such as using 'system.overview'), or a full path ('/main/.../system.overview').

Method Details

getCategory

public ConfigOverviewCategory getCategory()

getText

public String getText()

getUrl

public String getUrl()