Package com.inductiveautomation.factorypmi.application.binding

Class UDTProperty

java.lang.Object

com.inductiveautomation.factorypmi.application.binding.UDTProperty

All Implemented Interfaces:

java.io.Serializable

public class UDTProperty
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UDTProperty.SetupDirectBinding

Field Summary

Fields

Modifier and Type	Field	Description
static TagPath	META_PATH	The path to the sub-property that holds the current tag's path.

Constructor Summary

Constructors

Constructor	Description
UDTProperty()	For XML serialization
UDTProperty(TagPath qualifiedType)	Creates a UDT property that represents a given type.

Method Summary

Modifier and Type	Method	Description
protected void	createMap()	Initializes the properties map.
UdtDefinitionInfo	getDefinition()
TagPath	getDrivingTagPath()	Returns the path of the instance this UDTProperty is currently representing, if any.
TagPath	getQualifiedType()	The tag path of the type of this UDT
java.util.Collection<TagPath>	getSubProperties()
java.lang.Class<?>	getType(TagPath subProperty)
QualifiedValue	getValue(TagPath path)
void	initialize(javax.swing.JComponent parent, java.lang.String propertyName, ClientContext context)	UDT properties must be initialized to learn the current structure of the UDT they represent.
void	setDrivingTagPath(TagPath tagPath)
void	setQualifiedType(TagPath qualifiedType)	Deprecated.
void	setQualifiedType(TagPath qualifiedType)
void	setTag(UdtDefinitionInfo tag, TagPath tagPath)
void	setupDirectBinding(javax.swing.JComponent comp, java.lang.String name)
void	setValue(TagPath path, QualifiedValue value)
protected void	setValueInternal(TagPath path, QualifiedValue value, boolean checkExisting, boolean fireGlobal)
java.lang.String	toString()
void	updateDefinition(UdtDefinitionInfo tag, boolean fireEvents)
void	updateFromToString(java.lang.String toStringValue)

Methods inherited from class java.lang.Object

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

Field Detail

META_PATH

public static TagPath META_PATH

The path to the sub-property that holds the current tag's path.

Constructor Detail

UDTProperty

public UDTProperty()

For XML serialization

UDTProperty

public UDTProperty(TagPath qualifiedType)

Creates a UDT property that represents a given type.

Method Detail

setupDirectBinding

public void setupDirectBinding(javax.swing.JComponent comp,
                               java.lang.String name)
                        throws java.lang.Exception

Throws:

java.lang.Exception

updateFromToString

public void updateFromToString(java.lang.String toStringValue)

createMap

protected void createMap()

Initializes the properties map. Only here so that our subclass in TemplateHolder can avoid this initialization

initialize

public void initialize(javax.swing.JComponent parent,
                       java.lang.String propertyName,
                       ClientContext context)

UDT properties must be initialized to learn the current structure of the UDT they represent.

getSubProperties

public java.util.Collection<TagPath> getSubProperties()

getQualifiedType

public TagPath getQualifiedType()

The tag path of the type of this UDT

setQualifiedType

@Deprecated
public void setQualifiedType(TagPath qualifiedType)

Deprecated.

For deserialization backwards compatibility only

setQualifiedType

public void setQualifiedType(TagPath qualifiedType)

getType

public java.lang.Class<?> getType(TagPath subProperty)

updateDefinition

public void updateDefinition(UdtDefinitionInfo tag,
                             boolean fireEvents)

setTag

public void setTag(UdtDefinitionInfo tag,
                   TagPath tagPath)

setDrivingTagPath

public void setDrivingTagPath(TagPath tagPath)

getDrivingTagPath

public TagPath getDrivingTagPath()

Returns the path of the instance this UDTProperty is currently representing, if any. Otherwise, null.

getDefinition

public UdtDefinitionInfo getDefinition()

setValue

public void setValue(TagPath path,
                     QualifiedValue value)

setValueInternal

protected void setValueInternal(TagPath path,
                                QualifiedValue value,
                                boolean checkExisting,
                                boolean fireGlobal)

getValue

public QualifiedValue getValue(TagPath path)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object