Package com.inductiveautomation.factorypmi.application.sqltags

Interface ClientTag

All Superinterfaces:

Comparable<Tag>, MutableTag, Tag, TagNode

All Known Implementing Classes:

AbstractClientSystemTag, AbstractClientTag, AppDescriptionTag, AppNameTag, AppTitleTag, ArrayIndexTag, ClientTagFolder, ClientTimeTag, CurrentWindowTag, DateTimeFormatTag, DefaultDatabaseTag, DefaultTagProviderTag, GatewayAddressTag, GatewayRedundancyRoleTag, HostnameTag, IPAddressTag, LanguageTag, LastProjectUpdateTag, MACAddressTag, PollingClientSystemTag, ProjectTag, ProjectUpdateAvailableTag, RolesDataSetTag, RolesStringTag, StaticClientSystemTag, SystemFlagsTag, SystemTagFolder, UserNameTag, UserSourceTag

public interface ClientTag
extends TagNode, MutableTag

Subinterface of Tag, a Client Tag adds integrated change listening, and adding/removing tags.

Method Summary

Modifier and Type	Method	Description
void	addChild(Tag child)	Adds a child tag to this tag folder.
void	applyDiff(TagDiff diff)	Applies the given tag diff
ClientTag	findChild(String tagName)	Attempts to find a tag with the given name (case insensitive).
boolean	hasPermission(boolean write)
void	notifyTagDeleted()	Called when this tag is removed.
Tag	removeChild(String tagName)	Removes the child with the given name (case insensitive).
void	startBinding(VisionClientContext appContext, TagPath pathContext, TagChangeListener rootListener)	Starts any binding for the tag, such as an expression binding or a SQL query binding
void	stopBinding()	Stops any binding activities for this tag
void	transferState(ClientTag otherTag)	Transfers listeners and values to another tag.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.MutableTag

setAccessRights, setAlarmStates, setAttribute, setCurrentValue, setDataType, setEnabled, setEventScripts, setName

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.Tag

getAccessRights, getAlarmStates, getAttribute, getCurrentValue, getDataType, getEventScripts, getName, getPermissionModel, getType, isEnabled

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagNode

getChildren

Method Details

transferState

void transferState(ClientTag otherTag)

Transfers listeners and values to another tag. Used when tag root is changed. Should transfer recursively - that is, transfer direct listeners, and then go through children, see if this tag has the same child, and transfer those listeners too

notifyTagDeleted

void notifyTagDeleted()

Called when this tag is removed. Should notify all subscribers that it no longer exists

hasPermission

boolean hasPermission(boolean write)

applyDiff

void applyDiff(TagDiff diff)

Applies the given tag diff

addChild

void addChild(Tag child)

Adds a child tag to this tag folder. Will throw an UnsupportedOperationException on anything but a folder tag

removeChild

Tag removeChild(String tagName)

Removes the child with the given name (case insensitive). Will throw an UnsupportedOperationException on anything but a folder tag. Returns the tag removed, or null if no tag by the given name was found.

findChild

ClientTag findChild(String tagName)

Attempts to find a tag with the given name (case insensitive).

startBinding

void startBinding(VisionClientContext appContext,
 TagPath pathContext,
 TagChangeListener rootListener)

Starts any binding for the tag, such as an expression binding or a SQL query binding

stopBinding

void stopBinding()

Stops any binding activities for this tag