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:

java.io.Serializable

Enclosing class:

SystemMap.SystemMapElement

public static class SystemMap.SystemMapElement.StatusItem
extends java.lang.Object
implements java.io.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 and Description
StatusItem(java.lang.String display, SystemMap.SystemMapElement.StatusItemState state)
StatusItem(SystemMap.SystemMapElement.StatusItemState state, java.lang.String msgFallback, java.lang.String messageKey, java.lang.Object... messageArgs)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplay(java.util.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 Detail

StatusItem

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

StatusItem

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

Method Detail

getDisplay

public java.lang.String getDisplay(java.util.Locale locale)

getState

public SystemMap.SystemMapElement.StatusItemState getState()