Package com.inductiveautomation.perspective.gateway.model

Class DesignerComponentModel

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.perspective.gateway.model.ComponentModel

com.inductiveautomation.perspective.gateway.model.DesignerComponentModel

All Implemented Interfaces:

AuditingContext, Component, LoggingContext, PerspectiveElement, PropertyTreeOwner

public class DesignerComponentModel
extends ComponentModel

Backend instance of a component as it exists in a Designer, in order to allow special functionality not present in a typical running project (e.g., adding, removing components, etc).

Since:

8.0.0

Field Summary

Fields inherited from class com.inductiveautomation.perspective.gateway.model.ComponentModel

actions, addressPath, addressPathString, bindings, changeScripts, config, customMethods, extensionFunctions, log, messageHandlers, parent, properties, view

Fields inherited from interface com.inductiveautomation.perspective.gateway.api.Component

MDC_COMPONENT

Constructor Summary

Constructors

Constructor	Description
DesignerComponentModel(ViewModel view, ComponentConfig config, int[] addressPath, DesignerComponentModel parent)

Method Summary

Modifier and Type	Method	Description
void	alterEvents(EventConfigChange change)
void	alterPropConfig(PropertyConfigChange change)
void	alterScripts(ScriptConfigChange change)
protected List<ComponentModel>	children()	This method should always return a list containing all children, in the proper order.
protected PropertyTreePermissionModel	createPermissionModel(PropertyType scope, PropertyConfigCollection config)
DesignerPropertyReference	createPropertyReference(String referencePath, Consumer<PropertyTreeChangeEvent> subscriber, Set<Origin> acceptableOrigins)	Create a PropertyReference with this PerspectiveElement as the target.
Optional<Component>	getChild(int childId)
protected void	initChildren(List<ComponentConfig> configChildren)
protected com.inductiveautomation.perspective.gateway.model.ActionCollection	newActionHandler(EventConfig config)
boolean	removeChild(int addressId)
String	toString()

Methods inherited from class com.inductiveautomation.perspective.gateway.model.ComponentModel

dispatch, findChildByName, findCustomMethod, findExtensionFunction, fireEvent, focus, getAuditSnapshot, getBindingCount, getChildren, getComponentAddressPath, getComponentState, getLogger, getMdcParent, getModelDelegate, getName, getParent, getPropertyConfig, getPropertyTreeOf, getQualifiedPath, getTraceId, getType, getView, initProperties, mdcSetup, mdcTeardown, onShutdown, onStartup, refreshBinding, removeContextMenu, removeTooltip, requestContextMenu, requestPrint, requestTooltip, setName

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuditingContext

audit

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.Component

getPage, getSession

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.LoggingContext

mdc, mdcSetupTree, mdcTeardownTree, mdcWrap

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PerspectiveElement

getAuditProfile, isRunning

Constructor Details

DesignerComponentModel

public DesignerComponentModel(ViewModel view,
 ComponentConfig config,
 int[] addressPath,
 DesignerComponentModel parent)

Method Details

alterPropConfig

public void alterPropConfig(PropertyConfigChange change)

alterEvents

public void alterEvents(EventConfigChange change)

alterScripts

public void alterScripts(ScriptConfigChange change)

newActionHandler

protected com.inductiveautomation.perspective.gateway.model.ActionCollection newActionHandler(EventConfig config)

Overrides:

newActionHandler in class ComponentModel

createPermissionModel

protected PropertyTreePermissionModel createPermissionModel(PropertyType scope,
 PropertyConfigCollection config)

Overrides:

createPermissionModel in class ComponentModel

removeChild

public boolean removeChild(int addressId)

initChildren

protected void initChildren(List<ComponentConfig> configChildren)

Overrides:

initChildren in class ComponentModel

children

@Nonnull
protected List<ComponentModel> children()

Description copied from class: ComponentModel

This method should always return a list containing all children, in the proper order. Note that though all children are present and in the correct order, their index values may not be representative of their actual child ID (as is the case in the designer, where index and id diverge as changes are made to children).

Overrides:

children in class ComponentModel

Returns:

a list of child component models, which may be empty but will never be null.

toString

public String toString()

Overrides:

toString in class Object

getChild

public Optional<Component> getChild(int childId)

Specified by:

getChild in interface Component

Overrides:

getChild in class ComponentModel

createPropertyReference

@Nonnull
public DesignerPropertyReference createPropertyReference(String referencePath,
 Consumer<PropertyTreeChangeEvent> subscriber,
 Set<Origin> acceptableOrigins)

Description copied from interface: PerspectiveElement

Create a PropertyReference with this PerspectiveElement as the target.

Specified by:

createPropertyReference in interface PerspectiveElement

Overrides:

createPropertyReference in class ComponentModel

Parameters:

referencePath - the path to the property

subscriber - the subscriber - a Consumer of PropertyTreeChangeEvents

acceptableOrigins - the Set of Origins in which the subscriber is interested

Returns:

the PropertyReference