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

Class SystemMap.SystemMapElement.StatusItem

java.lang.Object

com.inductiveautomation.ignition.gateway.web.models.SystemMap.SystemMapElement.StatusItem

All Implemented Interfaces:

Serializable

Enclosing class:

SystemMap.SystemMapElement

public static class SystemMap.SystemMapElement.StatusItem
extends Object
implements Serializable

A textual status item to be displayed inside a SystemMapElement. Supports two methods of defining the text: plain string message, or resource key with accompanying arguments. If using the resource key, the text message should still be provided as a fallback, in case the map is sent to a redundant node who doesn't have that module installed.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StatusItem(SystemMap.SystemMapElement.StatusItemState state, String msgFallback, String messageKey, Object... messageArgs)
StatusItem(String display, SystemMap.SystemMapElement.StatusItemState state)

Method Summary

Modifier and Type	Method	Description
String	getDisplay(Locale locale)
SystemMap.SystemMapElement.StatusItemState	getState()

Methods inherited from class java.lang.Object

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

Constructor Details

StatusItem

public StatusItem(SystemMap.SystemMapElement.StatusItemState state,
 String msgFallback,
 String messageKey,
 Object... messageArgs)

StatusItem

public StatusItem(String display,
 SystemMap.SystemMapElement.StatusItemState state)

Method Details

getDisplay

public String getDisplay(Locale locale)

getState

public SystemMap.SystemMapElement.StatusItemState getState()