com.inductiveautomation.ignition.common.config

Class PropertyConfigurationController

java.lang.Object

com.inductiveautomation.ignition.common.config.PropertyConfigurationController

Direct Known Subclasses:

TagEditController

public class PropertyConfigurationController
extends java.lang.Object

This class combines a mutable property set (the "target"), with a ConfigurationPropertyModel (which dictates what changes are allowed to be made) along with particular information about the state of editing- is this an intersection? A new propertyset? An inherited property set? All of these things have implications for the editing UI that we show, but we don't want to try to figure them out based on the nature of the target. Also, the target is expected to be a PropertySetConfig. This is a structure that combines the source and an edit, that can be applied or not. It supports rolling back edits of single properties, which is necessary for intersection.

Constructor Summary

Constructors

Constructor and Description
PropertyConfigurationController(PropertySetConfig target)
PropertyConfigurationController(PropertySetConfig target, ConfigurationPropertyModel model)
PropertyConfigurationController(PropertySetConfig target, ConfigurationPropertyModel model, boolean isIntersection, boolean isNew, boolean isExtension)

Method Summary

Modifier and Type	Method and Description
void	commitChanges() Applies any outstanding changes to the underlying source.
void	discardChanges()
PropertySet	getContextProperties() Context properties are those that depend on the type of object being edited.
ConfigurationPropertyModel	getModel()
PropertySetConfig	getTarget()
boolean	isInherited() Returns whether this tag is inherited from a parent type.
boolean	isIntersection() Indicates the target is an intersection of multiple tags.
boolean	isNew() Indicates we are editing a new tag definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyConfigurationController

public PropertyConfigurationController(PropertySetConfig target)

PropertyConfigurationController

public PropertyConfigurationController(PropertySetConfig target,
                                       ConfigurationPropertyModel model)

PropertyConfigurationController

public PropertyConfigurationController(PropertySetConfig target,
                                       ConfigurationPropertyModel model,
                                       boolean isIntersection,
                                       boolean isNew,
                                       boolean isExtension)

Method Detail

getModel

public ConfigurationPropertyModel getModel()

getTarget

public PropertySetConfig getTarget()

isIntersection

public boolean isIntersection()

Indicates the target is an intersection of multiple tags.

isNew

public boolean isNew()

Indicates we are editing a new tag definition.

isInherited

public boolean isInherited()

Returns whether this tag is inherited from a parent type. This indicates that any settings would be considered overrides, not source values.

commitChanges

public void commitChanges()

Applies any outstanding changes to the underlying source.

discardChanges

public void discardChanges()

getContextProperties

public PropertySet getContextProperties()

Context properties are those that depend on the type of object being edited. For example, the path of the tag might be in this, or the UUID of the target object.