Package com.inductiveautomation.perspective.designer.workspace.propertyeditor

Class ComponentPropsDocumentModel

java.lang.Object

com.inductiveautomation.ignition.client.jsonedit.DocumentModel

com.inductiveautomation.perspective.designer.workspace.propertyeditor.ComponentPropsDocumentModel

public class ComponentPropsDocumentModel
extends DocumentModel

Document model that knows how to write values back to the underlying property tree

Field Summary

Fields

Modifier and Type	Field	Description
final PropertyType	scope

Fields inherited from class com.inductiveautomation.ignition.client.jsonedit.DocumentModel

change, root, schema, VALIDATION_RESULTS

Constructor Summary

Constructors

Constructor	Description
ComponentPropsDocumentModel(DesignAdapter editor, ComponentSelection details, PropertyType scope, JsonSchema schema)

Method Summary

Modifier and Type	Method	Description
void	applyUpdates(com.inductiveautomation.ignition.common.gson.JsonObject o)	This gets called from the javascript bridge when properties of the selected component change.
protected com.inductiveautomation.ignition.common.gson.JsonElement	encodeValueAsJson(DocumentNode node)
Set<BindingConfig>	findBindingsOnChildren(String parentPath)
Optional<PropertyConfig>	findPropConfig(NodeEditor editor)
Optional<PropertyConfig>	findPropConfig(String path)
BindingConfig	getBinding(String path)
PropertyConfigCollection	getPropertyConfigCollection()
PropertyType	getScope()
ComponentSelection	getSelection()
protected void	initValidators()	Override to customize JSON "validator" strategy.
boolean	isKeyEditable(DocumentNode node)
boolean	isValueEditable(DocumentNode node)
protected void	onNodeChanged(PropertyChangeEvent event)	Whenever any document node fires a property change, this method will be invoked.

Methods inherited from class com.inductiveautomation.ignition.client.jsonedit.DocumentModel

addNodeChangeListener, addPropertyChangeListener, addPropertyChangeListener, addValidator, dfs, fromDocument, fromGson, getAsJsonTree, getRoot, getSchema, getValidationResults, removeNodeChangeListener, removePropertyChangeListener, removePropertyChangeListener, toJson

Methods inherited from class java.lang.Object

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

Field Details

scope

public final PropertyType scope

Constructor Details

ComponentPropsDocumentModel

public ComponentPropsDocumentModel(DesignAdapter editor,
 ComponentSelection details,
 PropertyType scope,
 JsonSchema schema)

Method Details

encodeValueAsJson

protected com.inductiveautomation.ignition.common.gson.JsonElement encodeValueAsJson(DocumentNode node)

Overrides:

encodeValueAsJson in class DocumentModel

getSelection

public ComponentSelection getSelection()

getScope

public PropertyType getScope()

initValidators

protected void initValidators()

Description copied from class: DocumentModel

Override to customize JSON "validator" strategy. Default behavior adds a schema validator, if a schema exists, and warns about duplicate or bad quality keys.

Overrides:

initValidators in class DocumentModel

applyUpdates

public void applyUpdates(com.inductiveautomation.ignition.common.gson.JsonObject o)

This gets called from the javascript bridge when properties of the selected component change.

getBinding

@Nullable
public BindingConfig getBinding(String path)

findPropConfig

public Optional<PropertyConfig> findPropConfig(NodeEditor editor)

getPropertyConfigCollection

public PropertyConfigCollection getPropertyConfigCollection()

findPropConfig

public Optional<PropertyConfig> findPropConfig(String path)

findBindingsOnChildren

public Set<BindingConfig> findBindingsOnChildren(String parentPath)

isKeyEditable

public boolean isKeyEditable(DocumentNode node)

Overrides:

isKeyEditable in class DocumentModel

isValueEditable

public boolean isValueEditable(DocumentNode node)

Overrides:

isValueEditable in class DocumentModel

onNodeChanged

protected void onNodeChanged(PropertyChangeEvent event)

Whenever any document node fires a property change, this method will be invoked. This is how the component props document model reflects changes made by the user back into the javascript PropertyTree

Overrides:

onNodeChanged in class DocumentModel