All Classes and Interfaces
Class
Description
About box with information and a listing of System properties
Filename: AbstractActionPanel.java
Created on Feb 05, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Basic scaffolding for a table with any of [add, edit, delet, up and down] buttons
Created by Colby on 8/10/2015.
If your component that you use as a popup implements this, it will be notified when it is shown and hidden.
Provides the plumbing to keep track of the overlay's components if the overlay is animated.
Created by Colby.Clegg on 12/14/2015.
Base class for painters.
Base class for any
Binding which should derive from AbstractLifecycleWraps up the logic of creating bindings and transform chains, and linking up the values as they get created,
eventually making their way back onto the target property.
Abstract implementation takes care of the bookkeeping required for event handling.
Base class for most block prototype implementations.
This workspace is a specialization of AbstractDesignableWorkspace for workspaces that want to use a
block-and-connector style of design.
Simple wrapper containing a BrowseTreeNode and the index at which the node occurs in this node.
JComponentHpr subclass for AbstractButtons.
This class is a simple JButton subclass to support Ribs archival and to support Ribs unified accessor model.
A JComponentShape for AbstractButton.
A tool class for AbstractButtons.
A panel that provides a border that reflects change state.
Convenience base-class for any object that wants to manage change listeners
Base class for all of the easy chart query objects that run through the QueryManager.
Deprecated.
Base class for all client module hook implementations.
Contains some common logic for a popup frame who is intended to be an editor for some aspect of a component,
such as bindings, property change scripts, and event configuration.
Must implement hashcode and equals
AbstractComponentEditorFrame.FrameManager<K extends AbstractComponentEditorFrame.FrameKey,C,E extends AbstractEditorFrame>
A Configurator is the ill-conceived name for the GUI that handles the configuration of a given data binding type
Like the AbstractPaletteItemGroupView, except that adds support for the capture button, add adds plumbing for
capturing
Created by carl.gould on 3/4/2015.
An abstract base class for sinks that use a data source to store data.
Created by colby.clegg on 11/17/2015.
Simple cursor implementation defers initialization until it begins being iterated through
This abstract workspace provides the "guts" of workspaces that use a drag-and-drop style interface.
Base class for all designer module hook implementations.
A simple framework for an action that runs some checks and displays the results in a little popup.
This subclass edits only one tag prop, and with that knowledge can handle some of the hasChanged/isOverridden stuff
for all sub classes.
This edge router takes care of taking the anchor lead points into account and adjusting all points to be relative to
the diagram.
Path maker that uses rounded corners
Basic path maker that just uses straight line segments
Superclass of any perspective popup editor frame.
Created by carl.gould on 3/31/2015.
Deprecated.
An evaluation container is used to group together and execute actors
The base implementation of a filter.
The base implementation of a filter.
Abstracts the style for the various "final" panels - expiration, restart, deleted
AbstractFunction simply implements some code to make the checking of arguments and generating of type mismatch errors
more abstracted.
Base class for all calculated pen datasources that are functions of another pen
An access control strategy that understands how to map the
PermissionType enum to the gateways' configured
required permissions far that type.
Base class for all gateway module hook implementations.
Class contains properties and methods not particular to ReportMill.
Abstract base class for historian implementations.
Provides a base level of functionality that should serve any type of history loader.
This can be a base for simple historical query executors.
Holds the datatype of a column.
Author: Perry Arellano-Jones
Year: 12May2015
This is the base class for all of our reporting components that prefer to render themselves using Java2D.
Base class to pretend to be a Python map, AKA a dictionary.
Base class to pretend to be a Jython "sequence", aka a Pythonic list.
This tool defines and installs a number of visual layout related actions.
Tree Node implementation which only populates its children upon demand.
An AbstractDialogPage that has additional information that is used to help
render the list of pages in a JIDE multi page dialog pane.
Deprecated.
Base class for a Map Transform.
Abstract base class for all menu merges that represent a collection, for example a menu or a toolbar, as opposed to a
single item.
The foundation for an expression parse context that tries to create a reference, but then delegates if the reference
isn't the type expected.
Base class to pretend to be a Jython "sequence", aka a Pythonic list.
Base TreeNode for the Designer's Project Browser tree.
Semantically, the "delete" operation gets used for a variety of different reasons.
A BaseAction that gets set up with the node selection prior to being shown
A simple extension that holds the last changed value.
Subclasses can add modifications to property descriptions through the property manager.
This abstract editor is the basis for the numeric editors.
Abstract base class which takes care of executing bindings which have a polling option in a thread-safe manner.
Slightly specialized version of AbstractComponentEditorFrame that deals with frames that are working with component
properties
Base class for all property editing pages.
A class used to model a resource as an immutable map of property keys to values.
A
JideMenu.PopupMenuCustomizer that builds menus off of a set of Property, provided by the subclass.Handles accepting drops onto a Jide property table
An abstract push notification listener that supports running on the EDT or the invoking thread.
Created by carl.gould on 3/4/2015.
Abstract base class for building query engines that support various types of querying
(raw, aggregated, and complex) over historical data.
Abstract base class for query options in the historian system.
AbstractQueryOptions.BaseBuilder<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>,B extends AbstractQueryOptions.BaseBuilder<K,T,B>>
Abstract base class for building
AbstractQueryOptions.This is a specialization of AbstractDeserializationHandler built for handlers that return false from
DeserializationHandler.supportsNestedElements() and are designed to be re-entrant (do not store any state).Filename: AbstractReportAction.java
Created on Feb 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: AbstractReportActionConfig.java
Created on Feb 05, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Simple subclass of AbstractNavTreeNode that has some functions for dealing with project resources represented by the
node
The AbstractHistoryNode implements the linked-list management for HistoryNodes.
To create RM vector images, we add
RMShape nodes to a root node.A DockableFrame that tracks the reporting workspace's selection, activating a UI only when a report's
design tab is visible.
Abstract base class for search objects that provide functionality for locating and managing event scripts
saved as resources within the designer context.
This provider can be instantiated and added multiple times for different script scopes.
Base class for perspective applications, whether that is a project running as a client, or a project being designed
in the designer.
Base class for
SessionKernel implementations.This class is a useful base class for most handle implementations.
Created by carl.gould on 7/17/2015.
The abstract base class for all data sinks.
Created by carl.gould on 7/21/2015.
Holds the query (a String), and a list of parameters and their types.
An AbstractStaticDrivenValue is a
DrivenValue which never changes.Provides UI components for editing the name of a step.
An abstract storage engine providing functionalities to store different types of data points
such as atomic, complex, and change points.
A simple base definition for SynchronizedStateProvider.
An
Transform which takes care of wrapping a blocking transform operation in a
CompletableFuture.This class is the base for a "page" of properties for a tag.
Created by colby.clegg on 12/24/2014.
This implementation simply takes care of the toString functions of TagPath.
This implementation simply takes care of the toString functions of TagPath.
Implements some common functions used by different tag query sources.
Ignition 8 tag scripting functions
This class extends Jide Menu in order to listen to the tag tree, to set
enabled state, and potentially re-configure selections.
A class that can acts as a 1.4 TransferHandler, and a 1.3 DropTargetListener all at once.
This class is a subclass of AbstractFPMIComponent that provides the basic bookeeping required for creating a cached,
buffered component.
An abstract subclass of PMIChartPanel that provides boiler plate code for some common FactoryPMI things such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
This is used for 'componentized' charts, such as the Meter and Thermometer, but not for the 'real' charts.
An abstract subclass of JComponent that provides boiler plate code for some common FactoryPMI things such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
Implementation of QualityMonitor
An abstract subclass of JPanel that provides boiler plate code for some common FactoryPMI things such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
Implementation of QualityMonitor
An abstract subclass of JScrollPane that provides boiler plate code for some common FactoryPMI things such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
Implementation of QualityMonitor
The superclass for all "shape" components used in the Ignition Vision module.
Action delegate used to configure accelerometer related actions and data collection from mobile devices
An exception that indicates that data source doesn't have permission to access data.
An action is something the user configures to respond in some way to an event being fired.
A component binding that will call a method when an action occurs.
Inner utility class used to wire
Action bindings.ActionConfig holds the configuration of a single action.
Special gson adapter to avoid extra fields when enabled is true or when the permissions are at their defaults.
Factory to create instances of Actions based on saved configuration
This registry holds the implementations of all known
Action types, keyed by action type-id (a string).The SFC Chart Element Editor for Action Steps
Factory for making new ActionScriptEditor Uis
Only care about doing something when the
ActivityLevel transitions from:
!Active => Active
Active =>!Active
but none of the other permutations? ActiveInactiveFilter is your man.A class that describes an active query
Tag actors are registered and organized according to their Classification.
Builder class for AdaptedQualifiedPath.
An adapter is essentially a rider on a component that affects or augments the component's normal behavior in some
way.
Deprecated.
Configuration properties for an Active Directory user source.
Algorithm for adding and removing items from lists and tables.
Defines an aggregation function that is defined in python.
Deprecated.
As of 8.3, use
ADHybridPropertiesResource instead.Configuration for the Active Directory/Internal Hybrid user source.
LDAP settings for the AD/Internal Hybrid user source.
Auth challenge that contains a username and AD domain to attempt an SSO login
Deprecated.
As of 8.3, use
ADtoDBHybridAuthPropertiesResource instead.This class is used to define the configuration properties for the AD to DB Hybrid user source.
UserSourceExtensionPoint implementation for the AD to DB Hybrid user source.Database settings for the AD to DB Hybrid user source.
LDAP settings for the AD to DB Hybrid user source.
Describes how the age of something (such as a historical tag value) is handled.
This interface defines an aggregation function used by the history query system.
Represents an aggregated data point with its value, quality, and aggregation information.
Builder class for constructing
AggregatedDataPoint instances.Represents an aggregated data point in the historian system.
A marker interface for processing aggregated data points.
Represents a key for querying aggregated data points.
A binary adapter for serializing and deserializing
AggregatedQueryKey objects.Represents the options for querying aggregated data points.
Builder class for constructing instances of
AggregatedQueryOptions.A binary adapter for serializing and deserializing
AggregatedQueryOptions objects.This class is an aggregate history query executor.
This is a ComponentTermFinder that simply delegates to a number of other term finders.
Some Aggregate types need the functions to be custom created with data from the passed in Aggregate.
Created by colby.clegg on 8/10/2015.
Dictates how multiple history values are "aggregated" together in order to form a result for a given time slice.
Represents an aggregation type used in the historian system.
Protobuf type
common.protobuf.AggregationTypePBProtobuf type
common.protobuf.AggregationTypePBExtends
PropertyBasedFunctionFactory to include various alarm related functions, such as isActive, isClear,
etc.A Condition implementation with the smarts to be able to search alarms in an AlarmConfiguration for a certain value
An alarm configuration is simply a set of AlarmDefinitions (that is, the definitions for various alarms) for a
specific object.
Keeps track of added, modified and removed alarm definitions.
An AlarmDefinition is the configuration of an alarm.
Protobuf type
common.protobuf.AlarmEnumPBProtobuf type
common.protobuf.AlarmEnumPB
com.inductiveautomation.ignition.common.alarming.config.AlarmMode
com.inductiveautomation.ignition.common.alarming.AlarmPriority
com.inductiveautomation.ignition.common.alarming.AlarmState
com.inductiveautomation.ignition.common.alarming.AlarmStateTransition
com.inductiveautomation.ignition.common.alarming.evaluation.EventPropertyType
Convenience class that can serialize the common alarm enums
The alarm evaluator is the unit that takes a value, and determines whether it is in alarm or not.
The alarm event transports all information about a particular alarm instance.
This parse context is built to work with a collection of events.
Alarm events normally exist as a single object in the system.
com.inductiveautomation.ignition.common.alarming.AlarmEventInstance
com.inductiveautomation.ignition.common.alarming.AlarmEventInstance
com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty
com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty
com.inductiveautomation.ignition.common.alarming.AlarmEvent
com.inductiveautomation.ignition.common.alarming.AlarmEvent
This expression parse context is basically the same as the
PropertyBasedExpressionParseContext, except that
it uses the AlarmBasedFunctionFactory that adds a few additional functions.This class provides a convenient way to build common alarm filters.
com.inductiveautomation.ignition.common.alarming.AlarmFilter
com.inductiveautomation.ignition.common.alarming.AlarmFilter
Protobuf type
gateway.protobuf.ConditionPBProtobuf type
gateway.protobuf.ConditionPB
com.inductiveautomation.ignition.common.alarming.query.conditions.DateTimeCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.DateTimeCondition
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.DISPPATH
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.DISPPATH
com.inductiveautomation.ignition.common.alarming.query.conditions.DisplayThenSourceCondition
Potentially contains a display path (StringPath) and a source path (QualifiedPath).
com.inductiveautomation.ignition.common.alarming.query.conditions.DisplayThenSourceCondition
Potentially contains a display path (StringPath) and a source path (QualifiedPath).
com.inductiveautomation.ignition.common.alarming.query.conditions.EnumCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.EnumCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PathCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PathCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.SOURCE
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.SOURCE
com.inductiveautomation.ignition.common.alarming.query.conditions.SourceOrDisplayCondition
Source paths (QualifiedPaths) and display paths (StringPaths) can be set in the filter.
com.inductiveautomation.ignition.common.alarming.query.conditions.SourceOrDisplayCondition
Source paths (QualifiedPaths) and display paths (StringPaths) can be set in the filter.
com.inductiveautomation.ignition.common.alarming.query.conditions.StringCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.StringCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.StringEnumCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.StringEnumCondition
Serializes and deserializes all the Fields and their Conditions defined in the AlarmFilter class
Basic interface for the AlarmJournal extension point.
Base interface for an Alarm Journal manager, which will manager any number of
AlarmJournalsProtobuf enum
DataTypeClassPBProtobuf enum
EventPropTypePBProtobuf type
JournalEventPBProtobuf type
JournalEventPBProtobuf type
JournalEventsPBProtobuf type
JournalEventsPBProtobuf enum
JournalSystemTypePBProtobuf type
PropValuePBProtobuf type
PropValuePBFilename: AlarmJournalQueryConfig.java
Created on Jul 16, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: AlarmJournalQueryConfigPanel.java
Created on Jul 17, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: AlarmJournalTableTermFinder.java
Created on Dec 20, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
The event handler interface for alarming events.
Bridge different types of config controllers for our needs
This class collects together static loggers for the Alarming system.
This is the central manager for alarming in Ignition.
These are the defined types of alarm conditions.
You may safely cast the module object for the "alarm-notification" module hook to this interface to gain
access to the alarm notification API.
No-op implementation of an AlarmNotificationProfile.
Deprecated.
This interface can be implemented by an AlarmProvider in order to expose pipelines for alarm notification.
The AlarmObserver interface defines the contract for subscribers that observe alarm events and state changes.
Why isn't this in DesignerHook? Because if the Vision module isn't present, Java
throws a hissy fit in the form of a ModuleLoadException for the whole alarm module.
This is an add-on interface that lets alarm events know when they're dropped from an alarm pipeline.
The priority of the alarm.
Alarm properties are the config units of alarms.
Handles serializing BasicAlarmProperties and also CommonAlarmProperties values
The AlarmProvider is an entity that operates on alarms and provides access to alarm state model
functionality.
This interface can be implemented by an AlarmProvider in order to provide the ability to query alarm status from a
different source than the main alarm state model maintained by the gateway.
This is the result of a query against the alarming system, for both status and history.
Returns a Dataset derived from an AlarmEvent query.
com.inductiveautomation.ignition.common.alarming.query.AlarmQueryResultImpl
com.inductiveautomation.ignition.common.alarming.query.AlarmQueryResultImpl
Acts as a mutable getter for the current alarm event that we are evaluating visual style for.
Holds an expression and a cell style.
This enum represents a single alarm state, generally the state that a particular event represents the transition to.
Filename: AlarmStatusTableTermFinder.java
Created on Dec 09, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
com.inductiveautomation.ignition.gateway.alarming.distributed.common.AlarmSubscriptionUpdate
com.inductiveautomation.ignition.gateway.alarming.distributed.common.AlarmSubscriptionUpdate
Deprecated.
Deprecated.
Dictates the tag's opinion as to when notifications should be generated.
The AlertNotificationProfileRecord defines the table structure all filters an AlertNotificationProfile will use
before any notification
The AlertSeverity describes the importance of the alert message
The AlertStorageProfileRecord defines the table structure all filters an AlertStorageProfile will
use before storing an alert
Defines the 4 classifications of alerts, along with their default render options
This ObjectInputStream will use the defined alias class when deserializing, or if not defined or class doesn't match
alias, then this ObjectInputStream will deserialize using the local class descriptor if the descriptor from the
serialized stream doesn't have an identical serial version UID.
Interface for enums whose name() isn't actually the value that should be used.
This compressor implements the SLIM1 algorithm.
Describes an anchor, for use with the BasicBlockUI.
An anchor point is a point on a block that is acceptable for either starting or ending a connector.
Holds an anchor point's block and anchor id
This class provides Swing GUI editing for anim agents.
This class provides Swing UI editing for shape animation.
This class provides Swing UI editing for shape animation.
This class provides Swing GUI editing for a shapes action script.
This is a com.jidesoft.grid.Property that represents a beans-style property from an RMShape that has been annotated
with the @ShapeProperty annotation.
Just a wrapper around an annotation instance to keep track of which method that annotation was found on
Represents an annotation in the historian system.
An Annotation represents data of a certain type, for a given path, for a given point in time or range of time.
Represents a change point for annotation changes.
A binary adapter for serializing and deserializing
AnnotationChangePoint objects.Deprecated.
Represents an annotation point in the historian system.
A builder class for constructing
AnnotationPoint instances.A binary adapter for serializing and deserializing
AnnotationPoint objects.A marker interface for processing annotation points.
Represents a query key for annotation data points.
A binary adapter for serializing and deserializing
AnnotationQueryKey objects.Represents the options for querying annotation data points.
Builder class for constructing instances of
AnnotationQueryOptions.A binary adapter for serializing and deserializing
AnnotationQueryOptions objects.Deprecated.
Deprecated.
Just a basic JLabel subclass that always paints with anti-aliasing on
Protobuf type
common.protobuf.AnyObjectPBProtobuf type
common.protobuf.AnyObjectPBA condition where any value contained in a set will pass.
Protobuf type
common.protobuf.AnyOptProtobuf type
common.protobuf.AnyOptThese routes are used by the web UI for status display.
These routes are used by the web UI for hand built reporting routes.
Manages the API Tokens configured in the system and exposes a method for validating HTTP Requests against API Tokens
configured in the system
Context object contains the name of the token associated with an HTTP Request as well as which security levels
are granted to the token
This is the main class for the ReportMill app.
This is the main class for the ReportMill app.
This is the main class for the ReportMill app.
This is the main class for the ReportMill app.
Filename: AppDescriptionTag.java
Created on Dec 14, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: FactoryPMI_SQLTags
Deprecated.
no reason originally specified
Deprecated.
no reason originally specified
Deprecated.
no reason originally specified
Various parts of the system allow operations to be filtered based on "scope".
Filename: AppTitleTag.java
Created on Dec 14, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: FactoryPMI_SQLTags
An interface for objects that are archivable.
Adaptation of the shared axis map class for reportmill style archiving
Determines how the operation should behave when strings are involved.
Created by colby.clegg on 7/11/2015.
This array decoder is meant to decode the body of array elements, where the type and length are specified by the
element type and an attribute, respectively.
This delegate will serialize an array of any type.
The array element simply provides an array of the values provided by sub-elements.
An array function is not one of the built-in PDF function types.
A simple structure that holds an index into a single or double column array.
Supports temporary read and writes to ClientTag array members.
Created by colby.clegg on 7/17/2015.
Standard connection painter that traces the path with a 2px stroke, and draws an arrow at the end
Deprecated.
Created by Colby.Clegg on 12/14/2015.
Created by Colby.Clegg on 12/14/2015.
Created by Colby.Clegg on 12/14/2015.
Factory for making new AssertionStepEditor Uis
Created by Colby.Clegg on 12/14/2015.
Created by Colby.Clegg on 12/14/2015.
This class provides a TagHistoryQueryInterface for an associated historical provider.
A* algorithm implementation using the method design pattern.
An AsyncClientTask is a task that can be executed through the client progress manager.
Any tree node that loads it's children asynchronously, meaning that a call to getChildCount() might not return the
true number immediately, but then soon after fire a tree event on itself when loaded.
The AsyncWriteValue interface is used for writing values asynchronously.
A wrapper around WriteRequest that adds the functions defined by AsyncWriteRequest.
This is the primary history actor, it stores data for a single source.
Represents an atomic data point in the historian system.
A binary adapter for serializing and deserializing
AtomicPoint objects.The
text can have multiple segments with different attributes applied to them.Base style used in the declaration's block.
Specifies the span of a text that should have a specific
AttributeSet applied to it.This class manages the attributes panel which holds the color panel, font panel, formatter panel and keys panel.
This class manages the attributes panel which holds the color panel, font panel, formatter panel and keys panel.
This inner class is a RJColorPanel suitable for manipulating colors in current RMEditor.
This class is used to paint custom attributes in the
AttributeTextPane.This interface is used to paint custom attributes in the AttributeTextPane, for use specifically with
AttributeTextPaneLabelView.Data component that can be attached to an
Entity that represents information about when an entity was
last modified and by whom.Context in which an audit log record may be written
Convenience object - if you're building audit records from some DB query, this will create them for you.
Deprecated.
since 8.3.0, will be removed.
An extension point for defining new types of audit profiles.
A record about a single audit event
Deprecated.
Deprecated.
Protobuf type
AuditEventPB.AuditRecordPBDeprecated.
Protobuf type
AuditEventPBDeprecated.
Deprecated.
Protobuf type
AuditQueryPBDeprecated.
Protobuf type
AuditQueryPropsPBProtobuf type
AuditQueryPropsPBProtobuf type
AuditRecordPBProtobuf type
AuditRecordPBProtobuf type
AuditRecordsPBProtobuf type
AuditRecordsPBSome stuff used to rely on StatusCode#getRawValue() and StatusCode#toString(), but now StatusCode
isn't available for use.
This wrapper class is used to hold an arbitrary GSON serializable payload, _or_ an object equivalent to a
GatewayException that can be handed over the wire.
This event is fired when an authentication challenge is completed by the user.
Representation of the result of an authentication challenge.
Representation of a failed authentication challenge result.
Representation of the result of an authentication challenge which failed due to the user cancelling the
authentication challenge.
Representation of the result of an authentication challenge which failed due to a generic error.
Representation of the result of an authentication challenge which failed due to a timeout.
Representation of a successful authentication challenge result.
Immutable representation of an authentication challenge request
Provides a fluent-API (builder-style) pattern for creating new
AuthChallengeRequest objectsA
JsonSerializer and JsonDeserializer implementation for serializing and de-serializing AuthChallengeRequest objects to / from JSON using GSON APIs.Represents a tab for editing authentication challenge scripts.
com.inductiveautomation.ignition.common.user.AuthenticatedUser
com.inductiveautomation.ignition.common.user.AuthenticatedUser
Failover mode for an authentication operation.
com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord
com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord
Utility methods useful for Auth
JTree that works with AbstractTreeTransferHandler to support automatic scrolling when dropping items on it.
Implementation of Type 2 shadings, which vary color along a linear axis.
Config object for classic chart axis
An encoded representation of a badge auth challenge.
Deprecated.
since 8.3.
Deprecated.
This class handles editing of rectangle shapes.
Filename: BarcodeTool
Author: Perry Arellano-Jones
Created on: 7/9/15
Project: ignition_dev_7_8B
Encodes and decodes to and from Base64 notation.
Encodes and decodes to and from Base64 notation.
A
Base64.InputStream will read data from another
java.io.InputStream, given in the constructor,
and encode/decode to/from Base64 notation on the fly.A
Base64.InputStream will read data from another java.io.InputStream, given in the
constructor, and encode/decode to/from Base64 notation on the fly.A
Base64.OutputStream will write data to another
java.io.OutputStream, given in the constructor,
and encode/decode to/from Base64 notation on the fly.A
Base64.OutputStream will write data to another java.io.OutputStream, given in the
constructor, and encode/decode to/from Base64 notation on the fly.Base action implementation that helps actions hook into the i18n framework.
Deprecated.
Use com.inductiveautomation.ignition.client.util.action.BaseAction instead.
Base class for most text entry fields.
The base class of all functions, includes blank implementations of some of the methods from Function that aren't used
by many functions, like the connect/startup stuff.
com.inductiveautomation.ignition.common.alarming.BasicAlarmEvent
com.inductiveautomation.ignition.common.alarming.BasicAlarmEvent
com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties
com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties
Note that com.inductiveautomation.ignition.common.alarming.config.AlarmProperty is an interface.
Note that com.inductiveautomation.ignition.common.alarming.config.AlarmProperty is an interface.
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty
com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties
com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties
Deprecated.
com.inductiveautomation.ignition.common.user.BasicAuthenticatedUser
com.inductiveautomation.ignition.common.user.BasicAuthenticatedUser
This is the "reference" UI used by the alarm pipeline editor.
com.inductiveautomation.ignition.common.config.BasicBoundPropertySet
com.inductiveautomation.ignition.common.config.BasicBoundPropertySet
The Property objects used as the keys in the BasicBoundPropertySet map
The Property objects used as the keys in the BasicBoundPropertySet map
com.inductiveautomation.ignition.common.config.BoundValue
com.inductiveautomation.ignition.common.config.BoundValue
com.inductiveautomation.ignition.common.config.BasicConfigurationProperty
com.inductiveautomation.ignition.common.config.BasicConfigurationProperty
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalPropertyWrapper
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalPropertyWrapper
Used internally in com.inductiveautomation.ignition.gateway.gan.protoserializers.tag.BasicConfigPropModelSerializer
Used internally in com.inductiveautomation.ignition.gateway.gan.protoserializers.tag.BasicConfigPropModelSerializer
Basic implementation of Connection
The SpringPanel is the container for FactoryPMI.
com.inductiveautomation.ignition.common.BasicDataset
com.inductiveautomation.ignition.common.BasicDataset
com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
com.inductiveautomation.ignition.common.sqltags.model.scripts.BasicTagEventScripts
com.inductiveautomation.ignition.common.sqltags.model.scripts.BasicTagEventScripts
The ExecutionEngine is a wrapper around a scheduled executor service.
This basic function factory extends
AbstractFunctionFactory in order to implement the
ExpressionFunctionManager interface, making it mutable.A basic implementation of IGridSettings with settable values.
The basic historical record represents a specific query with columns of data.
Deprecated.
This general purpose information class has a name, and then a set of named properties and stat metrics.
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel
Protobuf type
common.protobuf.ClassifiedChildPropPBProtobuf type
common.protobuf.ClassifiedChildPropPB
Used to represent
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel.ClassifiedProperties
in BasicMutableConfigurationPropertyModel
Used to represent
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel.ClassifiedProperties
in BasicMutableConfigurationPropertyModel
This is the basic serializable version of the configuration property model.
An extremely simple thread-safe object pool backed by a LinkedList.
Basic struct-style implementation of OPCBrowseElement
A basic implementation of
Property.Value condition appropriate for use with simple Properties that have a single String-able value or numeric value.
com.inductiveautomation.ignition.common.config.BasicProperty
com.inductiveautomation.ignition.common.config.BasicProperty
A collection of properties and values.
com.inductiveautomation.ignition.common.config.BasicPropertySet
Protobuf doesn't allow a map key to be an Object, so we can't implement the BasicPropertySet map directly.
com.inductiveautomation.ignition.common.config.BasicPropertySet
Protobuf doesn't allow a map key to be an Object, so we can't implement the BasicPropertySet map directly.
Swaps the property name for a new one, doesn't affect the value.
The basic implementation of QualifiedValue.
Deprecated.
Protobuf type
common.protobuf.BasicQualifiedValuePBProtobuf type
common.protobuf.BasicQualifiedValuePBDeprecated.
Protobuf enum
common.protobuf.BasicQuality_LevelPB
com.inductiveautomation.ignition.common.model.values.BasicQuality.
com.inductiveautomation.ignition.common.model.values.BasicQuality.
Most common implementation of RedundancySnapshot.
A TreeCellRenderer that renders trees full of RenderableTreeNodes.
A basic implementation of Result that can be used for browsing operations.
Protobuf type
common.protobuf.BasicResultPB
com.inductiveautomation.ignition.common.browsing.BasicResult
Protobuf type
common.protobuf.BasicResultPB
com.inductiveautomation.ignition.common.browsing.BasicResult
Protobuf type
common.protobuf.DisplayPathPBProtobuf type
common.protobuf.DisplayPathPBA basic implementation of the
Role interface.Deprecated.
Basic implementation of StreamingDatasetWriter that simply writes each row into an in-memory datastructure ( a List )
Contains the local config changes of a tag.
This class combines a single tag's configuration (the "local" propertyset) with any inherited configuration.
com.inductiveautomation.ignition.common.tags.config.BasicTagConfigurationModel
com.inductiveautomation.ignition.common.tags.config.BasicTagConfigurationModel
com.inductiveautomation.ignition.common.tags.config.BasicTagConfiguration
com.inductiveautomation.ignition.common.tags.config.BasicTagConfiguration
com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams
com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams
Deprecated.
Deprecated.
com.inductiveautomation.ignition.common.sqltags.BasicTagPermissions
com.inductiveautomation.ignition.common.sqltags.BasicTagPermissions
Protobuf type
common.protobuf.ZoneRolePBProtobuf type
common.protobuf.ZoneRolePBDeprecated.
A basic implementation of the
TransactionSet interface.A translation package holds the keys and one or more translations for the keys.
com.inductiveautomation.ignition.common.user.BasicUser
com.inductiveautomation.ignition.common.user.BasicUser
A basic implementation of OPCWriteRequest.
Configuration for batching
Legacy implementation of data synchronizer using ID-based synchronization.
A BatchOperation collects together a set of operations that should be executed together as a batch.
Batches receive events based on the
BatchStrategy and forwards to the next stage.Defines how BatchStage interacts with custom BatchStrategy.
A writer interface for writing batches of data to a data store / sink.
The tree cell renderer for the
ComponentPropertyTreePanelThis is a thin wrapper around BeanInfo, which has some more helpful conveniences for calling getters and setters
without all the syntax noise
A wrapper for the Introspector to return instances of BeanInfos.
An
ExpressionParseContext that creates expressions which reference the properties on an object using the
bean-style naming pattern to look up the getter.The SFC Chart Element Editor for the Begin Step
Factory for making new BeginStepEditor Uis
Just like DataInputStream but uses buffered reads for readInt and readShort
This layout manager fixes wonky width calculation in the normal scrollpane layout
An output stream that mirrors all output on 1 or more child output streams.
A functional interface for serializing and deserializing a value to and from binary.
Marks the annotated field or type as bindable.
A model that can have bindings applied to it.
A property editor that allows for control over whether or not binding is enabled.
Contains references to subscriptions and
EventListeners for usage in conjunction with the mvvm binder
classes.A binding is associated with a target property and shares the lifecycle of the component (or shorter, in the
designer-scope sessions).
This class maps a UI node value to a model key value (some kind of display object like a Swing component value or
an RMShape size).
Interface for Binding objects.
Since different kinds of objects may use different subclasses of AbstractBindingHarness,
this factory is provided to instantiate the actual harness instances required.
A marker interface that marks POJOs that represent the whole configuration for a binding, but have to logic
themselves.
Wraps up all of the various bits and pieces that a binding factory needs to create a new binding for a component's
property, given a binding interchange spec
A
BindingContext holds information about how to bind various parts of a Java Object.This frame holds the configuration and preview panels for a single binding (including tranforms)
This frame holds the ItemSelectionPanel that lets the user pick between the various binding types, or clear the
binding entirely.
A runtime exception for when a binding fails to bind or fails to perform.
Custom expression editor that adds browse tags and browse properties buttons
Created by carlg on 1/26/2017.
Describes a single parameter that will be used in an extensible BindingType
Contains the functions needed for a binding parameter's editor to display a popup-tree so that the user can
browse for the possible values for this parameter
Created by carlg on 1/26/2017.
All
Bindings are called when ModelUpdates.ALL is called.A binding type describes and implements a custom binding.
Interface for classes that perform wiring of bindings.
Contains various static functions used to create bindings
This class allows for the execution of the unary bitwise complement (aka NOT) operator in Expression Language.
Represents an observable block
Action handler for cut/copy/paste/delete of block workspaces
A JPanel used to display a block.
A BlockContext provides some information about a specific aggregation "block", or window of time,
but it also provides a spot for aggregation functions to store data for the window, if they want.
A model of a block diagram.
Extension of Callable that supports being canceled.
Helps to manage threading for a series of tasks.
A class to represent a bookmark.
Created by colby.clegg on 8/24/2015.
Created by Colby on 5/2/2015.
Created by carl.gould on 1/29/2015.
Stores a subset of information for a gateway which will be launched after a restart or retarget.
Field used by the json editor.
A panel that has a main component and can have helper components.
Used to bind a UI control to a model property, where property is meant in a strict
Java sense.
Inner utility class to simplify figuring out how to display null values in controls.
Inner utility class that performs the runtime wiring of all bindings in this package.
com.inductiveautomation.ignition.common.config.BoundExtendedPropertySet
com.inductiveautomation.ignition.common.config.BoundExtendedPropertySet
A binding for an interface component that has an extent (setExtent/getExtent methods).
Inner utility class that performs the runtime wiring of all
BoundExtent bindings.Creates a JPanel with
JTextField, JideButton to launch binding-path browser, and a notification
icon that reports the validation status of the field's String.A binding for an interface component that has a location (setLocation/getLocation methods).
Inner utility class that performs the runtime wiring of all
BoundLocation bindings.This is an expression that is bound to a property value in a given PropertyValueSource.
An interface that marks a component that wants to handle its own bounding box, rather than use the bounding box from
Swing/JComponent.
Inner utility class that performs the runtime wiring of all
BoundSelection bindings.Holds a single, generic value bound to a property or tag
A BoundVariableExpression (abbrv BVE) is the main workhorse of the expression language.
Represents a debugger break point for a project file.
Used as a stand-in when a binding factory fails to produce a valid binding instancee.
Browsable is the elementary object of the gallery browser.
A BrowsableLibrary is the model for a browsable gallery
This is a filter for our common browsing framework.
Serializable version of PropertyValue
This filter class allows for the definition of one or more potential filters for a specific type id.
A binary adapter for serializing and deserializing
BrowseFilter objects.
com.inductiveautomation.historian.common.protobuf.BrowseFilter
com.inductiveautomation.ignition.common.browsing.BrowseFilter
com.inductiveautomation.historian.common.protobuf.BrowseFilter
com.inductiveautomation.ignition.common.browsing.BrowseFilter
Protobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.NameFilterPBSubclass of the
BrowsePropertiesButton that has the handling for converting the selected property into
a python access snippet.The BrowsePublisher interface provides a mechanism to manage and handle
the browsing of hierarchical structures.
Provides a builder interface for configuring and adding nodes to the browsing structure.
Filename: BrowserComponentTermFinder.java
Created on Apr 21, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Ignition_77
AbstractAction which clears the selection of the current Perspective Editor.The BrowseResultProperties class serves as a container for predefined
Property instances
used to describe various properties of a browsing result.Deprecated.
com.inductiveautomation.ignition.common.browsing.BrowseResults (deprecated class)
com.inductiveautomation.ignition.common.browsing.BrowseResults (deprecated class)
BrowserLauncher is a class that provides one static method, openURL, which opens the default web browser for the
current user of the system to the given URL.
AbstractBrowserModel - A public interface for controlling a browser.
This panel contains the JxBrowser's Browser.
Model for a Perspective client dependency (aka - browser runtime dependency) required by one or more components.
A browser class.
The browser model interface.
com.inductiveautomation.ignition.common.tags.browsing.BrowseValue
com.inductiveautomation.ignition.common.tags.browsing.BrowseValue
BufferedMarkupHandler - a PDFMarkupHandler (and Java2DMarkupHandler) that renders PDF into an image.
BufferedMarkupHandler.
This class represents a build error (or warning) for a file.
This class is a Border that simple delegates to the UIManager's version of "Button.border" Since button borders are
typically tricky, and will only actually paint on real buttons, if this is used on a non-button, this class will use
a dummy button so that the border is drawn regardless.
Encodes an Object to byte[].
A pool of byte[].
This class takes multiple datasets and represents them through a single unified interface.
A cache bucket holds data for a certain range.
Convenience object that encapsulates proper caching logic for holding onto a Component reference
This key is our "first layer".
Deprecated.
Deprecated.
These are the settings for the cache.
Second Step.
Holds actions and implementation for constructive area geometry functions that deal with shape components.
This is an interface that is used on some properties to indicate that they are actually "calculated" property,
derived from the values provided in a property set.
An on-the-fly roster used in scripting for Alarm Notification Pipelines
Used to construct a list of dictionaries that represent Users.
This is the most general-purpose implementation of a history node.
This writer writes in the format "Timestamp, TagPath, Calc1, Calc2, Calc3..."
An annotation to mark that a method should be called when the bound model updates
in a specific way.
Utility class that performs the wiring for
CallOnUpdate annotations.Marker interface for option enums to indicate that their names should be converted from camel case before use
Scheduling interface which provides a command to cancel a scheduled task.
A ChangeListener, PropertyChangeListener, ActionListener, and DocumentListener and ItemListener all in one that
calls onChange() for everything.
Category is the elementary object of the gallery categories.
This shape is used as the bar chart component for the reporting module.
UI for customizing the reporting pie chart shape.
Basic category dataset implementation backed by an Ignition Dateset
This provides static methods to convert comma delimited text into a
JSONArray, and to covert a JSONArray into comma delimited text.
Provides ReportMill UI editing for CellDivider shape.
Specifies a region in a
ListCellRenderer or @link javax.swing.TableCellRenderer} that can be
interacted with.Handles event that occur on a cell region.
Flagging interface for items that participate in cell regions.
Builder for creating a list of cell regions.
Handles cell regions in a JTable or JList.
Used in conjunction with
CellRendererStateSupport to manage different icon states: Selected, Unselected,
Disabled.When creating a cell renderer that has more than one component to manage state of (such as a
JLabel for
the icon, and a JTextArea for the text), this class can be used to coordinate the cell states so
that all the components are in sync: the correct background and foreground for the selected state, eg.This class provides support for UI editing of RMCellTable shapes.
Provides Swing UI editing for RMCell shapes.
A simple, strings-only representation of a cell update spec
A layout manager to simply center a component.
A property resolver that looks first in one resolver, then in another.
Created by carl.gould on 8/14/2014.
A Runnable class that takes an iterator of change listeners and a tag change event and will notify all of the
listeners when run.
Modifications to resource collections are defined as a series of ChangeOperations.
Represents a change point in the historian system.
Protobuf type
common.protobuf.AnnotationChangePointPBProtobuf type
common.protobuf.AnnotationChangePointPBProtobuf type
common.protobuf.SourceChangePointPBProtobuf type
common.protobuf.SourceChangePointPBRepresents a change point type in the historian system.
This interface describes a character stream that maintains line and
column number positions of the characters.
This interface describes a character stream that maintains line and
column number positions of the characters.
This interface describes a character stream that maintains line and
column number positions of the characters.
Dummy context used to test expression syntax
Created by carl.gould on 7/14/2015.
Created by carl.gould on 6/16/2014.
com.inductiveautomation.sfc.scripting.ChartInfo
com.inductiveautomation.sfc.scripting.ChartInfo
A ChartObserver is notified when the chart or chart elements change state.
A tree combo box that allows for selection of an SFC path.
Accepts a flat Chart Scope dataset and creates a view of datasets with category headers.
com.inductiveautomation.sfc.ChartStateEnum
com.inductiveautomation.sfc.rpc.ChartStatus
com.inductiveautomation.sfc.rpc.ChartStatus
Protobuf enum
sfc.protobuf.ChartStatusPb.ElementStateEnumPbProtobuf type
sfc.protobuf.ChartStatusPb.ElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.ElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.ParallelElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.ParallelElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.StepElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.StepElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.TransitionElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.TransitionElementStatusPbThis is the root of the object hierarchy which is serialized into the project resource, it represents the chart as it
is displayed in the UI.
Second Step on a restart operation.
Data component that can be attached to an
Entity for entities that have children.This class choose an OPC item by browsing through a SQLTags provider.
A file to represent a Java class.
This class puts up the splash screen.
Serves as a bidirectional mapping between classes and their names.
A data source that pulls from the class path.
A set of Dataset utilities that are specific to the Vision client, e.g.
These are DB utilities that are common to the client system as a whole (designer, client)
In the client, functions are serialized into the bindings.
Handles client event scripts, working with
WindowWorkspace and resource-specific ResourceEditors.Enum that maps client script resource types to their corresponding editor
The client (and designer's) function factory.
This is the hook that gets called from the client bootstrap launcher.
A static collection of listeners that will be notified when the client is shutdown.
Represents the object POSTed to /logs by the client's jsnlog.js system.
Deprecated.
The main hook into a module's client scope.
Reflectively destroys the thread locals held onto by the Py class - used to avoid memory leak
Implementation of property tree privacy that understands the flags set for properties stored in prop configs
Well-known ids for Ignition platform functionalities.
This class streamlines printing tasks by capturing component snapshots and converting them into Java BufferedImages.
Deprecated.
Since 8.3.0; create a
Task if you want platform managed UI for an asynchronous task.This repaint manager lets use have components opt-into a coalesced repaint mode, where their repaint requests
are translated as repaint requests on their parent for their location.
Represents a session for a Designer or Vision Client.
The Client half of the negotiation of RPC payloads between the gateway and clients/designers.
Folder node for managing multi-event client scripts of the specified resource type.
Filename: ClientScriptingFunctions.java
Created on Mar 27, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Represents a node in the navigation tree specifically for client script configurations.
Created by carlg on 11/23/2016.
A ClientStepFactory is responsible for creating StepView objects given their associated StepConfig objects.
The ClientStepRegistry is where you need to add your ClientStepFactory to add a step.
Both client and designer hooks will be an instance of this interface
Subinterface of Tag, a Client Tag adds integrated change listening, and adding/removing tags.
This represents a tag provider in the client.
This class manages subscriptions between the tag system to the gateway.
The goal of this class is to 1) deliver property change events on the EDT and 2) Not let slow prop change events
cause a build up of new changes
Some utility methods for Snap.
Deprecated.
Moved to package com.inductiveautomation.ignition.client.util in Ignition 8.0.5
A ReentrantLock that supports Java 8 AutoCloseable.
A panel that wraps contents and puts a close button in the upper right corner.
Provides information about the current state of the connection to the other node.
CodeEditor is a panel that includes a syntax highlighting text area that wraps
RSyntaxTextArea.An
EditActionHandler for CodeEditors
which takes care of the basic Copy / Cut / Paste / Delete actions.A factory for creating code editors, based on
CodeEditor.Action that will collapse all panes of a collapsible pane palette
Class is used to render a cell with a dropdown icon to the right.
Represents the context for a data collection operation for use with a
DataCollector.First step of the step builder, requiring collection ID to be set.
Final step of the step builder, allowing optional parameters to be set.
Third step of the step builder, requiring value origin to be set.
Second step of the step builder, requiring collection source to be set.
Key constants for standard context properties
Enum representing the collection mode of the
DataCollector.Represents a unique identifier for a data collector.
Simple component used for editing colors.
Created by carl.gould on 7/21/2015.
Class displays a grid of color swatches.
This class represents a color state, one color, possibly with an alternate (blink) color and a blink rate
An interface used as a callback when the popup variety of the ColorStateConfig is used.
Small rectangular component that displays a color, and when pressed, shows a popup editor.
Provides a color swatch, which is a square of a specific size.
This class contains meta data used for rendering a column.
This subclass of BasicDataset knows how to populate itself based on a Map<String, ? extends ColumnAttribute>
Helper class that can create a Map<String, ? extends TableColumnAttributes> out of a dataset.
This panel is the table used for each column's options.
These names of these values really correspond to parameter directions, but for consistancy we're using them for
everything- for example, "OUT" indicates READ-ONLY.
A DataSet which is essentially a view on a underlying DataSet.
Created by carl.gould on 8/11/2015.
This class defines a particular column in our query.
If a
JComboBox contains combo items that need to be rendered to a specific String.These are many of the properties that are used throughout the alarming system, provided/known by Ignition.
CommonBeanInfo is the base class of all BeanInfo classes used by the Vision module.
The base interface for all Ignition contexts (Gateway, Designer, and Vision Client), consolidating common
functionality available from any context.
Simple abstract decorator for
CommonContextAbstract base class which takes care of some boilerplate for handling edit
actions of
Components.This mouse listener and mouse motion listener implements logic to make handling mouse drags easier.
These are well-known properties that are common across the system, and are used in a variety of situations.
Created by colby.clegg on 2/2/2015.
A collection of static methods and constants to make the UI uniform.
Utility to perform string comparisons that sort in a human-readable order (e.g.
An enum listing the possible comparison operations.
com.inductiveautomation.ignition.common.ComparisonOperator
This represents a tag event script that has been compiled for execution.
This represents a tag event script that has been compiled for execution.
This class is an
EntityId for an instance, that also specifies the entity id of a member element.Represents a complex point in the historian system.
A marker interface for processing complex points in a query.
Protobuf type
common.protobuf.AnnotationPointPBProtobuf type
common.protobuf.AnnotationPointPBProtobuf type
common.protobuf.ComplexPointPBProtobuf type
common.protobuf.ComplexPointPBProtobuf type
common.protobuf.MetadataPointPBProtobuf type
common.protobuf.MetadataPointPBRepresents a complex point type in the historian system.
Represents a query key for complex data points.
Protobuf type
common.protobuf.AnnotationQueryKeyPBProtobuf type
common.protobuf.AnnotationQueryKeyPBProtobuf type
common.protobuf.MetadataQueryKeyPBProtobuf type
common.protobuf.MetadataQueryKeyPBRepresents options for querying complex points.
Protobuf type
common.protobuf.AnnotationQueryOptionsPBProtobuf type
common.protobuf.AnnotationQueryOptionsPBProtobuf type
common.protobuf.MetadataQueryOptionsPBProtobuf type
common.protobuf.MetadataQueryOptionsPBThe ComplexTagDefinition is the primary implementation of ComplexTag.
Interface for component instances.
This class represents the configuration of a Component at a specific location in a running
DesignerViewModel.A Gson serializable representation of a Component definition.
Custom GSON serializer used to omit empty stuff to keep the serialized components small as possible.
This interface represents the component model that is registered with
ComponentRegistry.Component implementors may choose to provide an implementation of this interface in order to provide a more custom
design experience for their component.
DesignDelegates may contribute buttons to the workspace's toolbar when the the component type is the current
deep selection.
Gson-compatible class that wraps up the details that the designer retrieves from the js bridge about a selected
component.
Describes an event that a component might fire.
This isn't meant to be an exhaustive list, just commonly referenced components
Components that implement this interface will get started up and shut down when their containing window is first
displayed and closed, respectively.
The model for a running client component, of which many may exist forming the complete component tree for a running
DesignerViewModel;A ComponentModelDelegate is created when its
ComponentModel owner is created.Functional interface for a factory method which creates
ComponentModelDelegatesA Registry for
ComponentModelDelegateFactoriesBasic
ComponentModelDelegateRegistry implementation, backed by concurrent collection types for safety.This object is used when a python script references a perspective component.
Delegates to the actual component, this prevents the scripting system from being able to call everything
on ComponentModel, like startup(), shutdown, etc.
Fired on the
ViewModel's EventBus when a component's name changesCreated by carlg on 6/13/2017.
Represents a path to a component, supporting the logic needed to derive the most appropriate relative path to
reference one component from another.
A popup menu that holds many of the actions that act upon the current selection.
Used to attach a light weight popup window containing a
JComponent to a JButton.If the content component needs to sit within a panel for layout reasons, this class can provide a panel
that can be used to contain the content component, while providing easy access to the component.
To create an instance of this class use
To create an instance of this class use
ComponentPopupSupport.createContentPanel()The handler for the popup.
Specifies how the popup should be oriented relative to the popup owner.
The basic term finder looks through all properties of the bean for standard string based translatable properties.
Document model that knows how to write values back to the underlying property tree
Registry of all perspective components.
A component restriction represents a type of security restriction that can be applied to a component.
Created by Carl.Gould on 9/1/2015.
A JsonEditor that edits a specific scope of properties for the current selection
This is the frame for editing scripting on components.
Record class that represents an OpenAPI
Components Object
Created by carlg on 6/13/2017.
Locates translatable terms on a component.
Visits BindingRoots, initializing them.
Visits ComponentLifecycles, shutting them down.
Visits ComponentLifecycles, starting them up.
Visits TemplateHolders, calling initTemplate() on them
Counts up the number of each template that will be needed on initialize, and then can pre-load instances for
templates that will be needed more than once.
Visits DynamicPropertyProviders, initializing their UDTProperties.
A composite property set holds multiple other property sets, and loops through them to find properties.
A record that contains references to two other ScheduleProfileRecords
A composite
RpcSerializer that delegates to different GatewayRpcSerializer implementations based on
the package ID of the RpcCall, falling back to a general serializer otherwise.Provides the ability to create ProgressListeners that get coalesced into a
single BoundedRangeModel.
Use this annotation on any ShapeProperty that you want the property reflection to descend into and discover
sub-properties.
In charge of updating the various UI buttons / popups relating to tracking what other Designer sessions are doing
A condition returns true/false for whether a value passes.
A condition returns true/false for whether a value passes.
Represents a condition that is part of a SQL where clause.
This condition subclass represents a list of conditions.
A class to parse a condition string and return a condition.
Convenience class for ensuring that a json object structure has expected members in it.
Annotate a shape with this if it requires a custom UI for configuring the shape in addition to the properties table.
Collection of utility methods to encode and decode resource collection and related objects to/from JSON.
com.inductiveautomation.ignition.common.config.ConfigurationProperty.CustomEditorDescriptor
com.inductiveautomation.ignition.common.config.ConfigurationProperty.CustomEditorDescriptor
Holds the editor table and custom property button.
com.inductiveautomation.ignition.common.config.ConfigurationProperty.Option
com.inductiveautomation.ignition.common.config.ConfigurationProperty.Option
JPanel can be added to the configuration panel of a ScriptableChart to enable users to edit the chart's
configuration script
The ConfigurationManager is the primary interface for interacting with the configuration of a Gateway.
An extension of
DescriptiveProperty that also provides a list of the possible values for the property as
well.Configuration properties can define custom editors.
The ConfigurationPropertyModel is a transferable (serializable) model of properties.
An abstract property editor that automatically adds the dynamic property binding button.
Represents a directed connection between anchorpoints on two blocks.
Listens to the GatewayConnectionManager to monitor gateway connection health, notifying the designer when the
connection is poor
Used to, well, paint connections of course! See
AbstractBlockWorkspace.newConnectionPainter(BlockDiagramModel)Created by colby.clegg on 5/27/2015.
Different from the ConnectionListener in the sense that this listener is intended for use in redundant setups,
where the status of the inactive connection must be updated along with the status of the active connection.
First step.
com.inductiveautomation.ignition.common.user.ContactInfo
com.inductiveautomation.ignition.common.user.ContactInfo
Record class that represents an OpenAPI
Contact Object
Represents a method of contacting a user.
com.inductiveautomation.ignition.common.user.ContactType
com.inductiveautomation.ignition.common.user.ContactType
Holds a name and a class of a component.
It's a List<Object>, with a name!
Many custom function factories get cached, but when delegating to the factory provided by the context, that shouldn't
happen.
Context managers are Python's equivalent of the `try-with-resources` statement - you (generally) open one with the
with statement, and it will automatically close any opened resources, even if your code throws an exception.
Event for whenever a property in a PropertyTree changes.
Convert a web browser cookie specification to a JSONObject and back.
Convert a web browser cookie list string to a JSONObject and back.
A thin shim around the base
CookieManager to allow setting the policy via a string, and
retrieving it as such.Marker interface that indicates the object (and its subclasses, obviously) can be cloned reflectively through a copy
constructor.
See
See
CloneUtil for a function to do this.Used only for client tags.
This interface is used for objects that may contain 0 or more items, when we want to know (mostly) whether the
collection is empty or not.
Created by colby.clegg on 11/3/2015.
A delegating DataSource that maintains a count of all update-style queries that go through it.
A simple FilterOutputStream that calculates a checksum as data is written to the underlying stream
A simple FilterOutputStream that calculates a checksum as data is written to the underlying stream
Use to add context to a HealthCheck and include it on the Ignition Gateway's Diagnostic Overview page.
Filename: CrossPlatformAlloyLookAndFeel.java
Created on Mar 16, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Ignition_7.7
This class provides GUI editing for RMCrossTab.
A simple implementation to act as an example for the new TSDB2 Historian interface.
Deprecated.
A very simple CSV parser released under a commercial-friendly license.
A very simple CSV reader released under a commercial-friendly license.
A very simple CSV writer released under a commercial-friendly license.
A specialised plot that draws a compass to indicate a direction based on the value from a
ValueDataset.Common interface between PMITable and VisionJideTable to share a customizer
Customizer Action
Customizer Descriptor
A customizer dialog which takes a Component which implements the customizer interface.
A simple extension of the JideMenu that adds a few things that we commonly use to the constructor (such as I18N
support and an Icon).
This action displays a popupmenu, customized through JIDE's PopupMenuCustomizer, when the action is performed.
This is the API base class for a custom complex property editor.
Run a chart with a custom mapping of params
A simple implementation of ExtendedTagType that lets providers easily specify their own custom types.
This is a number axis that can have a different TickUnit for grid lines vs tick marks.
This Authenticator uses a database and SQL queries to authenticate users and retrieve roles
An enumeration of common RDBMS vendors.
Provides a contract for interacting with data nodes, managing their lifecycle,
and facilitating operations like data collection, metadata updates, and source changes.
This sits in between our real collection session and nodes, and the tag actor.
Factory for creating and managing
DataCollector instances.Default implementation of the
SnapshotProcessor interface that forwards
collected data directly to the storage engine.A consumer interface that can store data of type
T which extends PersistentData.Created by carl.gould on 7/17/2015.
Popup panel to search for data keys.
Apply this annotation to RMShape properties that are strings which represent data keys.
Filename: DataKeyTransferable.java
Created on Jun 03, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
A utility class to help manage DataKey functionality in Ignition Reporting.
Represents the session for interacting with a data node.
Enum representing the availability status of the node.
Filename: DesignPanel.java
Created on Jan 20, 2015
Author: Perry Arellano-Jones
Copyright Inductive Automation 2015
Project: Reporting 3.0
Created by mattgross on 3/15/2016.
Represents a data point in the historian system.
A factory class for creating various types of data points, including atomic and aggregated points.
A sealed marker interface for processing standard temporal points, including raw and aggregated data.
Protobuf type
common.protobuf.AggregatedPointPBProtobuf type
common.protobuf.AggregatedPointPBProtobuf type
common.protobuf.AtomicPointPBProtobuf type
common.protobuf.AtomicPointPBRepresents a query key for standard point types (raw and aggregated).
Protobuf type
common.protobuf.AggregatedQueryKeyPBProtobuf type
common.protobuf.AggregatedQueryKeyPBProtobuf type
common.protobuf.RawQueryKeyPBProtobuf type
common.protobuf.RawQueryKeyPBRepresents the base options for querying data points.
DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey,B extends DataPointQueryOptions.DataQueryBuilder<K,B>>
A builder class for constructing instances of
DataPointQueryOptions.Represents a type of data point in the historian system.
Enum that represents a tag value quality.
A Dataset represents tabular data.
An XYDataset that is backed by a PMI Dataset (confusing, I know)
A builder to create datasets by hand (i.e.
Created by Colby on 12/7/2015.
This class edits datasets AND arrays!
Used in the Designer to edit dataset properties and as the dataset tag editor.
Deprecated.
Used by classes like BasicDatasetSerializer and StreamingDatasetHeaderSerializer to serialize columns
Used by classes like BasicDatasetSerializer and StreamingDatasetHeaderSerializer to serialize columns
Runs a simple panel letting the user choose a dataset key element, like table, graph, crosstab or labels.
Runs a simple panel letting the user choose a dataset key element, like table, graph, crosstab or labels.
com.inductiveautomation.ignition.common.Dataset
Handles different Dataset implementations
com.inductiveautomation.ignition.common.Dataset
Handles different Dataset implementations
Automatically wraps Datasets in
PyDataset.Protobuf type
common.protobuf.DatasetRowPBProtobuf type
common.protobuf.DatasetRowPB
Used by classes like BasicDatasetSerializer and StreamingDatasetRowSerializer to serialize the rows of a dataset
Used by classes like BasicDatasetSerializer and StreamingDatasetRowSerializer to serialize the rows of a dataset
These are static functions that help when testing things involving datasets.
This interface represents a data sink that can consume and process data of a particular type.
The DataSinkBinding annotation is used
to specify the
DataSink for a particular type of PersistentData.The DataSinkInformation interface provides information about a data sink.
An instance of a Ignition Datasource, which represents a configured connection pool to a database through JDBC.
This class manages Swing GUI display and editing of editor's datasource.
This xml and standard serializable POJO holds the configuration of a data source entry for a report.
This is the designer-scoped interface that 3rd party module authors need to implement to add new data sources.
This class must be extended by authors of new data sources.
Protobuf type
reporting.protobuf.DataSourceConfigPbProtobuf type
reporting.protobuf.DataSourceConfigPbDeprecated.
Defines a listener interface for monitoring changes in the state or configuration of a datasource.
Describes an Ignition datasource, including its current status, query workload, etc.
This class manages UI display and editing of editor's datasource.
A datasource panel for RMDataSource.
Runs a datasource panel.
A datasource panel for RMDataSource.
Deprecated.
Provides RPC methods for working with datasources.
Exception that is thrown when a persistent data storage operation fails.
A data store is used
for receiving data to be cached temporarily until it can be taken later for forwarding to a sink.
Interface for providing information about a data store.
A record representing a snapshot of the data contained within a store.
A supplier interface that can supply data of type
T which extends PersistentData.A class to front for a table of data.
This class represents a fetch of a set of data table rows for a given query.
Deprecated.
A class to describe type of content in WebFile (from WebURL).
Represents a "category" of data type, since often in SQLTags we do this based on a broad category- int, float, string
or date.
com.inductiveautomation.ignition.common.sqltags.model.types.DataTypeClass
An extended representation of a data type that can represent either a scalar data type or a UDT type
Protobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.ByteArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.ByteArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringWrapperUtility methods for RMProperty.
An interface for Date selection.
The Date_selector_dialog, shown below, combines a
Date_selector and a Popup_dialog to provide a
standalone, popup dialog for choosing dates.A calendar-display/date-selection widget.
A property editor for editing strings.
Created by carl.gould on 7/27/2015.
Use this to specify a date format property that will have an editor that helps pick format strings
A simple date table cell renderer that renders dates as M/d/yy h:mm a Null dates are rendered as the empty string.
A system tag that provides a format string that changes with the locale.
Date/time formatter lengths.
Date and time functions for use in scripting, to make dealing with java.util.Date objects less painful
from python.
Deprecated.
As of 8.3, use
DBAuthPropertiesResource instead.This class is used to define the configuration properties for the DB user source.
A JythonBuilder to build a SQLQuery script using the DB browser panel.
A browsing tool that allows the user to browse the database, generating appropriate select and update queries to
match the user's selection.
The designer must check the DB function signatures, but the gateway is where the functions are really executed.
A transaction represents a sequence of commands that need to be executed
as a group, or not at all.
The interface for the internal database.
Modal JDialog that lets the user choose chart pens from browsing the database
A class that helps construct a dynamic SQL SELECT query, using proper quoting syntax and
prepared-statement style parameters.
A clause that requires parameters to be added to the prepared statement
An arbitrary part of a SQL query, that knows how to append itself into a larger query.
Static utility functions pertaining to the database.
A very simple implementation of SchemaFeature that simply runs a sequence of DDL queries
Provides the state of the deadband, whether or not the value has changed.
A record representing the configuration for debouncing and batching operations.
A builder class for constructing DebounceBatchConfig instances.
Batches until any of the following conditions are met.
This class is used to debounce data updates.
A strategy for debouncing and batching temporal point storage operations.
Represents a
Resource whose configuration contents have been successfully decoded using the resource's
ResourceCodec.decode(Resource) method.Thrown when a resource cannot be parsed.
A listener to get property changes and nested property changes.
A simple immutable implementation of AlertEvent
A simple immutable implementation of AlertEventFilterParams
A simple immutable implementation of AlertMessage
Default implementation of the
AnnotationPointProcessor interface.A simple immutable implementation of AuditRecord
A BeanInfo is part of the JavaBean spec - it is a class that describes a visual bean.
Default implementation of
BindableModel - should be subclassed by implementations.Default implementation of BindingParameter.
A record that represents the default data sink information.
A default implementation of
DataStoreInformation.This class implements DBExpressionFunctionProvider by executing the functions against a given data source name using
the gateway context.
Simple abstract implementation of AbstractDesignableWorkspace that expects to live within the Ignition Designer (and
thus requires a DesignerContext, and implements ResourceWorkspace)
A default implementation of the
FlavorContainer interface that stores a set of flavors.Basic function factory that adds all of the common functions that apply to all scopes.
Takes a code point (a number), return a string (a single-character string with the unicode character referenced
by the number) for example:
char(0x1F4A9)=💩
This is the legacy 'forceQuality' expression, which took the old pre Ignition 8 data quality codes.
Takes a single character string and returns the integer codepoint of the character.
Thi seq() function returns an incrementing sequence starting at zero.
Straight-forward implementation of an interaction controller using a map of adapters.
Default implementation of the
MetadataPointProcessor interface.This is a type of illegalargumentexception that is thrown when some part of the system tries to use a defualt
"something" which hasn't been specified yet.
Default implementation of
NullableColorSelectionModel.An implementation of SerializationDelegate that uses reflection and the JavaBean standard to try and serialize any
arbitrary object
A tree node that keeps a list of children and has addChild function to add children.
Default implementation of
PersistentFlavor.The default popup window parent.
Base implementation of
ProcessingContext that maintains properties for query keys.DefaultProcessingContext.AbstractBuilder<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>,B extends DefaultProcessingContext.AbstractBuilder<K,T,B>>
Abstract builder for creating
ProcessingContext instances.DefaultProcessingContext.Builder<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>
Builder for creating
DefaultProcessingContext instances.Property pane that applies some simple styling to mesh better with the DefaultPropertyTable
A utility class that parses a json file adding components to a static map of componentTypeId: JsonObject, given that*
the json file contains either a single json component definition, or array of json component definitions associated*
with a "components" property inside the root of the json object, where a 'json component definition' is a valid json*
object string like:
{
"id" : "ia.input.button",
"palette" : { "name": "Button", "category": "input" },
"props": { "aName": "somePropertyValue" },
"resources": [
{
"name": "someComponentLib-js", // unique name of the resource
"path": "/main/data/myModuleAlias/js/someComponentLib.js", // url to the resource file
"type": "js" // type of resource, such as 'js' or 'css'
}
]
} Encodes a persistent record as JSON using a simple mechanism of converting fields to JSON properties.
Default implementations of each member of
ResourceAction, which provide the standard CRUD operations for a
given resource type.A ratio gauge that shows active/total resources for a given resource type, where "active" is defined as
having a healthcheck named "status" that is healthy
A ratio gauge that shows enabled/total resources for a given resource type
Holds a collection of
ReferenceProperty objects for a given resource type.Standard, builder-supported implementation of
ResourceRouteDelegate.Assists in building a ResourceTypeMeta for a non-extension point resource type.
Assists in building a ResourceTypeMeta for an extension point resource type.
A TagDropHandler that has a framework to install property bindings between the target component and the dropped tag
Provides a simple mechanism for adding a SimpleBoundTagAdapter binding on a component
A subclass of SimpleDateFormat that always checks the current timezone and updates to it, in case
it has been changed.
Define the default keyword in the parameter schema to specify the default value for an optional parameter.
Set the default value for a field using an i18n string.
This interface is used to mark components that do not retain certain properties when a Window is closed.
This implementation of PropertySet simply delegates to a different one.
An
EditActionHandler which delegates to an injected delegate
EditActionHandler.A
FocusAdapter which sets the injected
DelegatingEditActionHandler's delegate to the injected
EditActionHandler delegate when the target gains focus.A delegating persistent serializer that uses a map of flavors to serialize and deserialize
PersistentDataThis is used as a placeholder until the actual underlying result node can be created.
Allows the Managed Tag Provider to manage how tag deletion requests are processed.
Annotation for adding a string description to a Resource Schema objects.
Data component that can be attached to an
Entity to provide a human-readable description of the entity
and any attached metadata.Annotation for adding i18n Description keys to Resource object fields.
A
Meter implementation that delegates to another Meter instance, while adding descriptive attributes.A timer implementation that delegates to another Timer instance, while adding descriptive attributes.
An interface for Metrics that know how to describe themselves and their units.
Helper class for serializing metrics that may implement
DescriptiveMetricExtends Property with a few additional fields that can be used to make display nicer.
This class is mostly a copy of the
RatioGauge from the Metrics library.A ratio of one quantity to another.
Comparator used to compare java.beans.FeatureDescriptor objects.
What is generated as after deserialization.
Context for deserialization used when deserializing data with a
PersistentSerializer.A deserialization handler handles a section of an XML parsing for a specific element.
A custom exception that is thrown when deserialization fails.
Anything being designed by the DesignableWorkspace system must implement this interface.
Defines many functions required for the design panel to interact with a DesignableContainer.
Extension of
ResourceCollection with additional functionality to support the Designer's need to model the
project as a tree of resources which can be mutated and staged for push and pull operations.A repaint manager that has special handling for when components get repainted beneath the DesignPanel.
Adapter-pattern class that has no-op implementations of all the functions in DesignableWorkspaceListener
Contains methods and events that are used to design a view in the perspective workspace.
Bindings execute only in the Gateway, but here in the Designer we need the user interfaces to configure
bindings and transforms.
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).
Provides a connected to a deeply selected component.
This is used for parts of the designer that hold onto a DesignerContext, even though every time you load a project a
new designer context is made.
This class serves as a proxy to the gateway for the retrieval of database meta info.
Right now it passes all calls through, in the future we should probably look at implementing caching/asynchronous exec to it or the level that calls it.
Right now it passes all calls through, in the future we should probably look at implementing caching/asynchronous exec to it or the level that calls it.
This registry holds the data source configuration datasources that have been registered on the designer.
DesignerEventStreamRegistry<T extends EventStreamDesignDelegate<E>,U extends EventStreamDesignDelegateInfo<E>,E extends EventStreamEditor>
A component that implements this interface will have a secondary initialization phase after its constructor, but only
when created in the designer.
Message sent by the DesignerStore.ts in response to session-init.
Author: Perry Arellano-Jones
Created 21Apr2015
The main hook into a module's designer scope.
Parameters posted to designer page
The DesignerPanel allows a user to design the layout and appearance of a Report by utilizing the ReportMill engine.
Implementation of property tree privacy that understands the flags set for properties stored in prop configs
A utility class that assists in verifying permissions given the user and global project props or required roles for
save,publish,view,export,copy, or delete on a project
Note: every permission utility method returns true if the global props are null because the project might not have
any global props, hence granting permission
Holds current designer preferences for the Vision module
A
PropertyReference which Subscribes to a DesignerViewModel's EventBus and
refreshes itself when ViewStructureChangeEvents are received.Receives open/close events from resource editors in order to track all open resources in this Designer.
This extends from a normal root node in order to add the "default" provider.
Holds the RM shapes that are on the palette.
Superclass of all Designer toolbars.
Represents the base of a running view on the gateway.
Indicates that the object provides some sort of diagnostics information.
Data component that can be attached to an
Entity to provide diagnostic information, in the form of
metrics and healthchecks.DiagnosticSample is a tree of data about a target.
A class to run a dialog box.
A data source implementation that draws from a directory WebFile.
Stage is disabled.
A class representing an error or exception that occurred.
This condition is basically a standard path condition, but the value is an array of paths.
For classes that supports dispose() feature.
This class exists so that modules can add PyObjectAdapter to the global, static extensible adapter found at
Py.getAdapter() in a way that can prevent leaking the module's classloader.A divider border draws dividing lines around components.
A JMenu of checkbox items that show/hide the various available command bars in the designer
A JMenu of checkbox items that show/hide the various available dockable panels in the designer
A PopupWindowParent that extends DockableFrame for use with the JIDE docking framework.
The scrolling portion of this class borrowed from JavaWorld See
http://www.javaworld.com/javaworld/jw-05-2001/jw-0525-mdi.html
A class representing an object type in Json.
A class representing an array type in Json.
A class representing an element of Document.
com.inductiveautomation.ignition.common.document.DocumentElement, used to serialize document tags
com.inductiveautomation.ignition.common.document.DocumentElement, used to serialize document tags
Model that represents a json document, but held in memory as so to be editable by the JSON editor.
Class that helps build document model root nodes from json elements
Created by carlg on 5/15/2017.
A class representing a
null value.A class representing a Json primitive value.
Created by carl.gould on 7/28/2015.
This class provides UI for configuring an RMDocument.
An inner class to render Page control.
Created by carlg on 5/16/2017.
Java representation of the $ meta array found in encoded property trees and property sync updates
Serializes timestamp in dollar-qualified format
Fills the area with a solid fill at some transparency level.
This is used for when you want to give a map to a script, but you want the map to also act like a python object,
meaning, its keys can be referenced like this: myMap['key'] or like this myMap.key
A double click handler can be added on a BeanInfo, and will be called when an instance of that bean is double-clicked
in the designer.
This is the component used in the property editor table to edit Double and double properties.
Basic subclass of JFormattedTextField that mimics the behavior of a PMINumericTextField set to DOUBLE mode
Basic subclass of JSpinner that is specialized for doubles
Third step.
Downloads the zipped third-party Python scripts from the gateway
This step downloads the required runtime from the gateway but only if it has to.
A DPD creator is in charge of creating instances of DynamicPropertyDescriptors.
This MouseListener and MouseMotionListener listens to a JComponent, and initiates an exportAsDrag on its
TransferHandler when a drag exceeds 5 pixels of distance in any direction.
A component that accepts drag and drop of files.
Ribs Helper for RJCustomView.
Must implement hashcode and equals
A DrivenValue contains a value which can change (driven by some source).
Gson serialization struct for dropped items
Created by carl.gould on 4/2/2015.
Created by carl.gould on 4/2/2015.
An empty implementation for use when we don't really care about progress.
A component that supports dynamic properties.
The customizer that can be added to any component that is a MutableDynamicPropertyProvider to configure their
properties.
This class can be used to delegate the functions that a MutableDynamicPropertyProvider needs to implement.
Handles drop logic for dropping tags (from the tag tree in the runtime) and power table rows
A convenience implementation of FileFilter that filters out all files except for those type extensions that it knows
about.
A data source that reads/writes to a an Eclipse project in the local file system.
If you add plugins here, also add to EdgePlugin.java in gateway
Implementations of this are used to find a connector route between two AnchorPoints, routed between a set of
obstacles
Use with the SystemPropertiesManager to get or set various gateway system properties on an Edge gateway.
Gateway system settings specific to an Edge system
WARNING! If you add a value to the record, be sure to add it to EdgeSystemProperties as well, so we can use
the property to access the value via the SystemPropertiesManager.
Use this annotation if a property should only be editable when another property is set to a certain value.
This class represents a PageConfig -or- a DocksConfig
An EditActionHandler is a class that handles common actions you'd find under an "edit" menu, like cut, copy, paste,
and delete.
A frame which is able to provide its own
EditActionHandler.A JFormattedTextField that sets its border and alignment properly for displaying in the property edit table.
Encapsulates some logic useful in the editors to facilitate correct editing and listening of/to a node's value
and prevent notification looping
Marker class for listeners on this editor's event bus for when the editor is closed
A JTextField with no borders
Monitors Swing's EDT for responsiveness.
Delegate resource implementation that overrides the collection name, so that all resources,
inherited or otherwise, share the same resource id.
com.inductiveautomation.ignition.common.resourcecollection.EffectiveResource
com.inductiveautomation.ignition.common.resourcecollection.EffectiveResource
Represents an XML element
UI element used to configure a selected chart element.
CUP v0.10k generated parser.
Implements parser interface, since as far as I can tell there's no way to do that in the CUP parser file.
Filename: EmailActionConfig.java
Created on Feb 09, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: EmailActionPanel.java
Created on Feb 11, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Encapsulates the details of an email message to be sent using an email profile.
Builder which provides a fluent-API style of creating new
EmailMessage instances.An EmailProfile exposes methods for sending emails.
An
EmailProfile which exposes additional methods for the Platform to drive the profile's lifecycle.An
EmailProfile managed by the Platform.Manages the configured
EmailProfiles.Deprecated.
Represents a type of email profile
Encapsulates the contextual information required for an email profile type to create new email profile
instances.
A property-less implementation of CollectionContext that represents a "no context" state.
Special implementation of BindingParameter that essentially inserts a blank spot in the GUI.
Panel's that displayed when the corresponding section of a
SectionPanelViewModel is not supplied.In the scenario where you have a
JPanel or a JComponent for which you want the
enable state of the children to match those of the parents, you can use this class to achieve that.
This interface represents a component that understands how to properly implement enabled within the Vision component
system.
A binding that will set the enabled state of the annotated component to the state of a model
boolean.
Enum to specify if normal or inverted comparisons should be used.
Inner utility class that performs the runtime wiring of all
EnabledIf bindings.Data component that can be attached to an
Entity to provide information about the enabled state of the
entity, and to allow the enabled state to be changed.An item listener that has a list of dependent JComponents.
The SFC Chart Element Editor for Enclosing Steps
Factory for making new EnclosingStepEditor Uis
Created by carl.gould on 8/27/2014.
Encodes and decodes project and resource collection objects to and from JSON.
An encoder contains a value of some type that it knows how to encode as both XML text or as binary.
A serialization delegate that uses an encoder factory to create the element body.
Contains logic to encode various types is either text meant for XML or as binary, and to decode those types.
These are properties that are used to encode tags to/from text.
Snapshot of store and forward engine information specific for data pipelines.
The manifest for a store and forward engine, representing the engine id and all the associated data flavors tracked
within.
The store and forward engine status.
An entity is a named object that can have various data components attached to it.
This class represents an entity for a data source.
This interface marks an opaque identifier for a tag store.
The EntityManager is responsible for managing the registration and retrieval of registered Entities.
Condition that specifies a set of enum values, any of which will pass.
Annotation for adding an enumeration of values to a Resource Schema object.
Interface for providing enumeration values
Filename: EnumOptions
Author: Perry Arellano-Jones
Created on: 7/24/15
Project: Reporting 3.0
EnvironmentVariable assists with resolving environment variables and provides some utility behavior for detecting
presence, resolving values, and performing simple value translation/mapping.
Implement to define equality and hash code for class T.
When the default equals() and hashCode() of a class needs to be overridden for any purpose.
Filename: EquipmentScheduleViewTermFinder.java
Created on Dec 09, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
Protobuf type
ignition.rpc.ErrorProtobuf type
ignition.rpc.ErrorProtobuf type
ignition.rpc.Error.StackTraceProtobuf type
ignition.rpc.Error.StackTraceAuthor: Perry Arellano-Jones
Created: 14Apr2015
This can be used as a container when the configuration is incorrect.
A a localized error message that gets rendered without its stack trace
Generic error message to be sent to the client for notification purposes
Used to display errors, warning, etc.
Vision clients should implement this so that this class can be secondary desktop aware.
A Write operation that represents an exception during the write.
Evaluation containers are created per tag provider, historical provider, and sample mode.
These are quasi-properties of an alarm (that is, properties that are only known during evaluation, not config
properties) that are available to expressions on other properties.
Custom evaluator to get the next animation value for the next key frame
Essentially it does what EvaluatorColor and EvaluatorFloat does but combines it all into one class
Holds the event and action configuration for a component.
This counts the number of rising-edge or falling-edge events.
com.inductiveautomation.ignition.common.alarming.EventData
The actual EventData class extends BasicPropertySet, but Protobuf definitions can't extend other Protobuf
definitions.
com.inductiveautomation.ignition.common.alarming.EventData
The actual EventData class extends BasicPropertySet, but Protobuf definitions can't extend other Protobuf
definitions.
Created by carlg on 2/15/2017.
Defines the flags that are used in the alarm journal to further describe events.
Manages subscriptions to and delivery of events.
Handler that will be called in a listener throws any Throwable while receiving an event.
Represents a subscription of a listener that has been subscribed to an event.
NOTE: This is an in-memory event collector, but it's not currently used.
Combines EventStreamSource event data with the events metadata.
Builder for creating EventPayload.
This wrapper around Property adds information about what kind of property it is.
Result of submitting an event to an Event Stream
A Condition implementation with the smarts to be able to search tag event scripts in a tag.
Base class for folder nodes managing event scripts in a script workspace.
Abstract node for event script nodes, providing common actions
like close and commit, and close and revert.
A base class for event script nodes in the navigation tree.
Represents the various states of event scripts based on their configuration and migration needs.
Abstract base class for event script tabs.
This is a wrapper around the beans
EventSetDescriptor that also holds all of the relevant methods as
children.Contains full configuration required to start an Event Stream
Manages the configuration of an event stream.
Various metrics that can be retrieved from Stages
Contains all Stages provided by Ignition
Context specific to an Event Stream
Contains diagnostics data for an Event Stream and all it's included stages
Curates and publish diagnostics information about an event stream at 1 sec intervals.
Class is used to ensure uniformity of method definitions in
ViewModels.Converts between data types.
Local message bus for sending messages to
GatewayEventSourceExpression used in
EventStreamHandler for extracting data and metadata from EventPayload.Creates an
EventStreamExpression from ExpressionValueHandles events from Event Streams.
Registered with
EventStreamRegistry to create concrete implementation of
EventStreamHandler from the provided configuration.Produces EventStream lifecycle events to registered
ResourceLifecycleEvent.CallbackNote: Class runs on the EDT
Contains all registries used to build an
EventStreamGeneric registry based on String key and type T
Configuration for running a one-off Event Stream, mainly used for test runs in Designer.
Provides
EventPayload to the Event Stream through the EventStreamSource.Subscriber interface.Registered with
EventStreamRegistry to create concrete implementation of
EventStreamSource from the provided configuration.Interface for submitting events to the Event Stream.
Represents the current state an Event Stream
This class tracks the state of the event stream as reported by the Gateway, by using
the
You can add listeners to this class to get notified when states change via
EventStreamPushReceiver.You can add listeners to this class to get notified when states change via
EventStreamStateTracker.addListener(EventStreamStateTrackerListener).This class is responsible for synthesizing the
SubtextStateInfo, and updating the EventStreamSubtextStateSynthesizer.stateInfo
property.Class facilitates the creation of events
Note: Adding methods to deal with Events specifically, as timestamp collisions seem to be common -Mitch
Provide an example value for a field.
An adapter interface that supports drawing
Workbooks and Sheets based on the supplied objects.The known types that can be directly set via Apache POI for a cell.
This class provides a Swing UI panel to inform users that an exception was hit and send info back to ReportMill.
This class provides a Swing GUI panel to inform users that an exception was hit and send info back to ReportMill.
A class to hold a bunch of Exceptions.
Central manager for all asynchronous and scheduled tasks
Generates private execution engines that can be used to schedule tasks.
Queues up submitted
Runnables and executes them in serial on an
ExecutorService.Queues up submitted
Runnables and executes them in serial on an
ExecutorService.Provides intellihints for "expandables" - custom properties in UDTs that can be referenced by fields in contained
tags.
Provides intellihints for "expandables" - custom properties in UDTs that can be referenced by fields in contained
tags.
This class provides support for expanding and collapsing rows in a
JTable.Action that will collapse all panes of a collapsible pane palette
This renderer has a cell that when collapsed shows texts truncated to fit on one line, when expanded will show
the entire text.
This renderer has a cell that when collapsed shows a title text.
Deprecated.
An expression is something that can be executed to compute a result.
Used to create side-bar actions for expression editors
A Perspective
Binding for Ignition
Expressions.BindingFactory for Perspective
ExpressionBindingsExpressionParseContext for Perspective
ExpressionBindings.TagListener for Perspective
ExpressionBindings.An ExpressionDrivenStringValue is a
ExpressionDrivenValue with type String.An ExpressionDrivenValue is a
LockGuardedDrivenValue driven by a PerspectiveExpression.Links the enabled state of an action to the visibility property of a component.
This editor supports two forms of operations: building full expressions, and building simple strings with
references to items.
A right-click menu that fills in operators and functions for an expression editing text area.
Item selection handler that places the selected item directly into the code editor
A text field that displays a popup expression editor
This interface is used in conjunction with the
FunctionFactory, but provides the functions to add new
expressions.A
SlidingPane which toggles between an
AbstractCRUDTable of type
ExpressionParam and a CodeEditor
which is visible when an expression cell from the table is edited.Passed to the ELParser to help it create Expressions that have dynamic implementations.
Extension interface for expressions so that we can try and knit together the sources of what's triggering
what to prevent loops.
An ExpressionStructureBinding is a
Binding where a given JSON document of any shape / size will have all
its string value leaf nodes interpreted as expression sourcesTable will display a key/value pair with the value portion handled by an expression editor.
An
ExpressionBindingParseContext which additionally wraps a ConstantExpression and a
Predicate which returns true if the path in the bound Expression should delegate to the
ConstantExpression.Expression, SQL and Named Query tags are all just flavors of Memory tags.
Use with expression tags to be able to pass the expression tag's path, needed to locate actual tag paths to relative
tag locations.
Represents a field that can be either a static string or standard expression.
Control switches between TextField and ComboBox.
Component works with
ExpressionValue.Component works with
ExpressionValue.Extendable objects are complex objects that know how to deal with extensions, in the sense that one definition of
the class will add additional details on to the same type of class.
Created by colby.clegg on 3/7/2016.
Allows cloning a
Document without having to create a deep copy of all it's elements.Allows cloning a
DocumentArray without having to create a deep copy of all it's elements.In this case, "extended inheritance" means there are 2 or more levels of parent-child,
i.e.
A property set that actually consists of two sets- a local one, and it's "parent".
com.inductiveautomation.ignition.common.config.ExtendedPropertySet
com.inductiveautomation.ignition.common.config.ExtendedPropertySet
Protobuf type
common.protobuf.CustomTagTypePBProtobuf type
common.protobuf.CustomTagTypePB
com.inductiveautomation.ignition.common.sqltags.model.types.ExtendedTagType
com.inductiveautomation.ignition.common.sqltags.model.types.ExtendedTagType
com.inductiveautomation.ignition.common.sqltags.model.types.TagType
com.inductiveautomation.ignition.common.sqltags.model.types.TagType
An 'extensible' component simulates the idea of subclassing a component in the Vision runtime by exposing a set of
methods that may be implemented in Python.
Describes an extension function that a component may call during it's lifecycle.
An argument for an extension function.
An "extension point" is a category of configuration that can have many flavors.
Represents the role of various kinds of React components to use for the extension point.
This strategy is registered for an extension point type, for the purpose of marking the profile table as migrated
when there are no extension point instances to migrate.
Represents a collection of extension points of a particular category.
Represents an extension point resource's configuration, with its associated profile configuration and type-specific
settings configuration (if any).
All extension point "profile" config objects must inherit from this interface, because the one mandatory field is
the "type" field, which is used to identify the specific type of the extension point.
Builder for
ExtensionPointRecordMigrationStrategyThis ResourceCodec is used to encode and decode ExtensionPointConfig objects, which are pairs of a "profile"
object and a "settings" object.
Describes a form that can add/edit a specific extension point resource type
This validator doesn't actually do any validation, it is just a way to "extend" the schema system with arbitrary
information attached to schemas.
Record class that represents an OpenAPI
External Documentation Object
This class represents a change event for when the 3rd party scripts have changed.
Configuration for an extra attribute that should be retrieved from LDAP and stored on the user object under the
specified property.
A DefaultTreeCellEditor that only starts editing on F2 and not on click-and-wait 1200ms or on triple-click
This is used to wrap the popup buttons to allow for both rollover and fade animations.
This is used for animations with JDesktop's property setter
Holds the background, foreground, icon color for a component at a specific key frame.
Filename: FadingHighlight.java
Created on Apr 22, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Ignition
Created by Colby.Clegg on 12/14/2015.
A
PropertyResolver that first checks a delegate property resolver, if defined, and then on failure simply
creates a new Property<Object> using the provided id and returns it.A JPanel that displays a 'fancy' header at the top, which consists of an icon, text, and a gradient color background.
Represents stages that will never be able to process events.
This class provides a Swing UI panel to send feedback back to ReportMill.
The FetchableCache is a place for perspective component model delegates to place downloadable data
(named "fetch"-able after the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API>Fetch API)
for their front-end counterparts to fetch in the near future.
A field defines the particular source of data that a condition would apply to.
A field defines the particular source of data that a condition would apply to.
This border delegates to the UIManager's "TextField.border" border.
Strips characters that are invalid (to the filesystem) on common OSes.
A data source to read/write data and files to a file system.
This source reads events from a file and forwards them to the event stream.
This is the event object for the route to post to the page's gauva event bus, to get picked up by this delegate.
This is the event object that will be passed to the `onFileReceived` actions.
Contains a few static file-related functions that were ported from the FactoryPMI-provided FPMIFileUtilites class for
general use in the SR Designer
These are all the system.file functions that are platform wide.
Represents the types of file watch events which may occur
Simple layout manager fills all components to the size of the parent
The FillMode enum represents the different modes
that can be used to fill missing data windows within processed query results.
Protobuf type
common.protobuf.FillModePBProtobuf type
common.protobuf.FillModePBA Filter is used by the row selector panel.
A filter contains multiple conditions, and operates on a type of object.
A filter contains multiple conditions, and operates on a type of object.
Created by carlg on 10/20/2016.
Configuration required for filtering
This class wraps a StreamingDatasetWriter, and allows us to specify indexes or column names (case insensitive)
that will be filtered from the underlying dataset.
Contains logic for filtering, searching, sorting, and paging through a set of objects.
Used by routes that want to support LHS-style filtering, paging, searching, and sorting query params like:
Filters events based on return value (True, False) from user's script.
An editor that uses a non-editable combo box displaying a list of pre-canned items
General purpose wrapper around an int that lets you easily work with numeric flags.
Flattened JSON Serialization representation of a JsonWebEncryption object.
A sealed interface representing a container of flavors.
This is the UI for the script editor that appears as a floating frame
Class is responsible for managing the
FlowCellRenderComponent instances for a given list of
FlowCells.A layout that puts children one after another, wrapping when needed.
This class provides UI editing for shapes with FlowLayout.
Configuration class for Font Assets.
Interface which exposes methods for retrieving
fonts and information about the fonts (such
as the font name, font style, and font type)This class is a Swing/Ribs Font panel for selecting fonts.
This class is a Swing/Ribs Font panel for selecting fonts.
This class provides UI for showing the formatter from the currently selected shape and editing or changing it.
This class provides GUI for showing the formatter from the currently selected shape and editing or changing it.
A TableCellEditor that can handle numbers and dates using a formatted text field.
This expression type is actually a wrapper around another expression, which is expected to produce a number.
A simple delegating expression parse context that detects the presence of a format string defined by a pipe "|", such
as {Property|#.00}, and creates a wrapped expression that executes the formatting.
A class to build a form.
An annotation to include the "x-form-category" property in the schema for a field.
An annotation to include the "x-form-category" property in the schema for a field.
An annotation to include the "x-form-field-settings" property in the schema for a field.
An annotation to include the "x-form-field" property in the schema for a field.
An annotation to include the "x-form-field-settings" property in the schema for a field.
This template makes a basic form letter.
Defines all the known form setting keys.
The class used behind the data model for the "Form Submission Event"
and "Offline Form Submission Event".
Represents a tab for editing form submission handler scripts.
A transaction for forwarding persistent data to a sink / store.
Vision Layout constraints object, used with FPMILayout to hold the "layout constraints" (LC) of a component.
Javabean-style class used for the shutdown allowed script
Adds the client-only "refresh" function to system.vision
These are the file utilities that have a GUI element.
Deprecated.
Use VisionModule instead.
Adds overlay functions to the system.vision scripting library
Each window in the Vision module is an instance of this class.
A
BiConsumer which can throw a ThrowableA
BiFunction which can throw a ThrowableRepresents a supplier of results which may throw a
ThrowableAn enumeration of the supported methods for presenting the authentication challenge UI
A
JsonSerializer and JsonDeserializer implementation for serializing and de-serializing
FramingOption objects to / from JSON using GSON APIs.Most of what was in this class was moved to TagFunctionFactory.
Filename: FtpAction.java
Created on Apr 13, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: FtpActionConfig.java
Created on Apr 13, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: FtpActionPanel.java
Created on Apr 13, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
A function is used by the FunctionExpression.
This interface provides a level of indirection to the execution of compiled python objects against the script
manager.
Function-based (type 1) shadings
x,y values in shading space are just passed to the function and the returned color value is plotted.
This class provides UI for showing an RMParentShape and allowing drag and drop from it.
This class provides Swing UI for showing a RMDocument and allowing drag and drop from it.
An inner class and RMViewer subclass for showing and dragging shapes in an RMDocument.
An inner class and RMViewer subclass for showing and dragging shapes in an RMDocument.
Essentially a holder for a list of browsables that fires a change event when the list changes.
Adds ability to send messages through GAN.
Created on 4/21/15.
Mostly a shell class.
Created by mattg on 4/3/15.
Represents an Http URL, with the various segments split up.
Holds the HttpURL addresses for up to two gateways - a master and a backup
The user does not have sufficient authorization for a given project operation (save, create, etc.)
This record contains the context required for
GatewayConnection instances.Builder class for customizing a new instance of GatewayConnectionContext using a fluent-style API.
Deserialize for
AuthChallenge that can polymorphically distinguish SimpleAuthChallenge and
ADSSOAuthChallenge instances.The GatewayContext is the main interface to the Ignition Gateway.
Simple abstract decorator for
GatewayContextThis registry holds the types of report data sources usable in the gateway for generating reports.
This handler sends events to a
GatewayEventSource, through the EventStreamEventBus.Represents a node for gateway event scripts in the navigation tree.
project and path are populated at time of source creation, so resource doesn't need to
store any fields.This little helper class makes it easier to implement polling gateway function logic within a component.
This class is the gateway hook for loading into the Ignition platform.
The Gateway Logging Manager extends the logging manager to provide the idea of monitoring sessions, which can be
used to collect specific sets of logs for a short amount of time.
Represents a module that is loaded in the gateway.
The main hook into a module's gateway scope.
Created by colby.clegg on 3/23/2015.
Use with WSChannelSettingsResource to get or set various gateway network properties.
The GatewayProgressManager is used to execute tasks on the gateway that might take a while.
Provides a run function that can return a value and throw an exception.
This interface is used to provide the Gateway with the necessary information to handle RPC calls.
The Gateway half of the negotiation of RPC payloads between the gateway and clients/designers.
Keeps track of registered
StepFactorys.Use with the SystemPropertiesManager to get or set various gateway system properties.
This class is the link between tags in the client and tags in the gateway.
This ClientTagProvider is used when the default tag provider is not set on the project.
Keeps track of registered
TransitionFactorys.File that holds General Properties for the Vision client.
Created by carl.gould on 6/8/2015.
Protobuf type
common.protobuf.GenericObjectPBProtobuf type
GenericObjectPBProtobuf type
common.protobuf.GenericObjectPBProtobuf type
GenericObjectPBA utility class
that provides methods for converting between
GenericObjectProto.GenericObjectPB objects and other types of objects.Filename: GenericRoleValidatedField.java
Created on Oct 02, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Ignition
This is a general exception that can be used to transfer error information across RPC.
Created by carl.gould on 6/30/2014.
A serialized property resource that is defined by the framework itself, and holds some of the core project
properties.
A JComponent subclass that can be installed as the glass pane of another component,
to help show the regions that get repainted.
This wizard subclass is used to create a simple table.
This class provides RMEditor inspector support for RMGraph.
This class provides RMEditor inspector support for RMGraph.
Special version of ruler that counts grid cells for SFCs, rather than pixels.
Deprecated.
Wrapper class for a TagGroupConfiguration, used to track name changes and display it in a config list
Record class that represents a Group object.
A group task is listener for timing events from a tag group.
A ResourceCodec that uses a Gson instance to directly encode and decode resources.
The field or method that this annotation is attached to can only be accessed when holding a
particular lock.
Handler configuration
Defines how to handle Handler failures
Determines how retries are attempted
Metrics:
{}.handler-{index}.received (Meter): Total events received
{}.handler-{index}.processTimeNs (Histogram)
{}.handler-{index}.errors (Counter)
Just a JLabel that uses BOLD, 11pt font
A titled border that uses the Designer's bold 11-font label as a title, and no border.
Helps to gather named metrics from the registry into a collection of IdentifiedHealthCheckResults
Library of utility methods useful in dealing with converting byte arrays to and from strings of hexadecimal digits.
Hides a field from being discovered by the reflective schema builder
found at
SchemaUtil.fromType(Class, Consumer)Put this annotation on a type to hide properties you don't want from your superclass(es)
This is a hierarchial table model that can be used for editing, but it can also be used as a simple table model
for displaying terms in multiple locales.
Defines the contract for a historian, which manages the storage, query, and lifecycle of historical data.
This history column is self-configuring based on the various settings configured on it.
The HistorianManager interface defines methods for retrieving and
managing historian-related components in the system.
Deprecated.
This class wraps a Historian in a TagHistoryQueryInterface.
This is a HistoryQueryExecutor implementation around the Historian system.
Utility class for converting between common Historian Java objects and their Protocol Buffers representations.
Defines the RPC (Remote Procedure Call) functions for the Historian module.
A utility class for serializing and deserializing RPC (Remote Procedure Call) objects
in the Historian module.
Marker interface for Historian settings.
Base column type for historical column values.
Deprecated.
Deprecated.
since 8.3.0
Deprecated.
The
HistoricalNode interface represents a versioned node in a historical data system.Represents a specialized tree structure built on top of
PathTree, where nodes are of a type
extending HistoricalNode.Protobuf type
BasicHistoricalRecordPBProtobuf type
BasicHistoricalRecordPBProtobuf enum
ColumnTypePBProtobuf type
HistoricalColumnPBProtobuf type
HistoricalColumnPBA sink that stores historical records to a datasource.
This interface defines a piece of history coming from a tag, and is used by the history storage system.
Deprecated.
The basic value unit for the historical querying system.
Protobuf type
common.protobuf.AdHocPythonAggregatePBProtobuf type
common.protobuf.AdHocPythonAggregatePBProtobuf type
common.protobuf.AggregateInfoPBProtobuf type
common.protobuf.AggregateInfoPBProtobuf type
common.protobuf.AggregatePBProtobuf type
common.protobuf.AggregatePBProtobuf enum
common.protobuf.AggregateTypeProtobuf type
AnnotationPBProtobuf type
AnnotationPBProtobuf type
AnnotationsPBProtobuf type
AnnotationsPBProtobuf type
BatchedHistoryDataPBProtobuf type
BatchedHistoryDataPBProtobuf type
DataBytesPBProtobuf type
DataBytesPBProtobuf type
DataTransactionPBProtobuf type
DataTransactionPBProtobuf enum
DataTypePBProtobuf type
FlavorPBProtobuf type
FlavorPBProtobuf type
HistoricalTagValuePBProtobuf type
HistoricalTagValuePBProtobuf type
HistorySetPBProtobuf type
HistorySetPBProtobuf enum
InterpolationModePBProtobuf type
MetadataPBProtobuf type
MetadataPBProtobuf type
RetirementTagsPBProtobuf type
RetirementTagsPBProtobuf enum
TimestampSourcePBProtobuf type
ValuePBProtobuf type
ValuePBA TagDropHandler that is meant to bind to components that can display dataset-based history.
Deprecated.
How historical data should be treated.
This is a running query executed by a tag history provider.
Utility class for serializing and deserializing common historical objects.
This is the main class for the tag history splitter.
The history writer controls the flow of data from the QueryExecutor to the StreamingDatasetWriter.
A panel that simply holds some other panel, using a filling layout.
Deprecated, for removal: This API element is subject to removal in a future version.
Similar to the
VerticalScrollingFlowLayout, this layout will lay out objects top-to-bottom, and then
left-to-right in a way that is compatible with scroll panes.An interface for components to listen to whether or not they're being hovered over.
This class is an overly complex way to do something that you think should be simple.
The HSLColor class provides methods to manipulate HSL (Hue, Saturation
Luminance) values to create a corresponding Color object using the RGB
ColorSpace.
Created by colby.clegg on 11/12/2015.
A SnapFile for HTML files.
Convert an HTTP header to a JSONObject and back.
Implementation of the Perspective HTTP Binding.
Enum representing the various methods allowed by HTTP.
A class to represent an HTTP request and generate a response.
A class to hold headers.
A class to represent an HTTP response.
A WebSite for HTTP sources.
The HTTPTokener extends the JSONTokener to provide additional methods
for the parsing of HTTP headers.
Param class that contains everything needed to execute an HttpBinding's value execution in a hashable way
suitable for use as a key in
ValueCacheRepresents an Http URL, with the various segments split up.
Filename: HttpUtils
Author: Perry Arellano-Jones
Created on: 8/14/15
A basic utility for calling restful web services that return JSON from IA's website
This class is simply a means of adding the ICEPDFViewer to the classpath to allow seamless upgrades in Ignition
7.8.
Simple label based button made to work with a
VectorIcon whose color is set to null (and thus inherits
the component's foreground color) in order to provide rollover indication.Interface which exposes methods for retrieving Icon Libraries (as SVG Strings) and information about the Icon
Libraries (such as the icon names within an Icon Library)
For a given component, trailing icons can be set.
A strategy that migrates records from one or more records or tables in the internal database to the configuration
resource collection.
A pair of an ID and a health check result.
A pair of a name and a metric.
The IdentityField is a convenient field type that provides a unique, automatically generated long value, and sets
itself as the primary key.
Immutable meta information about an Identity Provider
Deprecated.
This class should only be used for special migration related purposes only.
Represents a "design tool", which is a mode that the design panel can be in.
This class puts up the IdP Login splash screen.
Indicates an exception that is really a transparent facade over another interface.
Created by carl.gould on 7/14/2015.
Ignition's very own version of the infamous SwingUtilities class.
Overrides the
SynthButtonUI and performs some additional checks on the component state to ensure that the
correct foreground color is set on the Graphics object before painting the buttons text.Deprecated.
A grouping of settings getters to avoid littering AbstractDesignableWorkspace with these preferences.
An IHandle represents a draggable control used to manipulate a component.
A class implementing the ImageFactory interface knows how to create
java.awt.Image classes for the various formats supported by PDF.
A class implementing the ImageFactory interface knows how to create
java.awt.Image classes for the various formats supported by PDF.
The ImageLoader is the main interface for the images stored in the Gateway.
Fills the area with a solid fill at some transparency level.
Record type that represents an image resource.
Provides Swing UI for RMImage shape editing.
The base interface of all menu and toolbar merging classes
A tagging interface to mark exceptions that should only display their message - not their entire stack trace.
A singleton implementation of the
PointStorageStrategy interface that provides
default behavior for processing and storing atomic, complex, and change points.The class this method is attached to is immutable.
An immutable collection of extension points.
Created by carlg on 12/29/2016.
com.inductiveautomation.ignition.common.resourcecollection.ImmutableResource
com.inductiveautomation.ignition.common.resourcecollection.ImmutableResource
Protobuf type
common.protobuf.ResourceAttrMapEntryProtobuf type
common.protobuf.ResourceAttrMapEntryProtobuf type
common.protobuf.ResourceDataMapEntryProtobuf type
common.protobuf.ResourceDataMapEntryDeprecated.
Parent interface to coordinate the functions between NavUtilities and NavUtilitiesDispatcher
Deprecated.
since 8.3.0, use IncomingConnectionResource instead
A concrete subclass of GlyphMapper for the Identity-H & Identity-V maps input bytes -> cids is done with no mapping,
just interpreting the bytes as big-endian shorts.
This is a wrapper around a QualifiedValue that also provides an index identifier.
Represents either a string portion of an indirect tag path, or a reference index part
An InfoBar is the bar that slides down from the top of the Client to notify users of something, like a new version of
the project is available.
Note: This class should be the last class added to the painters list of the AttributeTextPane.
A browse tree node that has info retrieved from the gateway.
Record class that represents an OpenAPI Info Object
Represents the inheritance relationship between two types (described as "type A" and "type B" in relation to the
values).
Used to indicate a preferred size for a newly created component.
A double-click handler that implements in-place editing for components that want text editability.
This action, which needs to be initialized with a text component, will show a dialog box prompting the user to find a
historical tag.
This action, which needs to be initialized with a text component, will show a dialog box prompting the user to find a
tag.
Like java.awt.Insets, but with double precision
Created by carl.gould on 4/20/2015.
This class is responsible for the Swing UI associated with the inspector window.
This class is responsible for the Swing GUI associated with the inspector window.
Created by carl.gould on 6/17/2014.
Controls binding interaction and other adapters for a hierarchy of components.
An Interaction Descriptor represents an inter-component dependency relationship.
An interaction listener is something that listens to one or more children
that can change, and when they do typically the interaction listener needs to
re-evaluate something involving all children.
An icon that can display different states depending on interaction
Deprecated.
As of 8.3, use
InternalAuthPropertiesResource instead.Properties for the internal authentication profile.
Deprecated.
As of 8.3, use
InternalContactInfoResource instead.Configuration for contact information for a user.
Used for some features that depend on the specific internal db flavor.
Deprecated.
Deprecated.
As of 8.3, use
InternalRoleResource instead.Represents a role in the internal user source.
Deprecated.
As of 8.3.0, use
InternalScheduleAdjustmentResource instead.Represents a schedule adjustment on an internal user in the internal user source.
The internal interface to sessions used by the system to coordinate the lifecycle and inner workings of the
session with the communications from clients and designers.
A page visitor interface.
Deprecated.
As of 8.3.0, use
InternalUserExtraPropsResource instead.Represents an extra properties on an internal user in the internal user source.
Deprecated.
As of 8.3.0, use
InternalUserResource instead.Represents a user in the internal user source.
Builder for the
InternalUserResource class.Deprecated.
As of 8.3.0, this is stored in 'roles' in
InternalUserResource.This
ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter helps migrate internal users from the internal user tables to a users.json
file that will be stored in the Internal and AD/Internal user source profile resources - alongside the resource.json
and config.json files.
This user source stores users, roles, extended properties, and contact info inside the internal database.
Utility class for persisting internal users and roles to disk for
InternalUserSource profiles.A text field that displays a popup parameter picker
Type 2 exponential interpolation functions.
Describes how values are interpolated/extrapolated in the history system.
Interpolates between values to provide a value at a specific time.
For analog tags, the value is ramps directly between the values
For discrete tags, the value is flat until it then changes, at the timestamp of B
Represents an intersection of PropertySets.
This is a thin extension of IntersectedPropertySet, which knows how to intersect more complicated tag props, that
ideally would be handled through a generic means in the property system.
This is a helper for dealing with intersected models.
Basic subclass of JFormattedTextField that mimics the behavior of a PMINumericTextField set to INT mode
Basic subclass of JSpinner that is specialized for ints
Thrown to indicate an invalid edit was detected
Relevant only for Edge and Maker editions.
This is used to communicate the unusual case that a listener is no longer valid, and thus should be removed from the
list of listeners in the calling function.
This exception is used to indicate that the qualified path is not valid for the attempted use.
Instances of this class have two uses.
An interface that knows how to execute a query given a GatewayInterface
An object that listens for responses from the QueryManager for a registered query
Provides logic to check whether or not scripts are currently enabled.
This interface describes a class that can provide the IHandles needed to manipulate a given selection.
An annotation to include the "x-form-category" property in the schema for a field.
Handler for a route that returns a list of items.
A search result item found by an
ItemSearchDelegate.Attached to the navigation model, this delegate is responsible for searching for items found at the given page.
This is a specialized panel that essentially acts like a tabbed pane whose tabs are always on the left hand
side.
A validator (keyed off
items) that either defines a schema for all items in an arbitrarily long sequence,
or a validator with a fixed set of schemas - both the contents and the number of those child schemas must
match to be valid.An extremely simple interface that simple allows for "late" retrieval/calculation of a value.
A tagging interface to mark exceptions are purely used to wrap another exception, and should not be shown themselves.
A ParseRule for annotations.
A WebSite subclass for Jar files.
A ZipFile.
Shapes should implement this if they draw themselves using Java2D.
A file object for managing Java files.
A class to manage dependencies.
This class acts as a 'bridge' between the Java and Javascript environments.
An
AbstractEditActionHandler for cut, copy, and paste handling of the JavaJsBridge.A parser for java files.
A class to hold some utilities for JavaParse package.
Helper class that invokes methods in the javascript side of the designer safely on a background thread, turning the
results into a CompletableFuture
A tokenizer for Java input.
A class to build components for JComponentShape.
JButtonHpr.
This class is the superclass for labels and buttons which handles attributes
common to both classes.
An RMShape subclass for JButton.
This class provides GUI editing for RJButtons.
An inner class to act as JButtonShape's Tool
An inner class to act as RJButtonShape's Tool
A JComponentShape for JCheckBoxMenuItem.
An RMShape subclass for JCheckBox.
This class provides Swing GUI editing for RJCheckBox.
Provides an inspector for JCheckBoxShape.
Provides an inspector for JCheckBoxShape.
A Java member for ClassOrInterfaceDeclaration.
This class represents a JFile class reference, so that classes don't have to be resolved until the last moment.
A JMemberDecl for Initializers.
This class provides Ribs functionality for JComboBox.
This class provides Ribs functionality for JComboBox.
A combobox model implementation to handle binding.
A SwingEventListener for JComboBox.
An RMShape subclass for JComboBox.
A class to act as JComboBoxShape's Tool
An inner class to act as RJComboBoxShape's Tool
An anchorpoint that uses a jcomponent to define its hotspot.
This class is used to provide Snap UI functionality to Swing JComponents.
An abstract DesignableDelegate that implements many functions using the size/locations provided by JComponent
A shape subclass for JComponent.
The base tool class for ribs tool.
A Java member for ConstructorDeclaration.
A JNode for Enum constants.
The JNode base class for Java expressions.
A JExpr subclass for Allocation expressions.
A JExpr subclass for ArrayIndex expressions.
A JExpr subclass for Cast expressions.
A class to represent a chain of expressions.
An class to represent expressions that include an operator (math, logical, etc.).
A ParseRule (and Handlers) for a Java Expression.
A JMember for Field declarations.
The top level Java part describing a Java file.
A ParseRule for parsing Java files.
Ribs Helper for formatted text field.
An RMShape subclass for JFormattedTextField.
Provides an inspector for JTextFieldShape.
Provides an inspector for JTextFieldShape.
A JExpr subclass for identifiers.
Filename: JideToolbarButton.java
Created on Mar 03, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Ignition
A Java part for import declaration.
Created by carlg on 4/19/2017.
This helper implementation for JLabel.
This class is a simple RJButtonOrLabel subclass to support Ribs archival and
to support Ribs unified accessor model.
An RMShape subclass for JLabel.
This class provides a RM shape/inspector for editing JLabel.
This class provides a UI inspector for JLabelShape.
This class provides a UI inspector for JLabelShape.
An RibsHelper implementation for JList.
An RJHelper implementation for JList.
List Model implementation for lists of items.
Inner class to dereference the display value from list value using given key (from binding).
An inner class to describe a selected range (start, end, length).
A simple sample table model so Ribs app can show sample table data.
An RMShape subclass for JLists.
An RJShape for editing JLists.
Provides UI editing for JListShape.
A JExpr subclass for literals.
A parse rule subclass for JLiteral.
A JNode for type members: Initializer, TypeDeclaration, EnumDeclaration, ConstructorDeclaration,
FieldDeclaration, MedthodDeclaration, AnnotationTypeDeclaration.
Copyright (c) 2004 ReportMill Software, Inc.
A JComponentShape for JMenuBar.
A helper class for JMenu.
A helper implementation for JMenuItem (with specific support for subclasses: JCheckBoxMenuItem,JRadioButtonMenuItem).
A RJHelper implementation for JMenuItem (with specific support for subclasses: JMenu, JCheckBoxMenuItem).
A JComponentShape for JMenuItem.
Represents a menu merge for a JMenu.
A JComponentShape for JMenu.
This class represents a method call in code.
A Java member for MethodDeclaration.
The base class for all nodes of a JFile.
A base ParseHandler implementation for JNodes.
A Java part for package declaration.
An RMShape subclass for JPasswordField.
A tool subclass for JPasswordFieldShape.
Data object defining a JPMS module which requires --add-opens and --add-exports clauses due to strong encapsulation
of the JVM internals.
This class contains the correct logic for a component that wants to pop up a popup menu.
A helper class to add Ribs bindings to JPopupMenu.
A JComponentShape class for JPopupMenu.
Ribs Helper for JProgressBar.
An RMShape subclass for JProgressBar.
Provides UI editing for JProgressBarShape (and JProgressBar).
A panel that will contain a series of radio buttons.
A JComponentShape for JRadioButtonMenuItem.
An RMShape subclass for JRadioButton.
An inner class to act as RJRadioButtonShape's Tool.
An inner class to act as RJRadioButtonShape's Tool.
An RJHelper implementation for JScrollPane.
An RJHelper implementation for JScrollPane.
A JComponentShape subclass to represent a JScrollPane.
An RJShape subclass to represent a JScrollPane.
This class provides Ribs editing of JScrollPaneShape.
An inner class to act as RJScrollPaneShape's Tool.
This class provides a RM shape/inspector for editing JSeparator.
This class provides a RM shape/inspector for editing JSeparator.
Provides Swing UI editing for JSeparatorShape.
This class is a RibsHelper implementation for JSlider.
This class is a RJHelper implementation for JSlider.
An RMShape subclass for JSlider.
An inner class to act as RJSliderShape's Tool
An inner class to act as RJSliderShape's Tool
A JSONArray is an ordered sequence of values.
Created by carlg on 5/15/2017.
This is a label that knows how to monitor a json editor for errors.
The JSONException is thrown by the JSON.org classes when things are amiss.
Just an ArrayList that will toString() into json.
This provides static methods to convert an XML text into a JSONArray or
JSONObject, and to covert a JSONArray or JSONObject into an XML text using
the JsonML transform.
A JSONObject is an unordered collection of name/value pairs.
A property path represents a location in a JSON document.
Basic wrapper around a
JsonResourceCodecThis is the core of json constraint implementation.
Listens to document models in order to drive the visibility of DocumentNodes based upon their schema and the
"visibleWhen" meta-validator.
The
JSONString interface allows a toJSONString()
method so that a class can change the behavior of
JSONObject.toString(), JSONArray.toString(),
and JSONWriter.value(Object).JSONStringer provides a quick and convenient way of producing JSON text.
A JSONTokener takes a source string and extracts characters and tokens from
it.
Encodes byte[] objects as Base64
Standard json validator interface, implemented by all validators and JsonSchema.
Utility methods for working with
JsonWebKey and JsonWebKeySetJSONWriter provides a quick and convenient way of producing JSON text.
Implements Ribs bindings for JSpinner.
An RMShape subclass for JSpinner.
An inner class to act as RJSliderShape's Tool
An inner class to act as RJSliderShape's Tool
Ribs Helper for JSplitPane
An RMShape subclass for JSplitPane.
Provides Ribs representation for viewing and editing JSplitPanes.
A Ribs app tool for JSplitPanes.
A Ribs app tool for JSplitPanes.
This class is a utility class used to creating split panes.
The Java part to handle Java statements.
A Java statement for AssertStatement.
A Java statement for a block of statements.
A Java statement for BreakStatement.
A JStatement for Class declaration.
A Java statement for ContinueStatement.
A Java statement for DoStatement.
A Java statement for EmptyStatement.
A Java statement for statements that are just expressions.
A JStatement for for() statements.
A JStatement for if() statements.
A Java statement for LabledStatement.
A ParseRule for Java Statements.
A Java statement for ReturnStatement.
A Java statement for SwitchStatement.
A class to represent individual labels in a switch statement.
A Java statement for SynchronizedStatement.
A Java statement for ThrowStatement.
A Java statement for TryStatement.
A JNode for a catch block
A Java statement for LocalVariableDeclaration.
A Java statement for WhileStatement.
Represents the types possible in a JSON encoding.
A Helper for JTabbedPane.
An RMShape subclass for JTabbedPane.
An RMShape representation of JTabbedPane.
Provides Ribs UI editing for JTabbedPaneShape.
Provides Ribs UI editing for JTabbedPaneShape.
Represents a JTable TableColumn.
This class provides an inspector for JTableColumnShape.
An
EditActionHandler for JTables which takes care of
the basic Copy / Cut / Paste / Delete actions.A Helper subclass for JTable.
This class is a JTable helper class to do some table management and archival for Ribs.
ListSelectionListener for table.
A simple sample table model so Ribs app can show sample table data.
A RMShape subclass for JTable.
A RJShape implementation for JTables in Ribs.
An RBTool implementation for JTableShape management.
An RBTool implementation for JTableShape management.
A helper for JTextArea.
An RMShape subclass for JTextArea.
Provides UI editing for JTextAreaShape.
An inner class to act as RJTextAreaShape's Tool
An
EditActionHandler for JTextComponents which takes care of the basic Copy / Cut / Paste / Delete
actions.This class is a JComponentHpr subclass for JTextComponent.
This class is a RJHelper implementation for JTextComponents.
A shape implementation for JTextComponent.
A Tool for JTextComponentShape.
Helper for JTextField.
An RMShape subclass for JTextField.
Provides UI editing for JTextFieldShape (and JTextField).
An inner class to act as RJTextFieldShape's Tool
JToggleButtonHpr.
An RMShape subclass for JToggleButton.
Provides Swing UI editing for JToggleButtonShape.
An inner class to act as RJToggleButtonShape's Tool
This class is a simple JTree subclass to support Ribs archival and to support Ribs unified accessor model.
This class is a simple JTree subclass to support Ribs archival and to support Ribs unified accessor model.
An RMShape subclass for JTree.
Provides Swing UI editing for JTreeShape (JTree).
An inner class to act as RJTreeShape's Tool.
A JNode for types.
A JNode subclass for type parameters.
A JNode to represent a defined variable.
This class should only be called if JX Browser libs are on the class path.
Base class for the different action tabs of the event configuration UI.
Annotates a function added to the scripting system.
This class wraps a PyException, to force it to be caught (PyException is a RuntimeException)
A Jython-optimized wrapper around the base
HttpClient available in Java 11+.Provides meta-information about exceptions that a function exposed to Jython may throw.
Optionally annotate your class with this and all the rest of the annotations will have this key base prepended to
their i18n keys.
Components that require keyboard input should let this class know about it.
Created by carl.gould on 6/1/2015.
Text field for editing node keys.
The class used behind the data model for the "Key Event" session events.
Panel that allows user to set the event mode, event binding config, event key modifiers, and event options.
Represents a tab for editing key event scripts.
Created by carl.gould on 5/8/2015.
Created by carl.gould on 5/8/2015.
This class shows the current set of keys relative to the current editor selection in a browser and lets users
drag and drop them to the editor.
This class shows the current set of keys relative to the current editor selection in a browser and lets users
drag and drop them to the editor.
This class shows the current set of keys relative to the current editor selection in a browser and lets users
drag and drop them to the editor.
Filename: KeysBrowserNode.java
Created on May 12, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Created by carl.gould on 4/20/2015.
This class shows the current set of keys relative to the current editor selection in a browser and lets users
drag and drop them to the editor.
This class shows the current set of keys relative to the current editor selection in a browser and lets users
drag and drop them to the editor.
Gson adapter for serializing and deserializing
KeystrokeKey objects.Tab for editing client keystroke event scripts
The style declaration classes support two different key encodings.
Represents the primitive value of a foreign key (potentially multiple values)
A useful meta-annotation that serves dual purposes:
If you are using a
PropertiesFileDocProvider,
your argument names and classes can be retrieved from this annotation.A
KeywordMap is similar to a hashtable in that it maps keys to values.Annotation for adding a string label to a Resource Schema objects.
This class is the superclass for labels and buttons which handles attributes common to both classes.
A JComponentShape subclass for Labeled JComponents (JLabel, AbstractButton).
Provides base inspector UI for Swing Buttons and Labels.
Filename: LabelFormat
Author: Perry Arellano-Jones
Created on: 7/27/15
Project: ignition_dev_7_8B
A shared class that holds the size information about the format of a RMLabel.
Filename: LabelShapeConfigFactory
Author: Perry Arellano-Jones
Created on: 7/27/15
Project: Reporting 3.0
Filename: LanguageSelector.java
Created on Apr 24, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
Filename: LanguageSelectorBeanInfo.java
Created on Apr 24, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
Message sent to the perspective client containing information about the localization terms available for a language.
This source emits the last event that was emitted by a source.
Retains last event Source emitted for every Event Stream.
Created by Colby on 8/9/2015.
Contains helpful functions for doing things...later! Every function here wraps up it's logic into a runnable
submitted to
EventQueue.invokeLater(Runnable)A LatinGlyphMapper is a concrete subclass of GlyphMapper that can handle
the standard pdf encodings that map single byte character codes from
a named encoding, with possible modifications by a Differences array.
A LatinGlyphMapper is a concrete subclass of GlyphMapper that can handle
the standard pdf encodings that map single byte character codes from
a named encoding, with possible modifications by a Differences array.
The interface that any class that want sto be launched by the bootstrap launcher must implement
Describes all of the jars, broken up by module, required for launching an application of a given scope.
All of the pertinent info to start the Launcher
A panel that holds a splash panel suspended in the middle for when splash panels don't live in their own frame.
A System Property reference which has its value set at instantiation.
Analogous to
LaunchSysProp.StringLaunchSysProp, but for Booleans.Analogous to
LaunchSysProp.StringLaunchSysProp, but for Integers.A system prop which has keys and legacy keys, but also has a companion "jvm" property which should be set along
with it.
Analogous to
LaunchSysProp.StringLaunchSysProp, but for Longs.A collection of system props which expect to have a 'list' of system properties which are in the form of
{key}.{index}.The most standard form of a system property, whose value is simply a (nullable) String type.
A collection of System Properties used during bootstrap, especially in the case of a restart or retarget.
This is a LayeredPane for use as a JRootPane's glass pane.
A JFrame with some helpers to open and center itself late
Represents an LDAP attribute in configuration.
Encapsulates lots of the boilerplate code required to connect to and query an LDAP server.
Adapter class for legacy aggregate types to the
AggregationType interface.Classes that implement this will be able to create a NamedQuery from their
own config.
Meant as a last resort for when a Vision border specifies "com.incors.plaf.alloy.de", a class that was used by
the 7.x era Laf.
Same as PropertyRef, but allows spaces, so that an old reference containing spaces will attempt to keep working on
upgrade.
Code originally present in the ScanclassCSV class has been moved to here.
All the system.tag functions that were formerly located in AbstractTagUtilities and AbstractIALabsTagFunctions.
Our definition of levels, since there are many different versions defined across the different frameworks.
The represents an Ignition license file
Represents the licensing details for a specific module
Record class that represents an OpenAPI
License Object
Represents some license parameter.
Represents what license state a specific module is in, including any platform-wide license details and the license
details for the module in question.
Where the limit should go in the query.
The
LinearGradientPaint class provides a way to fill
a Shape with a linear color gradient pattern.Adds a linear regression pen to the EasyChart
Factory class for LinearRegressionPenDatasource
Represents the columns in the indicator dataset
Filename: LinearScaleTermFinder.java
Created on Dec 09, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
This class is responsible for removing the attributes for all text in the row where the user is typing, and
replacing them with the
A specific use of this class is for tag path validation.
AttributeSet provided in
LineAttributeApplier.install(AttributeTextPane, AttributeSet).A specific use of this class is for tag path validation.
The RMGraph class provides a template and the machinery for generating graphs.
This class handles editing of rectangle shapes.
This class handles creation of lines.
This is a specialized selection controls which puts link handles on any chart element that is dangling (not connected
to the chart)
Created by carlg on 10/20/2016.
Utility class to adapt classic swing listener patterns to a more Java-8 style of code.
Static utility map to add map-like
functionality to Java.
A marker interface to distinguish the opc transferable dataflavor
Used for Dnd data flavors.
Given a JList that contains items that implements
ListTooltipSupport.ToolTipTexter.This column type provides a literal string that will be worked into the raw db query.
Deprecated.
This class contains the logic to implement the livechart feature.
An icon that displays an simple animation while something is loading
This class is a subclass of LoadingIcon that uses a (shared) java.util.Timer, and issues repaintImmediately
commands to the parent component on non-EDT thread.
It's a label that says "Loading..." with a little blinky thing.
This parse context results in expressions that only evaluate to strings, and do so in a way that respects the
provided locale, as much as possible.
Filename: LocaleChangeEvent.java
Created on Dec 10, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: SRCommon
This is a split button that lets the user select one or more locales.
Provides a list of locales that can be selected, calls Locale.setDefault() when a selection is made.
A class that represents a locale.
Local client fallback is a mechanism where a client tries to see if there is a gateway on the local machine,
and if so, automatically can retarget to that local gateway in the event of losing it's connection.
Defines static constants for localization
This interface is used to provide a localized string representation of a class.
This class is used to render enum values for a list, in a localization friendly way.
A localized message that takes a bundle key and lazily uses BundleUtil to create its localized message.
A label whose setText() function is overridden to take a bundle key instead of plain text.
A localized message that takes a bundle key and lazily uses BundleUtil to create its localized message.
An exception whose message is a bundle key that gets resolved on a call to getMessage(), using the current
ClientReqSession's or web request's locale.
A special string container that holds a key, and returns the localized version of that key on toString().
com.inductiveautomation.ignition.common.i18n.LocalizedString
com.inductiveautomation.ignition.common.i18n.LocalizedString
This Gson adapter is used to serialize and deserialize LocalizedString objects for RPC usage.
A FileSite subclass that stores files in a named directory relative to SnapCode home directory.
Consumes a location, implying some navigation happened within the Designer.
A Location uniquely identifies a resource in the project (by
ResourceId), plus some additional
context in the form of simple string key/value pairs.Builder class to hold rendering information for a particular
Location for the platform.Functional interface-like to indicate this class is capable of updating a
LocationRenderingInfo with
additional context for Location, which will uniquely identify some element in the Designer.Specific kind of PushException indicating that a push failed because the lock acquisition timed out.
A LockGuardedDrivenValue is a
DrivenValue which holds a lock object and asserts that Threads which call
LockGuardedDrivenValue.isReady(), LockGuardedDrivenValue.isDirty(), and LockGuardedDrivenValue.getAndClear() hold this lock.A LockGuardedDrivenValueCollection is a
LockGuardedDrivenValue which provides implementations for
LockGuardedDrivenValueCollection.isReadyInternal(), LockGuardedDrivenValueCollection.isDirtyInternal(), LockGuardedDrivenValueCollection.startup(), and LockGuardedDrivenValueCollection.shutdown() common to a
managed Collection of DrivenValues.This is a general purpose representation of a logging event.
Created by colby.clegg on 5/5/2016.
This class is a wrapper around a logger which provides additional useful tools.
This is our main filter in the logging system.
We can do 2 things: 1) set levels for specific property values (which
bypass/ignore logger levels) 2) set property filters, so that events only
pass when the property matches.
Basic nominal tuple used as a return value for Designer and Client authentication.
An instance of this class is used to create the UI to log into the client.
Created by carlg on 3/17/2017.
Renders an image (from
resources/images/$path), centered over a branded background gradient from bottom
left to top right.Record class that represents an OpenAPI "Logo Object".
The Log Property registry is a simple collection of
LogPropertyDescriptors.A set of parameters for querying the logging system.
The results of a query to the logging system.
Implementation of EntityId that hold a long value.
This implementation of Connection doesn't actually store the AnchorPoint objects themselves, instead, it stores the
block ids and anchor point ids.
Main tile that is shown in the palette frame.
A
SecretProvider managed by the Platform.A Managed Tag Provider is one that is managed by outside code- in other words, not one created by the user.
A class for working with parameter strings as found in a URL query part or fragment id, typically with the format:
field1=value1&field2=value2
Contains functions we wish were in java.lang.Math
Fills the area with a solid fill at some transparency level.
An annotation to provide a hint in the OpenAPI schema that a number field has a maximum value.
A json-schema validation that requires a string field must be a shorter than a maximum character length.
A tristate butto model that can have the mixed mode turned on or off
A tag config that has a string path with is the UID of the parent folder.
A menu action is an entry in the "hamburger" menu displayed for items in a data grid.
Represents the entire menu bar.
Interface to create consist api between JMenu and JPopupMenu
Interface representing the channel used by the backend to send messages down to the client (the websocket).
Utilities for binding
MessageDisplayComponent components.A utility class that provides support for painting text on a
In the component that you want to paint text on, add the following code to the paintComponent method:
JComponent.In the component that you want to paint text on, add the following code to the paintComponent method:
Allows multiple runnable instances of a MessageHandler to be created from a single MessageHandlerTask.
Tab for editing message handler event scripts.
Holds everything needed to execute a MessageHandler runnable.
Handles some boilerplate for classes that can handle receiving messages from a websocket channel.
This interface is used to return a result from the Message Handlers when they're called as requests.
Represents a metadata point in the historian system.
A builder class for constructing
MetadataPoint instances.A binary adapter for serializing and deserializing
MetadataPoint objects.An interface for processing metadata points.
Represents a key for querying metadata points.
A binary adapter for serializing and deserializing
MetadataQueryKey objects.Represents the options for querying metadata points.
A builder class for constructing instances of
MetadataQueryOptions.A binary adapter for serializing and deserializing
MetadataQueryOptions objects.The base MetaProperty class.
A wrapper around a MethodDescriptor with a link to the containing EventSetDescriptorNode.
This builder helps build metrics that implement
DescriptiveMetric.Created by mattgross on 3/15/2016.
Deprecated.
since 8.3.0, use MetricsDashboardResource instead
Created by carlg on 6/9/2016.
Created by carlg on 6/9/2016.
A class to represent midi files.
A simple jpanel that uses a MigLayout to create a 2-column form.
Exposes hooks to systems which may be required during config record migration.
Logging support for the 8.1 InternalDB Record to 8.3 Resource migration.
An annotation to provide a hint in the OpenAPI schema that the number field has a minimum value.
A json-schema validation that requires a string field must be a minimum character length.
Created by colby.clegg on 8/10/2015.
This event is broadcast when data is posted to the GW from a mobile client session, containing data provided
by the native mobile application (barcode, image, nfc scan, etc).
A convenience class for collecting the different data type identifiers used by the mobile device, as well as the
script handlers that are associated with the originating data source.
A marker interface to designate that an
Enum is intended to be used as a model
update specifier.Pre-defined
ModelUpdate types with special meanings to the framework.Represents a resource that has been modified.
Created by Colby on 8/1/2015.
Contains meta information about a module, such as its id, name description, required versions, hook classes, and jar
file information
Contains meta information about a module's jar file, such as its scope and native lib parameters, and path within
the module package.
This class parses the module descriptor file.
Class for project resource Python script libraries
Manages how modules are installed, restarted, and removed from Ignition
This ObjectInputStream first tries the normal method of locating classes that it's deserializing, but if it can't
find them, it goes to the modules to resolve them.
Marker interface for a generic service provided by a module.
The
ModuleServicesManager is responsible for managing the lifecycle of ModuleServices and
ModuleServiceConsumers.When the Perspective Module is about to Shut Down, this event is sent on the Perspective Context Event Bus
A monitoring session is a way for us to set levels and filters on the logging system, and have them timeout after a
certain period of time.
Abstract adapter implementation of MouseListener and MouseMotionListener.
Panel that is used to represent a collection of style attribute editors.
Some util functions for getting device information on multi monitor set ups
This is the superclass for Paints which use a multiple color
gradient to fill in their raster.
The color space in which to perform the gradient interpolation.
The method to use when painting outside the gradient bounds.
A transferable that accepts multiple transferables and will multiplex between them.
Useful for contributing to multiple timers with a single auto-closeable.
This class holds a value for each of the type classes, in case we need to pass all of the possibilities along until
we can know for sure which to use.
Mutability mode represents how a session should interact with external sources of data, such as tags or
databases.
An implementation of Dataset that is used by gateway-side functions for returning to clients.
A simple wrapper around a SimpleDateFormat that simplifies the interface for altering and retrieving the format.
An entity that can have children added to it.
A nav tree node to which children can be added by external actors
The normal BasicTagValue will throw exceptions on the setters after initialization.
A class that performs the work of reading and setting values on a bound field.
The requested name would collide with another local resource (a problem on case-insensitive OSes, ie Windows)
A NamedId is an identifier which is primarily a UUID, but can have a "friendly" name associated with it.
Record that holds a resource collection / project name and a
ResourceCollectionManifest.Used by ProjectRoutes for the project overview list.
This class represents a single named query.
Hooks into the QueryManager for polling
Authoring panel of the NamedQueryWorkspace
Tree in Named Query Workspace that browses the selected datasource and displays tables and columns Supports dragging
a table or column into the Code Editor for quick table and column references
Panel used to select a named query by path and set the parameters.
Panel that shows the description for a named query as appropriate.
Panel that shows the fallback value for a NamedQuery.
This allows NamedQueries to use unsaved queries in the Designer (so other resources can use them without forcing
a save), but not the Client.
Project resource node specific to Named Queries.
A panel containing a header, validated text field, and named query search popup.
A tabbed resource editor for Named Queries
Settings panel of the NamedQueryWorkspace
Basically a
SQLQueryTagBinding, altered for Named QueriesTesting panel of the NamedQueryWorkspace
Workspace for creating NamedQueries; integrates easily with the project resource nav tree
Migrates records that are identified by unique name.
This class acts as an abstraction layer for handling named configuration resources.
NamedTheme to be applied to CodeEditor TextAreas
A simple thread factory that uses a custom name prefix.
A wrapper around an Object that attaches a resource bundle key to it.
The requested name is already in use by another local resource.
This class provides helper functions for naming objects.
The basic name factory generates sequential names with simple pattern detection.
For a given object, provides its name.
The implementor will return whether the provided name exists or not.
This NameValidator wrapper is used for generating many names, when the underlying name validator won't be updated
on the fly.
Resolves file paths to native libraries based on the following file structure:
This class is wrapper for a
Date_selector that adds a navigation bar to manipulate the wrapped selector.This jython builder provides a GUI that defines a navigation action
Data component that can be attached to an
Entity to provide navigational information for the web-ui.An icon used in the Designer
NavTreePanel that can show a normal and selected state.By creating a dedicated class for a list of tree paths, we gen an un-ambigious DataFlavor through
LocalObjectTransferable rather than a type-erased data flavor for List.class
This class tracks where the Rename functionality follows a convoluted path.
This class contains the actual implementation for the methods mounted under system.nav.*, but it is not
actually directly mounted in the script manager because there is a separate instance of this class for
each desktop instance.
This class exists in order to automatically detect what desktop the call is coming in from and to dispatch
the invocation to the correct NavUtilities instance, based upon the thread local in
VisionDesktop.CURRENT_DESKTOP.
This class is responsible for GUI editing of nested document shape.
This JTree supports renderers who have mouse-location sensitive tooltips.
This action will pop up the
CreateResourceDialog.Action delegate used to configure NDef format NFC data collection from mobile/native devices
The "Node" is the base unit of everything in the tag system.
Node attributes are characteristics of a node that affect how they are displayed.
NodeBrowseInfo is an extension (wrapper) around NodeDescription which includes its full path.
Gson serialization and deserialization adapter for NodeBrowseInfo objects.
com.inductiveautomation.ignition.common.tags.browsing.NodeBrowseInfo
com.inductiveautomation.ignition.common.tags.browsing.NodeBrowseInfo
Gson serialization and deserialization adapter for NodeBrowseInfo objects.
com.inductiveautomation.ignition.common.tags.browsing.NodeDescription
com.inductiveautomation.ignition.common.tags.browsing.NodeDescription
This UI does the heavy lifting for the json editor.
Heads up! If you implement this, you also must be a JComponent
A utility class to mine various information from a given node.
This provides a bridge from the historian back to the system providing data.
Represents the connection between the tag subscription model and the tag execution model.
Provides the meta data needed for an OPC server to subscribe to a node
TagNodes that implement
NodeSubscriptionDelegate tells subscription system the implementing class wants to manage it's own
TagChangeEvents to a SubscriptionNode's listeners.Created by carlg on 5/15/2017.
This class is meant to be the designer side definition of the possible values the NodeBrowseInfo.subType, typically
when the object type is "Node".
Listens to tree expansion events to determine which nodes are currently visible, and thusly must listen for changes.
Methods annotated with @NoHint are ignored by
PropertiesFileDocProvider.This class is a history node that holds and provides values that are already processed based on our query parameters.
A compressor that doesn't actually compress.
Filename: NonKeyMappable
Author: Perry Arellano-Jones
Created on: 7/7/15
This annotation is used to mark a field as non-secret.
A wrapper around a delegate dataset which is only useful because there is a special serialization delegate
registered for it which only serializes the column names and types, but not any of the rows.
A NoOpCookieStore is a
CookieStore which does nothing when asked to add / clear cookies.A no-operation implementation of
IdbMigrationStrategy.A
BindableModel implementation which does nothing.Created by carl.gould on 7/14/2015.
Marks the annotated field as not bindable.
The context for a particular notification.
Specific kind of PushException indicating that a push failed because the active node is not the primary.
The class this annotation is attached to should be not be assumed to be thread-safe.
Like a
SQLQuery, except for named queries.ColorSelectionModel that allows for null colors.This class encapsulates calls to
ColorSwatch which may not be instantiated (aka null).A tool that does nothing.
A text document which will reject any characters that are not digits.
A property editor for editing strings.
Created by carl.gould on 7/27/2015.
Use this to specify a number format property that will have an editor that helps pick format strings
This record class is the root of an OpenAPI specification.
A simple tuple of an object, a field on that object's class, and a method of that object's class.
A Helper class for Object.
The method that this annotation is attached to will directly synchronized on some lock
during its course of execution.
The method that this annotation is attached to will indirectly synchronized on some
lock (i.e.
Defines an offline resource
A component binding that will call a method when an action occurs.
Inner utility class that performs the runtime wiring of all
OnChange bindings.A binding that will call a method when the on-click action occurs on this component.
Enum specifying which mouse button is being bound by this binding.
Inner utility class that performs the runtime wiring of all
OnClick bindings.Runs a script when events that flow through this stage have errors.
A binding that will call one method when the bound component loses focus, and another method when
focus is gained.
Inner utility class that performs the runtime wiring of all
OnFocusChange bindings.Created by mattgross on 7/28/2017.
Sorts annotations along either the X or Y axis, depending on the plot orientation
This is the browse element supported by the OPC subsystem.
com.inductiveautomation.ignition.common.opc.BrowseElement
com.inductiveautomation.ignition.common.opc.BrowseElement
Protobuf type
common.protobuf.PropertyElementPBProtobuf type
common.protobuf.PropertyElementPBAn
OpcConnection is a connection to some kind of OPC server.Base class for
ExtensionPoints that provide an OpcConnection implementation.Manages
OpcConnection instances and provides an interface to read, write, browse, and
subscribe to OPC values via those connections.An
OpcConnection and its associated resource and configuration.Represents an OPC item for purposes of Cut/Copy/Paste
Deprecated.
An object that provides the information needed to subscribe to a node (the NodeSubscriptionDefinition), and receives
the QualifiedValue when the subscribed node changes.
These are Tag Group level properties that pertain to OPC tags.
Used by routes to configure OpenApi OperationObjects.
The OperationAggregator takes a set of objects, splits them up based on keys determined by a KeyProvider, and then
aggregates the results back together in the correct order, after some execution has occured.
The InputValidator provides a way to validate input values before they get to execution.
A record object that represents an OpenAPI
Operation Object.
Similar to the OptionRowEditor but uses toggle buttons and icons instead
Option editor for attributes who a large number of options, more than 4-5.
Option editor for attributes who have a small number of options: 2-5ish.
Use this annotation on reporting shape getter/setter methods to define a set of options for integer properties that
act like enums.
For use when a Dockable Frame should not contribute to the Designer edit menu, but should still return an edit
handler when a context switch is performed
Takes a set of sub conditions and passes if any of them passes.
Annotation used to specify that a property should be ordered directly beneath another property.
Enum representing the origin of a property value.
This edge router uses an orthogonal edge routing algorithm to route edges between blocks at right angles.
Describes at output pin for a pipeline block.
A simple painted layer, used by LayeredOverlay
Class that manages painting data quality overlays for JComponents that are QualityMonitors.
A simple toggle control that indicates whether a property is overridden or not.
This is a map that connects
Member's UID to a set of property overrides.This class contains all of the methods to display and handle RMEditor UI methods.
This class contains all of the methods to display and handle RMEditor UI methods.
An immutable tree element that represents a particular system library package (e.g.
An implementation of historical tag value that stores the enums packed together as an integer.
Deprecated.
Deprecated.
A page contains a number of views all running within the same web page, or tab.
Panel that is placed in the middle of the dock editor to editor properties of the page
Represents a tab for editing page startup scripts.
Created by carl.gould on 1/13/2015.
This class provides GUI editing for RMPage shapes.
Utility class for handling pagination related operations, specifically those that deal with binding Page related
keys to components.
The model underlying the component palette used by the Vision module in the Designer.
Quick filter field that will filter a CollapsiblePanes object if it is populated with
FilterableCategoryPane objects.
Created by carlg on 10/20/2016.
Implementation copied (and simplified) from DefaultSingleSelectionModel and modified to handle objects, not ints.
Created by carlg on 10/20/2016.
Manages a number of palette items (trees) similar to how a button group works
Only one tree node can be selected at any given time.
Reads palette.xml and creates the static set of palette components
Parameters are special types of properties.
Represents a range of float values with a specified start, step, and name.
Represents a range of integer values with a specified start, step, and name.
Represents a range of alphabetical values starting from a given character and generates a list of
alphabetically ordered strings up to the specified limit.
Represents a manually defined list of values.
Represents a numeric range with a specified start value and step.
Table used to fill in a NamedQuery's parameters with a value.
With properties, we can have a mix between inherited and non inherited.
Filename: ParameterKeyPopup.java
Created on Jul 14, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
This is an informational class about what parameters exist in a UDT, including sub members.
Record class that represents an OpenAPI Parameter Object
This is a utility function to help deal with changes we've made to parameters over time (re-introduction of data
types through ParameterValue).
This is the config value for a Parameter.
com.inductiveautomation.ignition.common.tags.config.properties.ParameterValue
com.inductiveautomation.ignition.common.tags.config.properties.ParameterValue
This exception is thrown when parse errors are encountered.
This exception is thrown when parse errors are encountered.
An exception subclass for parser.
This exception is thrown when parse errors are encountered.
This exception is thrown when parse errors are encountered.
A class called when child rules are parsed.
A class called when child rules are parsed.
A parse node.
Really basic interface that can be implemented by both the ELParser and the Query parser.
A class to parse a given input (string) using given rule(s).
A class to represent a parse rule.
Some utility methods and classes for Parser.
A subclass that prints rules.
A parse node subclass that is also a handler.
Result of a call to
ResourceCollectionManager.pushPartial(PushOperation).Immediately forward events to handlers.
A panel that allows for editing of a password in the following way:
Simple 'wrapper' around an actual AuthChallenge that indicates the attempt should bypass any password expiration.
Throw this from
UserSourceProfile.authenticate(AuthChallenge) if the password was correct but expired.A path condition operates on
Paths.Passes if any part of a tag path matches the provided pattern
Encapsulates the UI that lets the user configure the tag change script's options, everything but the script
itself.
This class loads an icon, possibly stretching and applying filters (color replace, color tint) to it.
Record class that represents an OpenAPI
Path Item Object
Base interface is com.inductiveautomation.ignition.common.Path
Base interface is com.inductiveautomation.ignition.common.Path
A tree structure that uses a path to locate values.
Utilities for paths.
A json-schema validation that requires a field confirms to a regex pattern.
A helper class to be used with StepContext.execute, takes a CompletableFuture, and will block step progression until
the future has completed.
This class represents a PDF annotation (like a hyperlink).
This class represents a PDF annotation (like a hyperlink).
An inner class (and annotation subclass) to support hyperlinks.
An inner class (and annotation subclass) to support hyperlinks.
This class is like a StringBuffer, but for creating PDF files instead of strings.
This class is like a StringBuffer, but for creating PDF files instead of strings.
This class is an image producer that uses the RBCodecCCITTFaxDecoder to produce the bits of a 1bpp monochrome image.
An implementation of interface CharStream, where the stream can contain any
binary data.
An implementation of interface CharStream, where the stream can contain any
binary data.
A Snap file subclass for PDFs.
This is an implementation of the DeviceCMYK colorspace as defined in the pdf spec.
A collection of routines for pulling various objects out of PDF dictionaries
The PDFEncyptor is a subclass of PDFSecurityHandler that is used
to encrypt strings and streams for pdf output.
The PDFEncyptor is a subclass of PDFSecurityHandler that is used
to encrypt strings and streams for pdf output.
This class is used to read a PDF file for parsing.
This class represents a PDF file.
This class represents a PDF file.
This class is used to read a PDF file for parsing.
An inner class to store font info.
PDFFontFactory.java
PDFFontFactory.java
An object which holds on to a stream of markup operations for later drawing.
This is an abstract superclass for all objects implementing PDF functions.
This class is used to map cids to widths.
Represents a PDF graphics state stack with graphic state objects.
An inner class for GStates.
The PDFImageColorModel is a subclass of PackedColorModel which can be used to display a pdf image.
A representation of the alpha channel.
This class handles writing images to a PDF file.
PDFIndexedColorSpace
PDFObjectStream
A PDF Output destination.
Writes a report's PDF output to the supplied output stream directly.
This class is used by RMPDFFile to read a PDF file (page) for parsing.
All drawing happens in PDFPage object.
All drawing happens in PDFPage object.
This class is used by RMPDFFile to read a PDF file (page) for parsing.
This class is a subclass of PDFBuffer, that knows how to write an RMPage and its shapes.
This class parses the page marking operators for a specific page number (it gets the
contents for that page from n RMPDFParser.) It uses the various factory objects for
graphic object creation and a MarkupHandler to do the actual drawing.
This class parses the page marking operators for a specific page number (it gets the contents for that page from n
RMPDFParser.) It uses the various factory objects for graphic object creation and a MarkupHandler to do the actual
drawing.
This class represents a pages tree in a PDF file.
This class represents a pages tree in a PDF file.
PDFPattern.java
Created Dec 15, 2005
Copyright (c) 2005 by Joshua Doenias
The Pattern colorspace is a special colorspace where shadings and tiling patterns can be declared.
Implementation of the Adobe Standard security handler using the Sun security extensions for md5 & rc4.
A java.awt.color.ColorSpace subclass to represent a pdf /Separation colorspace.
PDFShadingPattern.
This class represents a PDF stream object.
This class represents a PDF stream object.
This class represents a PDF stream object.
This class represents a PDF stream object.
This class generates PDF for an RMText.
An inner class to store font info.
Represents text spacing details that are defined in between BT & ET operation.
This class handles drawing images as tiles, for when allocating a BufferedImage for the entire pdf image would be
too expensive.
This class represents a PDF XRef entry.
This class represents a PDF XRef Table entry.
An inner class for XRef Table entries.
An inner class for XRef Table entries.
This class represents a cross reference table in a PDF file.
This class represents a cross reference table in a PDF file.
A pen is the main unit of configuration for the EasyChart.
Simple struct-like class that holds pen options for a reporting chart
This interface exists just so that we can have one function to create renderers and an instance of this class can
resolve the differences between pens as they are found in the chart at runtime and as they are found in the
customizer
PenData represents the data for a single pen.
Class that bridges PenData objects into the JFreeChart's Dataset interface
Represents the current state of resources if we were to do an update
Iterates through the various datasets of pens, creating Pen ojbects on the fly.
Returns the percentage of time a value was good/bad, depending on mode.
Deprecated.
com.inductiveautomation.ignition.common.auth.permissions.PermissionsConfig
com.inductiveautomation.ignition.common.auth.permissions.PermissionsConfig
An
AuditRecord wrapper
that contains PersistentFlavor information that can be used within the Store & Forward system.Represents a type of data that can persist across application sessions.
Associates PersistentData with a specific storage destination within an engine.
Utility class for operating on collections of
PersistentData.Interface representing the flavor of a
PersistentData instance.A simple extension of properties that is meant to represent a file based
property file.
An interface that provides methods for serializing and deserializing
PersistentData.A
RedundantAuthTokenManager which manages ProjectAuthTokenRecords bound to
Perspective offline mode sessionsA
RedundantAuthTokenManager.Builder which provides a fluent-style API for incrementally building the
required pieces to create new PerspectiveAuthTokenManager instances.Routes for browsing, touching, and removing Perspective offline mode
PlatformAuthTokenRecords, protected by config read and write permissions.Provides a way to find resources shared by all Perspective sessions.
Implementation of
AbstractSession which is used when the Ignition Designer is creating, running,
and previewing Perspective Views.Helper class that simplifies the creation and proper evaluation of expressions that execute in and around the
binding / transform system.
A PerspectiveExpressionFactory is a
FragileBiFunction which takes a BindingContext and an
expression source as a String and creates and returns the corresponding PerspectiveExpressionA PerspectiveFont is a
Triple of a font name (i.e.Enumeration of font types supported by Perspective and their respective MIME types
Same as the base
KeyEditorField, but with an additional validator based on PropertyRef.NAMEContains common configuration and const definitions for things like module ID, and also provides a registry for
components.
RPC Interface for the Perspective Module.
Named subclass of base
NodeEditor so that PerspectiveNodeEditor.createKeyEditor(DocumentNode) can
return a PerspectiveNodeEditor instead of the default object.A polling blocking task that looks up its rate from a property tree and is reactive to the rate changing.
Manages a polling task that looks up its rate from a property tree and is reactive to the rate changing.
A PerspectiveProject is a simple container of a
ProjectConfig, concatenated compiled CSS style resources,
and the Map of all style resource IDs to their compiled CSS in the ResourceCollection.Used to provide scripting access to some metadata about the project
The PerspectiveProjectCache manages a cache of the latest
ProjectConfig and concatenated css classes
compiled from the style resource JSON sources on a per-project version basis.Contains a running Perspective project for a session.
Panel used in the project property editor for manipulating perspective project options
This is the top level of session object for a collection of "project" sessions.
Struct-like class describing session details used by the status pages.
Used for customer-facing encoding of this class, but not used for the status page's encoding.
Simple class which holds a set of auth sessions that are currently live.
A
PerspectiveExpression which has an additional PerspectiveTransformExpression.execute(QualifiedValue) method to handle updating
the underlying Expression with the incoming value and subsequently executing the expression which may be
bound to the incoming value.Mounts a websocket servlet for use by the Perspective module.
Acts as a
TabbedWorkspaceListener which manages the book keeping of the Perspective Workspace's currently
selected Perspective Editor's EditActionHandler and also notifies the appropriate
ViewResourceEditor when it has been activated / deactivated.Deprecated.
since 8.3.
Component used by the BasicBlockUI to represent an anchor point.
A
PipelineBlock.BlockEvaluationContext is an "instance" for evaluating an incoming AlarmEvent against a PipelineBlock's configuration.An interface that may be used on the UI that is returned from
PipelineBlockPrototype.createEditingUI(DesignerContext, PropertySet) so that the UI knows when to commit its
edits.
A pipeline block prototype describes a pipeline's general nature for the purposes of visual design within the
pipeline design workspace.
A record that contains information about a data pipeline within a store and forward engine.
Gson-compatible class that wraps up the details that the designer retrieves from the js bridge about a selected
pipes.
Just a standard template for a placeholder empty panel to show before something gets selected.
Wrapper around a byte array representing plaintext to be encrypted into ciphertext or decrypted from ciphertext.
A collection of RPC interfaces which exist at the platform level and can be used by clients and designers.
Filename: PMI2StateButtonTermFinder.java
Created on Nov 18, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
Utilities to help with internationalization
This component is commonly referred to as the "Classic Chart".
A subclass of JFreeChart's ChartPanel that overrides doSaveAs() and createChartPrintJob() to have FPMI compatible
popup windows for FSE mode.
Represents a range of dates, from a start to an end
History: Base code pieced together from code found on java.sun.com forum posting
http://forum.java.sun.com/thread.jspa?threadID=494920&start=15&tstart=0
Deprecated.
Represents a simple style configuration for a button
Abstract superclass of all FactoryPMI shape components.
Deprecated.
Abstract class representing a strategy for storing points in a historian system.
Listener interface for handling batches of temporal points when they are ready.
Scaffolding for managing the execution of a blocking task that may need to poll or be executed on-demand.
Scaffolding for managing the fetching of a completable future that may need to poll or be executed on-demand.
Represents a polling rate, either off, relative, or absolute, with a time value in milliseconds
This class manages creation and editing of polygon shapes.
This inner class defines a polygon tool subclass for drawing freehand pencil sketches instead.
A Popup_dialog is a clean, lightweight, "modal" window intended for simple pop-up user-interface widgets.
This class uses a lower-level implementation of Popup than the similar JPopupMenuHelper class does.
A popup window that has a JList instead of menu items.
Defines a class that will be used as a FPMI Client popup window, for some window contents.
Wraps the logic of displaying a small panel in a popup.
A predicate map connects predicates of a certain type to multiple objects of another type.
This class provides a Preferences panel UI window.
Use this to mark properties as "preferred" which means they are the properties a user is most likely to edit
This class provides a Preferences panel UI window.
Created by carl.gould on 3/3/2015.
Created by carl.gould on 3/4/2015.
Filename: PreviewLanguagesMenu.java
Created on Feb 24, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Ignition
This delegate serializes one-dimensional arrays of types that can be represented in a very simple manner.
Filename: PrintAction.java
Created on Mar 23, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: PrintActionConfig.java
Created on Mar 23, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: PrintActionPanel.java
Created on Mar 23, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Implements the functions mounted as "system.print" on all scopes
Created by colby.clegg on 7/31/2015.
Represents the base context for initializing point processing.
This class lets various "profile" items (notification profile, tag history profiles, etc) communicate basic running
state information.
This enum defines the general state in coarse terms.
Deprecated.
Since 8.3.0; create a
Task if you want platform managed UI for an asynchronous task.Interface for listening to something that can be tracked.
The idea of progress tracking has multiple facets, namely:
Designer tasks Designer/Gateway communciation tasks
Designer tasks Designer/Gateway communciation tasks
The root node of the designer's project browser tree.
Given to a project in order to apply all changes pulled from the Gateway, along with the choices made on resource
conflicts.
A GSON-serialization compatible class that holds all of the information about a project that a Vision client
needs in order to be able to get started and logged-in, after which it can download the whole project.
Deprecated.
The ProjectConfig class is
Gson serializable model used by the gateway to represent a saveable Perspective
client state for a given Perspective module Project.A tag manager that translates tag paths sources between the "default" source of empty string and the absolute name of
a project's default tag provider
The ProjectDeletedEvent is fired on the
PerspectiveProjectCache event bus when a ResourceCollection
is deleted.Stores all required attributes and resources for a created or imported project.
The Direction the transition is moving towards.
Projects rates by extrapolating from processing duration of event batches.
Collection of utility methods to encode and decode resource collection and related objects to/from JSON.
A utility class for inspecting, identifying and loading Projects from Files or streams.
A
ComboBoxUI that renders an arrow and text at the correct padded position.A ProjectImport is a self-contained collection of the information that represents a single Ignition Project.
Deprecated.
The ProjectRebuiltEvent is fired on the
PerspectiveProjectCache event bus when an existing
ResourceCollection has had its component resources (list of js, css files needed) changed.Deprecated.
A button that displays a tree of the given project resource type in a popup.
Convenience class for a text field that will validate a resource path, such as a Named Query.
Used in the gateway status section to show information about gateway-run project scripts.
A ScriptModule representing a project resource.
ProjectTags are what we call Client Tags.
This tag manager hold the root of the project tag tree configuration.
The ProjectUpdatedEvent is fired on the
PerspectiveProjectCache event bus when an existing
ResourceCollection is updated.Created by carlg on 7/5/2017.
Utilities for Project package.
Simple implementation of LaunchContext.WritableProject.
A
Promise is, as the name implies, a rough analogue of other languages (such as JS)'s "Promise" class.Little helper class that holds an old value of something for property-change listener purposes.
Default ScriptFunctionDocProvider implementation that relies on various annotations on methods and fields to look up
script documentation in properties files.
A Property describes a unique name and datatype for a property.
This class describes an attribute of an entity.
A tag path that delegates to another tag path, but alters the TagProp that the path points to.
A tag path that delegates to another tag path, but alters the TagProp that the path points to.
This annotation is used to hold property amendments for a component.
This context creates expressions that reference properties.
Collects the most recent value per path, and is an envelope for sending them to the client.
Column model for the classic property table (from pre-JIDE days).
A condition that support a number of property related sub-conditions.
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.
Popup window used for jython property 'binding' windows.
Created by carlg on 6/14/2017.
DialogPage that wraps an instance of an AbstractPropertyEditorPanel in a JIDE DialogPage, adding a banner on top.
An interaction descriptor that represents a dependency on a source component's property.
A property key is a hashable combination of component + property name
Uniquely identifies a property of a component by combining it's path and it's property scope.
This subclass of PropertyInteractionDescriptor is simply an PID that is also the listener, and a ValueHolder.
Represents a "property" of a component.
This property node subscribes directly to a tag property, and can deal with scalar, array, and dataset types.
Represents a Property of value <T> that can be subscribed to using
PropertySubscriber.This interface converts an id to a Property, if the id exists.
A PropertySet is a collection of property values.
Abstract superclass for pipeline blocks that are backed by an
ObservablePropertySetThis is the UI panel for the "Set Property" event script builder.
Like other Config entities, this object houses a source PropertySet and a Diff.
Note: This class is incorrectly named.
The property set that is currently being edited in the property table.
This node manager publishes properties from a PropertyValueSource.
A wrapper around different types of PropertySets that can be Protobuf serialized.
A wrapper around different types of PropertySets that can be Protobuf serialized.
A wrapper around different types of PropertySets that can be Protobuf serialized
This class is used to subscribe to a
PropertyPublisherReadOnly and consume the values emitted by the
publisher.
Registry for dynamic suggestion sources for perspective component properties.
Created by carlg on 2/7/2017.
This custom PropertyTableModel adds the following features:
Adds filtering based on bean properties: All, Standard, Expert
Adds styles for the property name for dynamic props and bound props
Table model used to obtain property names and values.
This class represents a tree structure of properties.
Event for whenever a property in a PropertyTree changes.
A PropertyTreeOwner manages a set of
PropertyTrees for the various
PropertyTypesObject attached to a property tree that controls which nodes may be written to and sync'ed to the browser.
This represents a simple type system that is a bridge between documents/json which aren't very strongly typed, and
our/java's type system, mostly for the purpose of storing/using properties.
Created by carlg on 1/5/2017.
Indicates that the value provided cannot be cast to the correct type for the property.
Some basic functions that aide our use of properties, or help consolidate logic.
An editor for types which have a property editor.
An editor for types which have a property editor.
com.inductiveautomation.ignition.common.config.PropertyValue
com.inductiveautomation.ignition.common.config.PropertyValue
This interface represents a specific subset of functionality implemented by most property holders (such as
PropertySet), used to retrieve property values.Add this inside a PropertyAmendments annotation to notify the system of a property that used to be on a component
but was removed.
Add this inside a PropertyAmendments annotation to notify the system of a property whose name changed.
Tree node that represents a scope of a component like "props" or "custom"
Tree node implementation for displaying the structure inside a single View.
Wraps a Property to be used with the
ConfigPropertyTable.Options dialog that pops up when the user tries to open a protected resource
Parent exception that captures other exceptions while deserializing an object from its Protobuf form
Parent exception that captures other exceptions while serializing an object to its Protobuf form
Utilities for converting between Protobuf's Json representation (
Value) and Gson's (JsonElement).A Protobuf based serialization handler.
A builder for creating a ProtoRpcSerializer.
The ProviderContext provides access to important information, tools, and systems under the appropriate Tag Provider.
Does a case-insensitive filter on provider name when browsing children.
Deprecated.
Use
ProxyRulesResource instead.Specific kind of PushException indicating that a push attempted to create a resource but a resource with the same
path already exists.
Thrown by ProjectManager to indicate there was a problem applying the ChangeOperations in a push.
Deserializes a push notification message from the provided input stream.
A listener for "push notifications" (out of band events broadcast from the gateway).
An adapter to send arbitrary types over the Designer/Client's "push notification" API, allowing the gateway to
initiate actions out of band.
Created by colby.clegg on 10/27/2014.
A utility class for converting Jython's keyword argument signature (
PyObject[], String[]) into more useful
Java base classes.This class represents any "scope" in the SFC system, and is fundamentally just an observable dictionary.
An observer that gets notified when the scope is modified.
com.inductiveautomation.sfc.api.PyChartScope
com.inductiveautomation.sfc.api.PyChartScope
A Jythonic wrapper around a Dataset.
Protobuf type
common.protobuf.DictEntryPBProtobuf type
common.protobuf.DictEntryPB
org.python.core.PyDictionary
org.python.core.PyDictionary
Protobuf type
common.protobuf.PyAsJsonPBProtobuf type
common.protobuf.PyAsJsonPBProtobuf type
common.protobuf.PyObjectPBProtobuf type
common.protobuf.PyObjectPBAllows tag properties to be expressed as a PyDictionary, which makes tag editing via scripting much easier.
Extension of ArrayList to allow a list of PyTagDictionaries to be easily identified
Created by colby.clegg on 8/28/2015.
Indicates that the data in SendRequestResult is actually a stringified PyObject.
An
EditActionHandler for PythonTextAreas which takes care of the basic Copy / Cut /
Paste / Delete actions.A User implementation that delegates to another user object, but has some methods that are more scripting friendly.
Represents a polygon made of 4 points.
This class is a path to anything in Ignition, across any system.
A builder to assist in constructing
QualifiedPaths.A binary adapter for serializing and deserializing
QualifiedPath objects.A binary adapter for serializing and deserializing
QualifiedPath objects.Represents an adapter for processing and normalizing
QualifiedPath objects.
com.inductiveautomation.ignition.common.QualifiedPath
com.inductiveautomation.ignition.common.QualifiedPath
Filename: QualifiedPathTransferable.java
Created on Aug 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
This class provides utilities related to
QualifiedPaths.Represents a value with a DataQuality & timestamp attached to it.
A binary adapter for serializing and deserializing
QualifiedValue objects.since 8.0
This extension of PropertySet adds support for retrieving the quality of properties, generally for the purpose of
bound property values.
com.inductiveautomation.ignition.common.model.values.BasicQualifiedValue
com.inductiveautomation.ignition.common.model.values.BasicQualifiedValue
Base interface is com.inductiveautomation.ignition.common.model.values.QualifiedValue
Base interface is com.inductiveautomation.ignition.common.model.values.QualifiedValue
Created by carlg on 1/10/2017.
Deprecated.
QualityCode contains a 32-bit integer code and optionally a diagnostic string.
A binary adapter for serializing and deserializing
QualityCode objects.This class currently extends StringPropertyEditor, to present the quality code as a string.
This class is a type of exception that is used to communicate a QualityCode based result.
com.inductiveautomation.ignition.common.model.values.QualityCode
com.inductiveautomation.ignition.common.model.values.QualityCode
A filter for quality levels.
A builder for creating a QualityLevelFilter.
A component that monitors the quality of its properties' values.
This class provides some basic functions for creating derived QualityCodes and values.
Represents the information associated for any quarantined data.
The
QuarantineInterface provides a common API for handling quarantined data operations.QueriedPointProcessor<P extends TemporalPoint<?,T>,K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>
Processes temporal points with support for initialization, point processing, and error handling.
This represents a tag history query against a wide table.
An object to fetch a dataset from a data source entity with a set condition and parameters.
Represents a type of point that can be queried in the historian system.
Implementation of a perspective query binding.
Stores queries prepared for execution - that is, with columns quoted, etc.
Interface that all config objects that represent query sources must implement.
This is the designer-scoped interface that 3rd party module authors need to implement to add new query types.
This class must be extended by authors of new query types.
The query context provides information about the overall query that might be useful to aggregation functions.
Created by carl.gould on 3/4/2015.
The QueryEngine interface defines methods to retrieve and process historical data,
including raw, aggregated, and complex data points, for querying purposes.
A utility class that helps extract filters from the `filters` component object property
which when read from the PropertyTree is a QualifiedValue.
Like QueryNode, but with an additional property to let us know the name of the Named Query parameter
this node represents.
When creating the
QueryHolder, we parse the text the user input into string chunks and tag chunks.Base interface for all query keys.
Represents the options for querying supported queryable
TemporalPoint.Protobuf type
common.protobuf.AggregatedQueryOptionsPBProtobuf type
common.protobuf.AggregatedQueryOptionsPBProtobuf type
common.protobuf.RawQueryOptionsPBProtobuf type
common.protobuf.RawQueryOptionsPBThis is the "ConfigObject" for the Query data source.
Represents a single query in a tree of nested queries.
Created by carl.gould on 3/5/2015.
This object represents the results of a query / nested query structure generated by a report's query datasource.
This interface is not used directly for rpc calls, because methods here relies on streaming.
A QuerySource executes a type of report query.
Used to handle multiple executions of a nested query.
An embedded historian that uses QuestDB as the storage engine.
Deprecated.
Use
QueueSettingsResource instead.Filename: RadarChart2TermFinder.java
Created on Aug 5, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
The
RadialGradientPaint class provides a way to fill a shape with
a circular radial color gradient pattern.A concrete subclass of PDFShadingPattern which implements pdf radial (type 3) shadings.
A persistent circular buffer system that uses a
RandomAccessFile as the backing store.A component that displays polling rate options
A marker interface for processing raw data points.
Represents a key for querying raw data points.
A binary adapter for serializing and deserializing
RawQueryKey objects.Represents the options for querying raw data points.
A builder class for constructing instances of
RawQueryOptions.A binary adapter for serializing and deserializing
RawQueryOptions objects.This class provides a bunch of core functionality for loading and saving Ribs documents.
Does special Mac-only initialization.
This is Ribs version of the AttributesPanel
LZW decompressor
The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can be a real part of
the document/shape hierarchy.
This inner class models MenuBars, Menus and MenuItems as TreeNodes.
An inner class to act as RMDocument's Tool.
This RMEditor subclass customizes RMEditor behavior for Ribs.
Handles drop listener stuff for an RBEditor.
This ribs shape painter adds support for clipping child shapes (like for scrollpane).
This RMEditor subclass customizes RMEditor behavior for Ribs.
This class manages the inspector panel.
This class contains static utility methods for generically getting and setting values on any object
using a key chain string.
This class shows the current set of keys relative to the current editor selection in a browser and lets users
drag and drop them to the editor.
This class manages a list of objects provided by a rib file's owner to facilitate binding to UI controls.
List Model implementation for lists using bind key.
This page subclass represents an RJPanel in the ribs designer.
Provides for Swing UI editing of RBPage properties.
Simple class to run Ribs preview apps.
An inner class to be a glass pane for the editor while testing rib files in editor window.
The base tool class for ribs tool.
Represents a front-end react component that can be mounted.
Used to build a json object representing a config section form, used in the React front end.
Reader interface for reading from a data store.
A DocumentModel that will never be editable.
Use this annotation to list properties that should not be editable.
Options dialog used to allow users to immediately (or temporarily) elevate their comm mode for a particular operation
Filename: RealtimeDateRangeTermFinder.java
Created on Dec 06, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
Tag history query param implementation that dynamically returns start and end dates based on the current time.
Encapsulates the current
MigrationContext and PersistentRecord to be encoded so that
RecordEncodingDelegates have everything they need to do their job.Encapsulates the logic used to convert a PersistentRecord to a Resource.
com.inductiveautomation.sfc.recorder.RecordingMeta
com.inductiveautomation.sfc.recorder.RecordingMeta
Protobuf type
sfc.protobuf.RecordingMetaPb.ChartMetaPbProtobuf type
sfc.protobuf.RecordingMetaPb.ChartMetaPbHolds an SRecordInstance and its foreign key reference to another table.
Simple renaming class of SRecordMeta to be consistent.
Contains static utility functions for dealing with persistent records.
Represents a rectangle - a Quadrilateral with parallel sides.
This class handles editing of rectangle shapes.
Util class which contains helpful Reducers
Holds a list of change operations that need to be applied to a redundant node's provider to bring it into sync
with the other node's provider.
Used by the redundancy manager to execute tasks on both redundant nodes, and to pass one-shot messages from the
master to the backup.
Register an instance of this class using
RedundancyManager.addMessageHandler(java.lang.String, com.inductiveautomation.ignition.common.messages.RedundancyMessageHandler<?>)
Whever a message is received from the peer node (with the protocol string that is registered for this handler),
this handler will fire.
com.inductiveautomation.ignition.common.messages.RedundancyMessage
com.inductiveautomation.ignition.common.messages.RedundancyMessage
These are all of the redundancy settings for both master and backup.
A RedundancySignature is used to compare an object between gateways.
See the
RedundancyDiff class Javadoc for a full rundown on how this class is used.Empty implementation of
RedundancyStateListener that can be subclassed.Generic exception that can be used in redundancy synchronization
A very general purpose interface to provide a reference to an object that may or may not be available.
A reference represents when a property of a resource references another resource.
Represents a range of alphabetical values from a starting character to an ending character or string.
Represents a numeric range with specified start, end (inclusive), step, and format.
Encapsulates the logic used to start up all bindings in a view and its components.
This class allows all the rows of a given table to be listed in a dropdown on a Wicket page.
Represents the choice to make when reference(s) are found when renaming a resource.
A property on a resource that references another resource.
Helps build a
ReferenceProperty, which represents a property on a config resource that references another
resource by name.This class keeps track of references for the XMLSerializer.
Represents a reference to another resource, and the logic to update that reference.
A collection of utility methods and classes to handle all the of the Java Reflection calls
need to wire and fire bindings.
Abstract JsonDeserializer that will use the default Gson reflective deserialization logic, and then let subclasses
perform further logic on the deserialized object.
This is a message that can be passed through redundancy and will reflectively invoke a function on the far side.
Used to annotate a type that should generate a reference schema instead of a reflectively discovered inline schema.
A class for building regular expressions like a string buffer.
A regular expression based implementation of
AbstractFormatter.This class just runs a simple modal panel to register user name and email on first run.
Describe this class
Similar to LinearGradientPaint, but this one specifies it's points as percentages of the user-space bounds of the
object it will fill.
The relative path provider, as the name suggests, is used for building relative paths.
Similar to RadialGradientPaint, but this one specifies its points as percentages of the user-space bounds of the
object it will fill.
This invocation handler simply relays invoke to another invocation handler, except that it intercepts equals(Object),
hashCode(), and toString()
Created by colby.clegg on 11/11/2015.
Deprecated.
A sink that stores tag history data to a remote gateway.
An interface used to abstract settings for remote objects, like realtime providers,
or historical providers, used by the RemoteProviderChoicePanel
This history query executor executes a query against a remote gateway.
A subinterface of TreeNode that adds some information to help it render.
Used in conjunction with
AbstractRM2DShape to determine what output should be produced: vector graphics,
or raster (at specific DPIs).For a given list of FlowCells, this class assigns a
RenderInfo to each cell.RenderOptions is an abstract class that represents the options needed to create a renderer for a collection
of "pens" or series that share the same basic render style but have different series specific options such
as color.
A RenderStyle represents a specific configuration of chart renderer.
Algorithm for reordering items in a list.
A wrapper around Ignition's Dataset that is understandable by the reporting system
Created by carl.gould on 2/5/2015.
Filename: ReportActionUtils.java
Created on Feb 09, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Used to let the Gateway send a push notification to projects when the report completes execution
Filename: ReportConverter.java
Created on Jul 20, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
A file for Snap reports.
Note that this class is both XML serializable and traditionally java serializable, to be compatible both with saving
report resources and sending this object over RPC for gathering sample data
Protobuf type
reporting.protobuf.ReportDataConfigurationPbProtobuf type
reporting.protobuf.ReportDataConfigurationPbThis is the interface that module authors who wish to add a new report data source must implement and register
in the Gateway scope.
Created by carl.gould on 3/3/2015.
Builder pattern because the number of parameters is getting to be insane.
ReportLoggerEx is a logging class that extends LoggerEx to add errors to the ReportExecutionData's error list
when a WARN or ERROR level messages are logged.
Protobuf type
reporting.protobuf.ReportExecutionDataPbProtobuf type
reporting.protobuf.ReportExecutionDataPbFilename: ReportExecutionStatus.java
Created on Apr 21, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: ReportExpressionEditor.java
Created on Mar 09, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: ReportFormat.java
Created on Feb 04, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Created by carl.gould on 1/13/2015.
Created by carl.gould on 6/8/2015.
Is the tabbed workspace for reports, extended to allow Report Resource types, and their customized leaf node
structure.
Background worker that resizes a byte[] to 250x300 for display in thumbnails/preview panels.
This class exists to isolate the reporting designer hook's vision dependency, so that it is a soft dependency
and the reporting module can exist as a standalone Module.
This class is used as a helper object by RMDocument to generate a report.
This class is used as a helper object by RMDocument to generate a report.
An inner class to provide a hook for converting objects (like NSArray to List, etc.).
An inner class to provide a hook for converting objects (like NSArray to List, etc.).
An interface for classes than want to know about filled shapes.
An interface for classes than want to know about filled shapes.
A base class that loads and runs reports.
A shape class to represent multiple pages of shapes.
Created by carl.gould on 1/13/2015.
Protobuf type
reporting.protobuf.ReportParameterPbProtobuf type
reporting.protobuf.ReportParameterPbAuthor: Perry Arellano-Jones
Year: 2015
Author: Perry Arellano-Jones
Year: 2015
Filename: ReportPopupInitializer.java
Created on Jul 28, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
A thread-local accessible context that should be non-null while a report is rendering.
Created by carl.gould on 2/5/2015.
Created by carl.gould on 1/13/2015.
Filename: ReportSchedulerTask.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright Inductive Automation
2015 Project: Reporting
Filename: ReportScheduleRunner.java
Created on Feb 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Adapter for PyDictionary to be serialized and deserialized by the ProtoSerializer.
Filename: ReportScriptingFunctions.java
Created on Mar 27, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: ReportScriptingFunctionsPyWrapper.java
Created on Mar 27, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: ReportStatusManager.java Created on Apr 02, 2015 Author: Kathy Applebaum Copyright Inductive Automation
2015 Project: Reporting
Filename: ReportStatusWatcher.java
Created on Apr 20, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
filename: ReportViewer.java
author: Perry
ReportViewerBeanInfo.java
author: Perry
This is the event object that will sent through the event bus to generate a "refresh" event here in the
delegate.
Author: Perry Arellano-Jones
Year: 2015
Project: Reporting 3.0
A request to a server.
Wrapper around an HttpServletRequest to include some helpful data for
RouteHandler instances.Convenience class to request focus on a component.
An annotation to provide a hint in the OpenAPI schema that the field is required.
For texts that are required, this validator checks if the text is empty or null.
Reserved Security Levels and their descriptions.
Protobuf type
common.protobuf.CreateOperationProtobuf type
common.protobuf.CreateOperationProtobuf type
common.protobuf.DeleteOperationProtobuf type
common.protobuf.DeleteOperationProtobuf type
common.protobuf.ManifestOperationProtobuf type
common.protobuf.ManifestOperationProtobuf type
common.protobuf.ModifyOperationProtobuf type
common.protobuf.ModifyOperation
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionDiff.AbsoluteDiff
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionDiff.AbsoluteDiff
com.inductiveautomation.ignition.common.resourcecollection.ChangeOperation
com.inductiveautomation.ignition.common.resourcecollection.ChangeOperation
This sealed interface represents all supported resource "capabilities".
An immutable collection of
ResourceActions, with type-safe getters for easy consumption in
subsystems.Part of a
ResourceTypeMeta that provides custom auditing of the resource.Represents a change event in a resource collection.
Responsible for encoding and decoding configuration
Resource objects.Represents a change event in a resource collection.
The
ChangeOperations associated with a resource collection when pulled from the Gateway.An absolute diff, i.e.
An effective diff, i.e.
A resource collection lifecycle is a specialized
AbstractLifecycle that is designed to make implementing
lifecycle management for a RuntimeResourceCollection easier.A factory for creating and managing
ResourceCollectionLifecycles.ResourceCollectionListener get registered with the resource collection manager.
Contains the metadata for an entire resource collection, including inheritance linkage information.
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionManifest
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionManifest
Used by the abstract tabbed workspace, this is all the information the workspace needs to know about your resource
type so that it can correctly integrate with the nav tree.
A delegate on
ResourceTypeMeta that provides an Entity that represents a resource type.Unique ID for a resource, containing the resource collection name, module id, type id, and folder path.
com.inductiveautomation.ignition.common.resourcecollection.ResourceId
com.inductiveautomation.ignition.common.resourcecollection.ResourceId
Serializes/Deserializes a ResourceId from a JSON element.
Deprecated.
Represents a full resource path from the file system, relative to a particular resource collection.
com.inductiveautomation.ignition.common.resourcecollection.ResourcePath
com.inductiveautomation.ignition.common.resourcecollection.ResourcePath
com.inductiveautomation.ignition.common.resourcecollection.ResourceType
com.inductiveautomation.ignition.common.resourcecollection.ResourceType
com.inductiveautomation.ignition.common.resourcecollection.Resource
com.inductiveautomation.ignition.common.resourcecollection.Resource
Part of a
ResourceTypeMeta that provides a way to find references to other resources.Contains various meta information used by the system that automatically creates routes for a resource type.
A Designer session and their open resources
Represents the content of a resource within the context of a
ResourceId, i.e.
com.inductiveautomation.ignition.common.resourcecollection.ResourceSignature
com.inductiveautomation.ignition.common.resourcecollection.ResourceSignature
com.inductiveautomation.ignition.common.resourcecollection.Snapshot
com.inductiveautomation.ignition.common.resourcecollection.Snapshot
A delegate that provides health checks and metrics for a particular resource type.
Deprecated.
A ResourceTypeMeta provides metadata and performs delegate actions that pertain to a particular type of configuration
resource.
A ResourceValidator is a class that can validate the state of a resource's config object
A main editing area for the designer.
A resource workspace frame is a dockable frame that will be available for display when its associated workspace is
selected.
A thin wrapper around the
HttpResponse class.The response.
An exception wrapped around a failed response.
Record class that represents an OpenAPI
Response Object
Formats an object returned by a
RouteHandler into a string suitable for the body of an HTTP response.Record class that represents an OpenAPI
Responses Object
Specialized serializer to accommodate the specification's format of this object doesn't naturally work with GSON
Interface to indicate that the implementing class needs to implement a flag that indicates whether the redundant
backup is in the midst of a gateway restore.
A historian query results in a series of nodes from which the ultimate data is read.
Protobuf type
common.protobuf.ResultPB
com.inductiveautomation.ignition.common.browsing.Result
Protobuf type
common.protobuf.ResultPB
com.inductiveautomation.ignition.common.browsing.Result
The results of a browse operation.
Results.PyWrapper<T extends org.python.core.PyObject>
A binary adapter for serializing and deserializing
Results objects.helper class for processing JDBC ResultSet objects
Protobuf type
common.protobuf.InnerResultsPBProtobuf type
common.protobuf.InnerResultsPBProtobuf type
common.protobuf.ResultsPB
com.inductiveautomation.ignition.common.browsing.Results
Protobuf type
common.protobuf.ResultsPB
com.inductiveautomation.ignition.common.browsing.Results
Represents the options for writing query results.
A builder class for constructing instances of
ResultWriterOptions.Enum representing the type of object for the query result.
Enum representing the format of the query result.
A binary adapter for serializing and deserializing
ResultWriterOptions objects.Protobuf enum
common.protobuf.ObjectTypePBProtobuf enum
common.protobuf.ResultFormatPBProtobuf type
common.protobuf.ResultWriterOptionsPBProtobuf type
common.protobuf.ResultWriterOptionsPBSent by the frontend when a page reconnects the websocket to an existing PageModel
Encapsulates all information passed across a cross-gateway retarget, or a same-gateway restart for when the jars need
to be re-downloaded.
Tested are included with
HandlerStage.Deprecated.
A type of
PersistentData that can have a success and a tried state as well as a failure reason.Represents the state of the data
Specifies how data is returned for history queries.
This really just exists because property sets don't like generic collections
Interface for enums that have reverse values (ie flex direction)
This class helps to load and manage panels and windows of GUI components in the form of a rib file, which is a simple
XML description of UI controls.
An interface for objects that want notification about event processing.
An interface for objects that want notification about event processing.
A ribs version if RXArchiver to use RJHelpers to load classes.
An AWTEventListener implementation to capture isAltDown(), isMetaDown() and notifications: appActivated,
appDeactivated.
An interface for objects that want notification about event processing.
An Ribs event queue subclass to capture isAltDown(), isMetaDown() and send Ribs.EventListener notifications.
An Ribs event queue subclass to capture isAltDown(), isMetaDown() and send Ribs.EventListener notifications.
An interface for an exception handler.
A gallery panel for ribs Swing components.
FocusListener implementation to add nice editing behavior to CallbackText.
This class provides Swing GUI editing for the currently selected shapes location and size.
This class offers a number of useful general purpose utilities used by ribs classes.
This Error subclass lets us rethrow exceptions.
This class encapsulates additional information for uncommon actions.
This component displays a hierarchy of data like a JTree, however, it does it with a number of distinct JTables
layed out horizontally.
This component displays a hierarchy of data like a JTree, however, it does it with a number of distinct JTables
layed out horizontally.
AbstractBrowserModel - A public interface for controlling a browser.
Provides Ribs management for RJBrowser.
This class is never instantiated directly - it is the superclass for
JButtonShapes & JLabelShapes.
This is a JCheckBox subclass to support a "Three State" mode.
Provides some extra Ribs management for RJCheckBox.
A ColorWell subclass that handle a whole grid of color swatches, including drag and drop support.
A ColorWell subclass that handle a whole grid of color swatches, including drag and drop support.
Provides Ribs specific support for color well.
Provides an RMShape representation of an RJColorDock.
A class to act as color dock's inspector.
This class provides Swing UI for selecting a color.
This class provides Swing UI for selecting a color.
An interface for the object(s) that provide and receive color panel color.
An inner class to act as an image color picker.
An inner class to act as an image color picker.
This class is a label subclass with a popup menu attached to implement popup menus.
This Swing control class displays a color value and kicks off the ColorPanel when clicked.
This Swing control class displays a color value and kicks off the ColorPanel when clicked.
Provides Ribs specific support for color well.
Provides Ribs specific support for color well.
An RMShape subclass for RJColorWell.
A class to act as color well's inspector.
A class to act as color well's inspector.
This class acts as a stand-in for classes not directly supported by the Ribs design application.
An RMShape subclass for RJCustomView, that stands in for any referenced JComponent subclass.
Provides RMTool implementation for RJCustomViewShape.
This class is a Swing/Ribs Font panel for selecting fonts.
An interface for Font Panel Model.
This class is used to provide Ribs functionality to Swing JComponents.
Copyright (c) 2004 ReportMill Software, Inc.
This interface is implemented by anybody that wants to use the RJStringListTool widget
in their inspector.
This class is a label subclass with a popup menu attached to implement popup menus.
This class is a label subclass with a popup menu attached to implement popup menus.
Implements Ribs helpers methods for RJMenuButton.
Implements Ribs helpers methods for RJMenuButton.
RMShape subclass for RJMenuButton.
Provides RMTool implementation for RJMenuButtonShape.
A class to act as color well's inspector.
This class is the root of all Rib files and the unified point of access for all of its child components (and,
optionally, it's window).
A helper class to add Ribs specific functionality to RJPanel.
Provides inspector for RJPanelShape.
This class draws the buttons in the border chooser, plus holds utility methods for choosing borders
An RMShape subclass to represent Swing components.
This class encapsulates a list of child components which can be switched in and out, like a tab view without the
tabs.
A class to act as switch pane's inspector.
An inner class to act as a RJTextShape's tool.
This class has the behavior of a slider, without boundaries (so you can set values beyond the visible min and max).
This class has the behavior of a slider, without boundaries (so you can set values beyond the visible min and max).
Ribs Helper for RJThumbWheel.
An RMShape subclass for RJThumbWheel.
An RMTool implementation for RJThumbWheelShape.
An inner class to act as RJThumbWheelShape Tool
Copyright (c) 2004 ReportMill Software, Inc.
Copyright (c) 2004 ReportMill Software, Inc.
Created by carl.gould on 7/14/2015.
Created by carl.gould on 7/20/2015.
An AWTEventListener to listen for app activate/deactivate and modal dialog activate/deactivate to hide or show
hide-on-deactivate windows and disable always-on-top for always-on-top windows.
This class provides an anim agent to fade and scale a shape in over time.
This class provides an anim agent to drop a shape over time as if it's pulled by gravity.
This class provides an anim agent to insert text letters sequentially with typewriter sound effect.
This class is the base class used for creating sophisticated animation effects, like gravity.
This class represents a timer for animation, holding things like a current time and max time.
This class represents a timer for animation, holding things like a current time and max time.
An interface for classes that want to receive notification of certain animator events.
An interface for classes that want to receive notification of certain animator events.
A shape that can orient its children along a bezier path.
A shape subclass that adds the ability to be rotated about an arbitrary point.
Provides Swing UI editing for RMAnimPathShape.
This class holds a number of convenient static methods used for animation stuff.
This class holds a number of convenient static methods used for animation stuff.
Does special Mac-only initialization.
This is an applet implementation used to host an RMViewer in a browser.
This class handles RM document archival.
This class handles RM's legacy unarchival.
This interface defines the method necessary to add archival support to an object.
A collection of array utility methods.
A collection of array utility methods.
RMASNode is the class used by the parser to construct a tree representation of
an ActionScript file based on the parser grammar.
RMASParser parses ActionScript to generate the byte-codes and binary encoded actions that are executed by the Flash
Player.
This class has a bunch of convenience utility methods from drawing lines, RMRects, buttons, etc.
This class has a bunch of convenience utility methods from drawing lines, RMRects, buttons, etc.
This class models a simple bezier curve, providing methods for extracting points, distance calculation, bisection,
hit detection and such.
This class models a simple bezier curve, providing methods for extracting points, distance calculation, bisection,
hit detection and such.
Hit detection for bezier and a line.
Hit detection for bezier and a line.
An implementation of interface CharStream, where the stream can contain any
binary data.
This class adds a blur to a given shape.
Swing UI editing for RMShadowEffect.
A class to represent Swing borders for JComponentShape.
A subclass for bevel border.
A subclass for empty border.
A subclass for etched border.
A subclass for line border.
A subclass for etched border.
This stroke subclass strokes the rectangular border of a given shape, with option include/exclude individual sides.
This class is like a StringBuffer for bytes instead of chars.
A text shape subclass used to form the basis of a table.
Provides info for a column in a cell table.
This class represents a line that divedes a cell row or cell column.
This shape manages a row of cells.
Manages a table of RMCells, which is really a stack of RMCellRows.
An emboss effect that uses contour fill as its bump map.
Swing UI editing for RMChiselEffect.
Utility methods for Class.
Clipboard utilities.
This class has utility methods to code and decode into various different formats: hex, ASCII85, base 64.
This class has utility methods to code and decode into various different formats: hex, ASCII85, base 64.
This class decodes LZW encoded bytes.
This class represents an RGBA color, just like Java.awt.Color.
This class represents an RGBA color, just like Java.awt.Color.
A multi-stop gradient inspector.
JPanel can be added to the configuration panel of a ScriptableChart to enable users to edit the chart's
configuration script
RMFill implementation of a shape-burst gradient.
Marker interface marking Legacy components inheriting from
AbstractJ2DShape which have now been replaced by
AbstractRM2DShape.Manages a table of RMCells, which is really a stack of RMCellRows.
This class represents a groupable data matrix (or crosstab).
A tool to set formatting options on a simple table from a list of templates.
A text shape subclass used to form the basis of a table.
Provides Swing UI editing for RMCell shapes.
Provides info for a column in a crosstab.
This class represents a line that divides a cell column.
This class represents a line that divides a cell row or cell column.
Provides ReportMill UI editing for CellDivider shape.
This class wraps a shape around a crosstab to constrain the crosstab's bounds to a region on the page.
Provides UI inspector for crosstab frame.
This shape manages a row of cells.
This class represents a line that divides a cell row.
This class provides support for UI editing of RMCrossTab.
A class for reading file of comma separated values, or really any separated values.
This class creates an approximating polygon for a given RMFunction.
A function whose value is the inverse of another function ie.
A function whose value is determined by interpolating through a set of sample points using Neville's Method.
A function scaled such that f(1) == 1
This class is like a StringBuffer for bytes instead of chars.
This class helps read encoded basic data types, from a raw byte stream.
This class is used as a proxy for objects passed to document's generateReport() method.
This class is used as a proxy for objects passed to document's generateReport() method.
This datasource provides data in the form of a search result from Google Search.
This class provides a datasource representing a JDBC database fetch.
This class is used as a proxy for objects passed to document's generateReport() method.
This is just a SimpleDateFormat subclass to support RM archiving and legacy formats.
This is just a SimpleDateFormat subclass to support RM archiving and legacy formats.
Token literal values and constants.
Token Manager.
Utility methods for Java Date.
The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can be a real part of
the document/shape hierarchy.
The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can be a real part of
the document/shape hierarchy.
An interface to define objects that want to get document notifications.
This class provides UI for configuring an RMDocument.
An inner class to render Page control.
Strokes a path with 2 lines of different widths, with an arbitrary separation (d) between them.
Swing UI editing for RMDoubleStroke.
This class subclasses RMViewer to support RMDocument editing.
This class subclasses RMViewer to support RMDocument editing.
Handles editor methods specific to clipboard operations (cut, copy paste).
Handles editor methods specific to clipboard operations (cut, copy paste).
Handles editor methods specific to event operations.
Handles editor methods specific to event operations.
This class is a container for an RMEditor in an enclosing scroll pane with tool bars for editing.
Menu bar for RMEditor pane.
Tool bar for RMEditorPane.
Some utility methods for RMEditorPane.
This class offers some methods to provide "proximity guides" for RMEditor.
This class offers some methods to provide "proximity guides" for RMEditor.
Handles editor methods specific to rulers.
Handles editor methods specific to rulers.
The root shape for RMEditor.
A Java2D painter subclass for editor.
A Shape painter subclass for painting shapes in an editor.
Handles editor methods specific to clipboard operations (cut, copy paste).
Handles editor methods specific to clipboard operations (cut, copy paste).
A text editor subclass suitable for editing RMText shapes in the RMEditor.
A text editor subclass suitable for editing RMText shapes in the RMEditor.
This class contains all of the methods to display and handle RMEditor UI methods.
A Viewport for painting foreground.
An RMFill subclass for drawing effects that rely on shape's standard fill/stroke.
A PDF helper/writer class for RMEffect.
Provides a tool for editing RMFills.
Renders a given shape with an emboss effect.
Inspector for RMEmbossEffect.
This class represents an entity for an RMDataSource.
Utilities for enums.
This class is used to generate an Excel file from an RMDocument.
This class is used to generate an Excel file from an RMDocument.
This class is used to generate an Excel file from an RMDocument.
A simple subclass of RuntimeException that RM uses to indicate errors that don't always really need to be declared or
caught.
A simple subclass of Error that RM uses to indicate errors thrown by RM.
This file is just meant to hold various utility methods that customers have asked for.
This file is just meant to hold various utility methods that customers have asked for.
Movie category constant type.
A movie class.
A movie role class.
A movie class.
FileChooser utilities.
A JFileChooser subclass that gets (and saves) its size to preferences.
Utility methods for file.
This class represents a simple shape fill, drawing a given color in a provided path.
This class represents a simple shape fill, drawing a given color in a provided path.
This RMObjectPdfr subclass writes PDF for RMFill.
Provides a tool for editing RMFills.
This class write an RM document to a flash bufer.
This class is like a StringBuffer, except its for writing binary bit data instead of strings,
including signed and unsigned bit values, but, more importantly Flash file format primitives (Tags,
Rects, Colors, Matrices, records, etc.).
A flash shape subclass for buttons.
This flash shape subclass is for shapes that change size or color.
This class is responsible for writing simple RMShapes to a flash buffer.
A flash shape for rm sound shapes.
A flash shape for shapes with their own animator/timeline (like Switch shapes).
This class writes an RMText shape to flash.
A shape to layout children with flow.
Tool for RMFlowShape.
This class represents a font for use in rich text.
This class represents a font for use in rich text.
This class represents all the information about a font that is independent of size.
This class represents all the information about a font that is independent of size.
Provides some utility methods for Fonts.
An interface for RM format classes (they all should get/set format strings, format objects and archive XML).
An interface for RM format classes (they all should get/set format strings, format objects and archive XML).
This class represents a fill that draws a linear gradient between an arbitrary list of colors.
This class represents a fill that draws a gradient of colors from the basic fill color to the end color.
Simple static class to represent a stop (they're immutable).
Swing UI editing for RMGradientFill.
The RMGraph class provides a template and the machinery for generating graphs.
The RMGraph class provides a template and the machinery for generating graphs.
An inner class for bar labels.
Returns the part rect.
An inner class for Legend.
This class generates (and represents) a RPG'd bar graph content.
An interface for a shape that renders a bar graph from bar graph pieces.
A simple implementation of the BarGraphView interface.
This class renders a bar graph in 3D.
This class represents the actual graph content (a place holder really).
Class creates ReportMill shapes and adds these shapes to a root node.
Returns a list of graph intervals given a range and count.
An inner class for Legend.
Provides UI editing for RMGraphLegend.
This shape is used by graph area to hold attributes of bars.
Provides UI inspection for GraphPartBars.
This shape is used by graph area to hold attributes of the value axis.
Provides UI editing for graph part label axis.
This shape is used by graph area to hold attributes of pies.
Provides UI inspection for GraphPartBars.
This shape is used by graph area to hold attributes of the value axis.
Provides UI editing for graph part series.
This shape is used by graph area to hold attributes of the value axis.
Provides UI editing for graph part value axis
This class generates (and represents) a RPG'd pie graph content.
An interface for a shape that renders a bar graph from bar graph pieces.
A simple implementation of the BarGraphView interface.
This graph renders a pie graph in 3D.
A shape class for a generated RMGraph.
This class represents a report generated graph.
An interface to identify generated graph shapes.
This class generates (and represents) a RPG'd bar graph area.
An interface for a shape that renders a bar graph from bar graph pieces.
A BarGraphShape implementation.
This class generates (and represents) a RPG'd line graph area.
This class generates (and represents) a RPG'd pie graph area.
An interface for a shape that renders a bar graph from bar graph pieces.
Represents the data in the sections of a merged or separated graph.
A class to represent a graph series, contains a list of series items.
A class to represent an individual item inside a graph series, including its key, group, value and bar/wedge
shape.
This class provides RMEditor inspector support for RMGraph.
This class is a smart List subclass used to hold objects from an original list broken down by grouping keys.
This class is a smart List subclass used to hold objects from an original list broken down by grouping keys.
This RMGroup subclass/inner-class represents a subset of a group up to the given endGroup.
This RMGroup subclass/inner-class represents a subset of a group up to the given endGroup.
This class simply manages a list of groupings and has some nice convenience methods.
This class simply manages a list of groupings and has some nice convenience methods.
This object represents an individual grouping with attributes like key, sorts, topN sort, etc.
This object represents an individual grouping with attributes like key, sorts, topN sort, etc.
This class encapsulates simple hit information of a given curve or line against another curve or line.
This class encapsulates simple hit information of a given curve or line against another curve or line.
Generates an HTML file.
Makes a path string from an AWT Path.
This class provides methods to create an xstring from HTML and RTF.
This class provides some utility methods for generating HTML suitable for wrapping other file types.
This class generates HTML for a ReportMill RMDocument object.
Some useful Icon utilities and subclasses.
An icon implementation that renders a border on another icon.
An icon implementation that draws two icons.
An icon implementation that draws two icons.
An icon implementation that uses a JLabel.
A simple icon implementation to draw a given shape in a given color in a given size.
An icon implementation that renders a border on another icon.
An icon implementation that stretches another icon to specified with.
This class is a shape representation of an image.
This class manages image data.
This class manages image data.
An interface for classes that can handle image reading for RMImageData.
An interface for classes that can handle image reading for RMImageData.
The preferred method for seeding RMImageData with an image source.
A effect based on image filtering.
A kernel class for box filters (really?).
A kernel class for cone effects.
Extends Kernel with constructor which takes Kernel size and automatically generates a gaussian matrix.
This class is used to fill a shape's path with an image.
This class is used to fill a shape's path with an image.
This RMFillPdfr subclass writes PDF for RMImageFill.
UI editing for RMImageFill.
Uses ImageIO or JAI to read an image, its basic info and its decoded bytes.
This class is a shape representation of an image.
PDF writer for RMImageShape.
Provides Swing UI for RMImage shape editing.
This class provides functionality to interpolate between two numbers given a ratio between 0-1.
Parameterizable bounce interpolator class.
An Interpolator subclass that can be used for periodic (ie looping) motion.
This class represent a method call and is used to set values on another object, either by calling a "setFoo()"
method or by directly setting the value of a public instance variable.
This class represent a method call and is used to set values on another object, either by calling a "setFoo()"
method or by directly setting the value of a public instance variable.
Implemented by any class that can interpolate themselves for animation purposes.
An archiver to read/write objects from/to JSON.
An interface so objects can provide archival class to archiver.
An interface so objects can provide archival attributes to archiver.
An interface so objects can provide archival values to archiver.
An interface so objects can set archival values from archiver.
Represents a node in a JSON tree.
A JSONTokener takes a source string and extracts characters and tokens from it to create RMJSONNode(s).
The RMJSONException is thrown by the JSON.org classes when things are amiss.
Writes a JSON to string.
This class provides an optimized convenience for getting named values from arbitrary objects.
This class provides an optimized convenience for getting named values from arbitrary objects.
This is interface is implemented by objects that can get key values themselves.
This is interface is implemented by objects that can get/set key value themselves.
KeyAccessor - enclosed class for actually getting/setting values for a given object (class) and key.
NoSetMethodException.
This interface is implemented by objects that want to handle getting key values themselves.
This interface is implemented by objects that want to handle getting keychain values themselves.
This class evaluates a string expression on a given object: RMKeyChain.getValue(object, expression).
This class provides the powerful RMKeyChain.valueForKeyChain() functiionality.
This is interface is implemented by objects that can get key chain values themselves.
A class to evaluate keys on lists.
This class represents an RM function call (method plus args) and defines a bunch of built-in functions.
This class holds all of RM's built-in key chain functions.
Token literal values and constants.
Token Manager.
An animation object that holds an object key/value for a given time.
A list implementation that tries to get objects from aKey+"Size" or aKey+"Count" and aKey(index), eg.,
getThingCount(), getThing(index).
An exception class which is thrown when creating a new key-list with invalid object key.
This class provides methods to set values (using RMKey) over time using an interpolator.
A class representing an individual change to be animated by this timer.
An animation class that represents a key/value pair in a key frame.
An animation object that keeps track of Key-Values at Key Frame times for a target/key pair.
This class represents an individual label inside an RMLabels template.
This class represents an individual label inside an RMLabels template.
This class represents a block of labels.
This class represents a block of labels.
A tool for UI editing of labels shape.
This class models a simple line, providing methods for extracting points, distance calculation, bisection,
hit detection and such.
This class models a simple line, providing methods for extracting points, distance calculation, bisection,
hit detection and such.
This class represents a simple line shape, drawing a line from a start point to an end point.
This class represents a simple line shape, drawing a line from a start point to an end point.
A line segment arrow head.
This class handles creation of lines.
This class is a shape used to render text that didn't fit in a referenced text shape.
This class is a shape used to render text that didn't fit in a referenced text shape.
A class that holds a list of instances for given class.
Utility methods for use with Java.util.List.
Utility methods for use with Java.util.List.
This class provides a simple abstraction for logging messages.
A logger to combine multiple other loggers.
A logger that does nothing.
A logger that wraps around a print stream.
A class to read lines from a given input stream in a separate thread and print them.
Utility methods for use with Java.util.Map.
Utility methods for use with Java.util.Map.
Utility methods for common math operations.
Utility methods for common math operations.
A class used to specify an arbitrary mathematical function.
Utility methods for method reflection.
An RMShape subclass to support morphing from one shape to another.
A morphing shape is a shape which geometry is constructed from two
other shapes: a start shape and an end shape.
Provides Swing UI editing for RMMorphShape.
An implementation of the java.awt.Paint interface for RMGradientFills.
Multiple stop angle gradient with angles.
A multiple stop diamond gradient.
Multiple stop radial gradient.
This class represents a shape for a document inside a page of another document.
This class represents a shape for a document inside a page of another document.
This class is responsible for UI editing of nested document shape.
This subclass extends DecimalFormat to implement ReportMill's RMFormat interface and to support the extended features
"Negative in Red" and "Null String".
This subclass extends DecimalFormat to implement ReportMill's RMFormat interface and to support the extended features
"Negative in Red" and "Null String".
This class forms the basis of many objects to add global functionality, like archiving.
This class forms the basis of many objects to add global functionality, like archiving.
This class and its subclasses write PDF for their corresponding base class.
This class represents a simple oval, with a setable start angle and sweep angle.
This class represents a simple oval, with a setable start angle and sweep angle.
A tool subclass for editing RMOval.
The RMPage class represents an individual page in an RMDocument.
The RMPage class represents an individual page in an RMDocument.
This class represents a page layer, a standard feature of page layout applications that lets you manage the children
of a page as separate groups, so that some can be made unselectable or invisible to ease template editing.
This class represents a page layer, a standard feature of page layout applications that lets you
manage the children of a page as separate groups, so that some can be made unselectable or invisible
to ease template editing.
This RMShapePdfr subclass writes PDF for RMPage.
This class provides UI editing for RMPage shapes.
An object to process painter shape operations.
A path construction operation for painting a bezier curve.
An op class for moving a shape forward along the path of its current roll.
An op class for moving a shape forward along the path of its current roll.
A path construction operation for painting a line.
An inner class for path move to.
A class representing an operation to an painter shape, like MoveTo or LineTo.
An inner class for path construction operations.
A path construction operation for painting a quadratic curve.
An operation to set paint color.
An operation to set painting speed.
An operation to set stroke width.
An op class for turning a shape by a given number of degrees.
A base class for painting RMShapes.
A shape that references another shape and acts.
This class represents attributes of a paragraph in an RMXString (all of the characters up to and including each
newline in an RMXString make up a paragraph).
This class represents attributes of a paragraph in an RMXString (all of the characters up to and including each
newline in an RMXString make up a paragraph).
A shape implementation that can have children.
A tool class for RMParentShape.
RMPath - A graphics path (moveTo, lineTo, etc.).
RMPath - A graphics path (moveTo, lineTo, etc.).
This class represents a path in 3D space.
This class represents a path in 3D space.
Helper methods for the RMPath3D class.
Helper methods for the RMPath3D class.
Bezier curve fitting code adapted from "An Algorithm for Automatically Fitting Digitized Curves", by Philip J.
An implementation of path iterator for RMPath.
An implementation of path iterator for RMPath.
Offset path - a path that follows the curvature of the input path but is located a constant distance away from the
curve.
Offset path - a path that follows the curvature of the input path but is
located a constant distance away from the curve.
Some utility methods for RMPaths.
Some utility methods for RMPaths.
Provides info for an encapsulated PDF (a PDF used as an image).
Provides info for an ecapsulated PDF (a PDF used as an image).
A test program for the parser.
PDF Writer.
Filename: RMPencilShape
Author: Perry Arellano-Jones
Created on: 6/11/15
Project: ignition_dev_7_8B
Filename: RMPencilShapeTool Author: Perry Arellano-Jones Created on: 6/11/15 Project: ignition_dev_7_8B
This shape is used as the pie chart component for the reporting module.
UI for customizing the reporting pie chart shape.
This class extends Point2D.Float to add a few convenience methods.
This class extends Point2D.Float to add a few convenience methods.
This class represents a 3D point.
This class represents a 3D point.
This class is an RMShape subclass that encapsulates an arbitrary path.
This class is an RMShape subclass that encapsulates an arbitrary path.
This class manages creation and editing of polygon shapes.
This class offers a number of useful general purpose utilities used by ribs classes.
A Preferences implementation that just stores prefs to a map, in case we don't have permission
to read & write permissions.
This class describes an attribute of an entity.
An (Indexed) PropertyChangeEvent subclass to describe shape property changes.
An interface for objects that let others listen in to property changes.
Utilities for property changes.
This class models a simple quadratic curve, providing methods for extracting points, distance calculation, bisection,
hit detection and such.
This class models a simple quadratic curve, providing methods for extracting points, distance calculation, bisection,
hit detection and such.
UI for customizing the reporting pie chart shape.
RadialAxis Picker.
Radial Gradient Fill.
This class represents a simple integer range (from start to end).
This class maintains the list of the recently used files.
This class extends Rectanlge2D to add some convenient rect methods.
This class extends Rectanlge2D to add some convenient rect methods.
This class represents a simple rectangle shape with a rouding radius.
This class represents a simple rectangle shape with a rounding radius.
This class handles editing of rectangle shapes.
This class adds a reflection to a given shape.
Swing UI editing for RMReflectionEffect.
A utility class for converting an integer into roman numerals.
This RMEditor subclass has editor functionality specific to ReportMill: - Generates report as a part of previewing -
Draws XML icon in viewport
Parses rtf data from a string and returns it as an xstring.
Write RTF for a document.
This class manages a list of children and transforms them to 3D representations for display based on X and Y axis
rotations.
This class manages a list of children and transforms them to 3D representations for display based on X and Y axis
rotations.
RMPolygon subclass that encapsulates a Path3D.
RMPolygon subclass that encapsulates a Path3D.
Tool for visual editing RMScene3D.
This class describes the structure of a datasource by managing a list of RMEntity.
This class makes a schema from an object graph, given a top level object.
This class handles mouse selection and manipulation of shapes, including: - Click on a shape selects a shape - Double
click on a shape super-selects a shape - Drag a rect selects shapes - Shift click or shift drag XORs selection -
Click and drag handle resizes shape
This class adds a shadow to a given shape.
UI editing for RMShadowEffect.
Implements a simple control to edit shadow position.
This class adds a shadow to a given shape.
Extends Kernel with constructor which takes Kernel size and automatically generates a gaussian matrix.
This class is the basis for all graphic elements in a ReportMill document.
This class is the basis for all graphic elements in a ReportMill document.
This class holds animation record information for an RMShape.
An inner class to represent a time/value snapshot for an attribute.
A class to listen for Swing events and send them on.
An icon to paint a shape.
A class to produce an image for an RMShape.
Handles code for laying out shape children with springs and struts.
The RMShapeMouseEvent is a subclass of MouseEvent which is sent to an RMShape's mouse listeners.
A listener for shape mouse events.
An adapter class for RMShapeMouseListener.
This class manages the painting of shapes to a Java2D graphics object.
This class is responsible for rendering all the base shapes with AWT and Java2D.
An interface for shapes that want to define their own drawing.
This class manages the painting of shapes to a Java2D graphics object.
This RMObjectPdfr subclass writes PDF for RMShape.
A class to hold a shape roll, scale and skew.
Shapes can implement this and the selfInit() function will be called once when the shape is first created in the
designer.
This class creates a table from a given list of shapes.
Defines a region of coordinates along with a list of shapes that occupy that region.
A class to represent an interval
A class to represent a list of spans.
A class for cells.
A class for columns.
A class for rows.
Some shape utility methods.
A Timer subclass.
An inner class to hold less-common attributes.
This class represents a simple geometric size (width, height).
This class represents a simple geometric size (width, height).
This class provides a basic description for comparison and sorting with a simple key and order (ascending or
descending).
This class provides a basic description for comparison and sorting with a simple key and order (ascending or
descending).
Provides UI for configuring a grouping for a tool.
An interface for SortPanelOwner
This class represents a sound in a document.
Manages sound data from sound file bytes.
This class represents a sound in a document.
A listener interface that can be implemented by anyone that cares.
Provides UI editing for RMSound shapes.
This class provides provides generic spell check API ideal for RM's needs.
This class provides provides generic spell check API ideal for RM's needs.
An innder class to represent a misspelled word.
This shape subclass is like a JSplitPane for shapes.
Handles code for laying out shape children with springs and struts.
A parent shape that does child layout with RMSpringLayout.
Tool for RMSpringShape.
Utility methods for ResultSet.
SQL Utility methods.
An n pointed star.
Tool for start shape.
A string tokenizer that can provide token location.
This class is a collection of convenient static String utils.
This class is used to write a String representation of an RMDocument.
This class is used to write a String representation of an RMDocument.
An RMFill subclass specifically designed to describe strokes.
An RMFill subclass specifically desgined to describe strokes.
UI editing for RMStroke.
A shape to reference another template.
A tool implementation for RMSubreport.
This class represents a sophisticated shape that can maintain multiple versions of itself.
This class represents a sophisticated shape that can maintain multiple versions of itself.
Tool for Swing shape.
This RMShape subclass provides functionality to graphically represent a list of data in a ReportMill report.
This RMShape subclass provides functionality to graphically represent a list of data in a ReportMill report.
This class manages a hierarchy of tables so that multiple tables can be configured to display in the same area
of a given page.
This class manages a heirarchy of tables so that multiple tables can be configured to display in the same area
of a given page.
This class handles UI editing of table groups.
This Hashtable subclass provides page number information for table rows in a generated report for the purpose of
generating a table of contents.
This Hashtable subclass provides page number information for table rows in a generated report for the purpose of
generating a table of contents.
An inner class to assist flattening.
An inner class to assist flattening.
This class models a table row in a table.
This class models a table row in a table.
This class represents a text cell in a table header.
A shape layout implementation that handles layout of structured table rows.
Report generation shape for RMTableRow.
This class represents a filled table row and has all the code to rpg clone a table row.
This class provides Swing UI editing for table rows.
Performs RPG for a table.
This class is a basic implementation of Table RPG.
This class is a subclass of the basic implementation of Table RPG.
This class provides Swing UI editing for Tables.
Deprecated.
This class is an RMShape subclass for handling rich text.
A text editor subclass for editing text in a Swing component.
This class provides all of the event and drawing code necessary to edit text in the form of an RMXString
(separated from an actual UI Component).
This class provides all of the event and drawing code necessary to edit text in the form of an RMXString
(separated from an actual UI Component).
Listener class so other objects can track changes to text editor.
A text editor subclass for editing text in a Swing component.
Text editor utils.
Transferable implementation for text editor and xstrings.
This class represents a group of characters in a text line that all share the same text attributes and are
simply spaced apart by their char widths.
A class to layout text.
This class lays out characters in an RMXString inside a bounding rect.
Performs text layout in a path.
A class to represent a line of text in a layout.
This class represents a line of characters in a text layout.
A simple text pane.
Represents a run of characters in a line.
A class to represent a selection of text.
This class is an RMShape subclass for handling rich text.
This class generates PDF for an RMText.
This class provides Swing UI editing for text shapes.
Utility methods for some esoteric text functionality.
A class to hold style attributes for a text run.
Text constants.
Some utility methods for text processing.
An animation object that holds a list of key frames.
This is the base class for tools in RM - the objects that provide GUI editing for RM shapes.
An inner class describing a shape and a handle.
This is a sort subclass to support sorting objects by their relative position in an array of values.
This class implements the trackball widget.
This class implements the trackball widget.
This class represents a simple 2D transform.
This class represents a simple 2D transform.
This class represents a 3D transform.
This class represents a 3D transform.
An animation class that represents a change of an object property from one value to another.
A transition for rotation.
A transition for XY.
Common types.
RMUndoer - this object manages undo by keeping lists of property changes.
RMUndoer - this object manages undo by keeping copies of changed objects.
This class reprents a distinct "undoable event".
An interface for undo/redo selection.
This class represents a single undo but holds a list of PropertyChangeEvents.
Utilities for URL.
This class provides a bunch of utility methods for common problems.
This class provides a bunch of utility methods for common problems.
This is a sort subclass to support sorting objects by their relative position in an array of values.
This class represents a 2D vector.
This class represents a 2D vector.
This class represents a 3D vector.
This class represents a 3D vector.
The RMViewer class is a JComponent subclass that can be used in Swing applications to display and/or print an
RMDocument.
The RMViewer class is a JComponent subclass that can be used in Swing applications to display and/or print an
RMDocument.
A phantom component that resides in the viewer, that Swing JComponentShapes can attach to, to draw.
Swing UI controls for RMViewerPane bottom.
A viewer input adapter to perform selection of a rectangle and copy as image.
A transferable for copy.
This class handles functionality related to mouse and keyboard input on a viewer, so that different behavior can
easily be swapped in beyond the standard interactive behavior, like text selection or area-selection.
A class to manage an RMViewer and .rpt file.
A RibsHelper implementation for RMShape.
A RibsHelper implementation for JComponentShape.
This class is a container for a viewer and tool bars.
A shape to act as root of shape to be viewed.
A viewer input adapter to perform text selection and copy (as RTF and CSV).
A transferable for copy.
Swing UI controls for RMViewerPlus top.
This class abstracts an object (or object graph) into core Java types (Map, List, String Number, Boolean, Date
and byte[]) via Java reflection/introspection.
This class creates an object graph of collections (Map/List) and core Java types from a given XML source.
This class tries to load an XML file as a plist.
This class turns any Java dataset into XML.
This is just a stub class so that developers can reach XML dataset archival from it's old location
in this package.
This class turns any Java dataset into XML.
An RMXString is like a String that lets you apply attributes, like fonts and colors, to character ranges.
An RMXString is like a String that lets you apply attributes, like fonts and colors, to character ranges.
The Outline inner class represents the attributes of outlined text: strokeWidth and fillColor.
The Outline inner class represents the attributes of outlined text: strokeWidth and fillColor.
The Run class represents a range of characters in an xstring that share common attributes.
The Run class represents a range of characters in an xstring that share common attributes.
This class provides a method to perform @key@ substitution on an xstring.
Config UI for the reporting module's xy chart.
A role is a permission that can be assigned to a user.
Validated text field that uses intelli hints list for entering user roles into textfield
The RootBrowsePublisher class is responsible for publishing browsing results
starting from a specified root path.
This is available to the user as the saveContext variable passed in on certain extension functions.
Filename: RosterManagementPanelTermFinder.java
Created on Jan 02, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: AlarmNotification
Indicates a paint that needs to be rotated when a shape is rotated.
RoundRectangle2d only gained eq and hash in java 1.6, so we backport them here.
A bundle of routes mounted underneath /data/group-name/*
A "list" route is a route that returns a list of items.
Handler that is associated with a mounted route.
Contextual information for a Route to be mounted
Exception thrown during route mounting if validation of the properties of the route-to-be-mounted fails
Used as the "context object" for push operations that originate from resource CRUD routes.
These are the Perspective routes that are used for the Perspective application itself.
Represents a data bearing object from a WebSite.
This class is used for rendering a jtable that is meant as the row header view on a JScrollPane for row headers on a
table.
This object represents a relation between a source row and a destination row or rows.
Metadata for a given RPC call, identifying the target function to be invoked.
Container for meta-information on an incoming RPC request.
To optimize transmission of across rpc, this class passes a subset of info from DatasourceMeta.
This class is a utility for creating an
RpcRouter from object(s) that implement an RPC interface.Annotate a particular method on your RPC implementation with
RequiredMutabilityMode to indicate
that the client must have at least the given MutabilityMode, or the call will be rejected.Annotate a particular method on your RPC implementation with
RunsOnBackup to allow it to be
invoked on a backup node.Annotate a particular method or your entire RPC implementation with
RunsOnClient to allow it to be
invoked by a client.Common wrapper for an exception that is thrown during an RPC call.
Core interface representing the handling of an RPC call.
Marks an interface as an RPC interface.
An RpcMessage is always either an actual value, or an error thrown on the gateway; nothing more and nothing less.
An RpcMessage is always either an actual value, or an error thrown on the gateway; nothing more and nothing less.
Handles the indirection between an RpcCall (already guaranteed to be arriving at a given module) and a particular
handler, as identified by
RpcCall.packageId() and RpcCall.function().Marker meta-interface combining
GatewayRpcSerializer and ClientRpcSerializer.This class offers a number of useful general purpose utilities used by ribs classes.
A class to help manage and archive borders.
Provides some Ribs utility methods for Fonts.
This stub font class is responsible for returning the appropriate font reference by a rib font tag.
Component that draws the ruler for the DesignPanel.
This class offers a number of useful List utilities used by ribs classes.
Author: Perry Arellano-Jones
Year: 2014
Filename: RunScriptAction
Author: Perry Arellano-Jones
Created on: 6/8/15
Project: Reporting 3.0
Filename: RunScriptActionConfig
Author: Perry Arellano-Jones
Created on: 6/8/15
Project: Reporting 3.0
This is a special type of property that indicates that we want the current runtime value of a parameter
as opposed to the config value.
A resource collection that holds an inheritance hierarchy of collections and can be easily kept up-to-date using
diffs.
An EffectiveSnapshot is a
Snapshot of a Resource Collection and its effective resource set plus
additional information about what its hierarchy was at the time the snapshot was made.These are properties of tags that only exist at runtime.
This class offers a number of useful String utilities used by ribs classes.
This class offers a number of useful general purpose utilities used by ribs classes.
This class manages archival and unarchival to/from RXElements.
This class manages archival and unarchival to/from RXElements.
This inner class represents a named resource associated with an archiver.
This inner class represents a named resource associated with an archiver.
The
RXAttribute class represents an XML attribute by simply having a name and value.The
RXAttribute class represents an XML attribtue by simply having a name and value.The
RXElement class represents an XML element and simply manages a list of XML elements
(recursively) and a list of attributes.The
RXElement class represents an XML element and simply manages a list of XML elements
(recursively) and a list of attributes.A class to load an RXElement from aSource using SAX.
A FileOutputStream that implements a two-stage write process, and additionaly copies any existing file to a backup
location.
Default java deserialization is dangerous with untrusted payloads.
Safely deals with increments / decrements of a
JSlider in a way that will not allow for the value of the slider to go out
of bounds.This class holds the logic need to determine if sample data needs to be loaded or re-loaded based upon changes
to the data configuration.
This is a specialization of the RMDataSource class that understands the Map structures that we feed our reports.
Type 0 sampled functions.
Deprecated.
Protobuf type
AnnotationPBDeprecated.
Deprecated.
Deprecated.
Protobuf type
SampleSetPBDeprecated.
Deprecated.
Protobuf type
TagPBDeprecated.
Deprecated.
Protobuf type
TagValuesPBDeprecated.
Deprecated.
Deprecated.
Deprecated.
Protobuf type
ValuePBDeprecated.
This manages time based storage throttling.
A WebSite subclass to manage files in ~/Library/SnapSandboxes.
Modal dialog box that presents a checkbox-tree of all modified, added, or deleted resources to the user so they
can pick what to push (a.k.a.
Contains the user's choices from the save dialog box, such as which changes to push, and whether or not to
update and resolve conflicts before pushing.
Filename: SaveFileActionConfig.java
Created on Feb 05, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: SaveFileActionPanel.java
Created on Feb 04, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: SaveFileReportAction.java
Created on Feb 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Concrete implementation of ISelectionControls that provides the standard stretch/resize handles around a component
selection
since 8.0
Defines the properties of a scan class.
Represents a scan class, and is easily serializable for messaging
Deprecated.
Represents the run stats for a given scan class instance.
Tool for editing RMScene3D in Swing.
An inner class to provide inspector manipulation of a Scene3D's 3D orientation.
com.inductiveautomation.ignition.common.user.schedule.ScheduleAdjustment
com.inductiveautomation.ignition.common.user.schedule.ScheduleAdjustment
Filename: ScheduledParametersPanel.java
Created on Mar 10, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Represents a tab for editing scheduled script configurations in a resource editor.
The extension point for creating schedules.
Filename: ScheduleManagementPanelTermFinder.java
Created on Jan 02, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
Created by carl.gould on 2/3/2015.
Filename: ScheduleParameter.java
Created on Mar 13, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Scheduling interface useful for unit testing.
Deprecated.
A customized version of the PMIWeekView that shows user schedules
Used by self scheduling runnables to request a re-evaluation of their scheduling.
This class describes the structure of a data source by managing a list of entities.
SchemaFeature is used to ensure that the internal database has particular attributes ("features").
The SchemaUpdate is used by modules to manage the state of the internal database.
A utility class for creating JSON schemas in
JsonObject form.A builder for creating JSON schemas.
A number format that will switch between a "small" and "large" format depending on the magnitude of the value.
Created by colby.clegg on 2/2/2015.
The ScopeLocator system provides an extensible mechanism for module authors to provide new scopes, or locate virtual
scopes.
Facilitates the creation of a scope-specific hash of a specific combination of modules and their versions.
Created by colby.clegg on 10/23/2014.
Created by colby.clegg on 10/23/2014.
A chart that can be customized and controlled through scripting at runtime
Action which runs a python script when an event occurs.
Annotates an argument of a function being added to the scripting system.
Used to mark public methods on a
ComponentModelDelegate that should be accessible to users in the script
system.This class is simply a storage class for the serialization of various script configuration things.
Configuration resource for message handler scripts.
Configuration resource for shutdown scripts.
Configuration resource for startup scripts.
Configuration resource for tag change scripts.
Configuration resource for timer scripts.
Cursor for iterating over a list of search objects pertaining to event scripts search objects
The ScriptContext class is used to provide implicit values to scripts, based on the context of the call.
Created by carl.gould on 3/3/2015.
This interface represents a compiled scripting function that can be executed multiple times.
Entrypoint to the autocomplete system for scripting functions.
Helper to consolidate the logic of an extension-function style script that must be compiled the first time before
it runs.
Protobuf type
ignition.script.DatasetProtobuf type
ignition.script.DatasetProtobuf type
ignition.script.Dataset.ColumnProtobuf type
ignition.script.Dataset.ColumnDeprecated.
This is the older shared library concept of
app.* user scripts;
prefer the modern ModuleLibrary alternative.The serialization format that will be used for script messages going between the client/designer and the gateway via
RPC.
Handles script messages that arrive from push notifications.
A Python scripting module
Listens for the push message when the user has altered the contents of pylib
Tracks default 3rd party Python modules in user-lib/pylib.
Class used by the ScriptManager to act as a namespace that can hold either more packages or executable
modules/functions
Created by carl.gould on 3/3/2015.
This special implementation of SearchProvider collects together sub-providers and displays them as selectable
categories.
This is just a JPanel that implements Scrollable, and has getters/setters for the things that scrollable implements.
This class provides simple bulk data loading facilities which are particularly handy for developing test data.
A DataSet contains records of various types together with their meta data.
This is the internal generic database driver that contains database dependent
code.
Contains DB2/400 (iSeries DB2/Implementation tested on OS400 v5.1)
Contains DB2/400 (iSeries DB2/Implementation tested on OS400 v5.1)
Contains Derby/Cloudscape 10.0 implementation
Open source verion of Interbase.
This contains H2 specific code.
This contains HSQL specific code.
Common code between HSQL and H2.
This contains Informix specific code.
Borland's db.
This contains MS SQL Server specific code.
This contains MySQL specific code.
This contains Oracle specific code.
This contains PostgreSQL specific code.
Alix Jermyn
This contains Sybase Adaptive Server specific code.
Used to mark fields inside a BindingConfiguration object that should be used by the search-and-replace system.
A searchable object returned by a search provider.
An implementation of Iterator<SearchObject> that aggregates multiple SearchObjectCursor objects.
A simplified adaptation of iterator that is made to work with a SearchObjectAggregator.
A search request that is to be sent to a gateway search provider.
Defines a coarse unit of searchability.
Passed to the search provider when the user wants to select which objects to search.
Installs SearchableBar into a BorderLayout JPanel
This class holds all of the secondary desktops, which are additional frames which hold their own Vision window
stack.
Helper class which aids in retrieving the current
Plaintext value of a secret without having to be
concerned with the implementation details of embedded vs referenced secrets.Configuration describing a secret.
An Embedded
SecretConfig which encapsulates the ciphertext secret value encrypted using the
SystemEncryptionServiceA
JsonSerializer and JsonDeserializer implementation for JSON-serializing and deserializing
instances of SecretConfig using GsonA Referenced
SecretConfig which encapsulates the name of the SecretProvider and the name of the Secret
within the Secret Provider where the secret value lives.The type of SecretConfig: Embedded or Referenced
An instance of this Exception is thrown if there is a problem getting the plaintext from a
SecretA
SecretProviderException thrown when a secret cannot be foundA
SecretProvider exposed methods for listing, reading, and writing secrets managed by the provider.Immutable config record class which encapsulates the profile properties common to all Secret Provider types.
Encapsulates contextual information for a running
SecretProviderAn instance of this Exception is thrown if there is a problem reading or writing a secret from/to a
SecretProviderAn
ExtensionPoint for defining new types of SecretProvidersAn instance of this Exception is thrown if there is a problem creating a new secret provider through its
SecretProviderTypeThe SecuredEntity annotation can be used on gateway network service objects (services, service methods, intents)
to secure access in a way that plays into the generic security configuration system in the gateway.
This factory provides a list (display order will follow list order) of DescriptiveProperties for security
restrictions/properties that can be set.
This interface can be implement (it is not required) by services and intents that use the SecuredEntity annotation in
order to gain access to some handy helper functions concerning security config.
A client session secured by the security levels set in the project's permissions.
A more secure
WriteHandler since SecureWriteHandler.write(TagPath, Object) delegates to
SecureWriteHandler.write(TagPath, Object, SecurityContext) with a SecurityContext.emptyContext() by default.Encapsulates contextual security information about the current user of the tag system
Base interface is com.inductiveautomation.ignition.common.tags.model.SecurityContext
Base interface is com.inductiveautomation.ignition.common.tags.model.SecurityContext
A SecurityLevelConfig is a node on a security level tree which encapsulates the node's name, its description, and
its children.
Support for Gson serialization and deserialization
A SecurityLevelManager is the source of record for all SecurityLevels configured in the system
Enclosing panel for a SecurityTable that also adds a header and add/delete/refresh buttons.
Table used to choose security zones and roles
Combination of TagPath and SecurityContext.
Protobuf type
common.protobuf.SecurityTagPathListPBProtobuf type
common.protobuf.SecurityTagPathListPB
com.inductiveautomation.ignition.common.tags.model.SecurityTagPath
SecurityTagPath is *not* an implementation of TagPath.
com.inductiveautomation.ignition.common.tags.model.SecurityTagPath
SecurityTagPath is *not* an implementation of TagPath.
Represents a single straight-line segment of an orthogonal path.
A control that mimics OSX's "Segmented Control" which is basically a bunch of toggle buttons that
butt up against
each other.
A focus listener that attempts to select all of the text when a component gets focus.
Displays a component hierarchy dialog for property selection.
Filename: SelectedTagsPanel.java
Created on Aug 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Simple class that implements ItemListener, and then sets the Enabled property of components based on selection.
Event object that will be posted to the editor's event bus when we receive notice through the JS bridge
that the set of selected components has changed.
Event object that will be posted to the editor's event bus when the current selection receives property changes
This tool handles
selecting components via click, marquee, and fence selection
moving components by dragging
This class handles mouse selection and manipulation of shapes, including:
- Click on a shape selects a shape
- Double click on a shape super-selects a shape
- Drag a rect selects shapes
- Shift click or shift drag XORs selection
- Click and drag handle resizes shape
A component implements this class if it wants to come 'pre-configured' with some bindings (to itself) For example, a
component with an integer status could come pre-configured with color bindings to its own status
A checkbox whose text is either "True" or "False"
This only exists because we want to hide the completion functions from the scripting system,
so we break it out to a different interface (MessageResultHandler).
This is the transport object used to communicate results for system.util.sendRequest between the gateway and the
client, and across the gateway network.
Queues up submitted items and executes them in serial on an ExecutorService.
An
SerialExecutionQueue.ExecutionCallback that executes Runnables.Context for serialization used when serializing data with a
PersistentSerializer.Helper class that helps gson serializers make JsonObject instances and avoid serializing null fields where
omitting them would make for a cleaner serialized object.
A custom exception that is thrown when serialization fails.
A service connector is a component that connects the Gateway to an external service.
Listener for state changes in a
ServiceConnector.Base class for all Service Connector extension points.
The service connector manager is responsible for managing service connectors of different types.
A class which implements a cross-platform print dialog.
A simplified http session, managed by a
SessionManager.Represents a node for session event scripts in the navigation tree.
Enum that maps ResourceTypes to their corresponding session script editors.
The nucleus of a Perspective Session.
Factory for creating
SessionKernel instancesBase class for Perspective Sessions which wrap a session kernel.
Session values that implement this interface will be started up and shut down with the session's lifecycle.
Management for basic http sessions.
Created by carlg on 11/23/2016.
Represents the two "scopes" that a perspective webpage can represent - client or designer
Delegates to the actual view, this prevents the scripting system from being able to call everything
on ViewModel, like startup(), shutdown, etc.
This condition does set comparison.
An object to get, set and store site settings.
Displays a modal dialog used to edit the value of key-value pairs.
SimpleORM takes care to trap most error conditions and throw meaningful
exception messages.
Errors in data or environment at runtime, not necessarily a programming
bug.
Probable bug in user's program.
Probable bug in SimpleORM.
Chained JDBC Exception, could be anything as JDBC does not separate
exceptions out and provides minimal information about their underlying
causes.
Exception thrown due to failed unit test cases.
This Exception thrown by user written code to indicate user data entry
errors, especially in the business rule methods.
This is the entry-point to the Gateway scope section of the SFC module's API.
This is the vision component used to monitor an SFC
Created by carl.gould on 6/13/2014.
This is the actual class that is added to the scripting system to implement the SFC functions.
Created by carl.gould on 6/16/2014.
Represents BigDecimal field meta data.
Represents a BLOB, Binary large object.
Booleans are represented as Boolean.TRUE/FALSE internally.
Booleans which are represented by a string.
Represents Bytes field meta data.
Represents Date field meta data.
Represents Double field meta data.
Represents Enum field meta data.
Defines aspects of fields.
Represents Integer field meta data.
Represents Long field meta data.
Each instance defines the meta data for a field in an
SRecordMeta.Represents columns that are not objects known to SimpleORM.
Represents a foreign key reference from one SRecordMeta to another.
Scalar fields such as String, Int, but not References to other tables.
Represents String field meta data.
Represents Time field meta data.
Represents Timestamp field meta data.
Generate keys using rows in a separate sequence table.
Generator using Identity columns which have values added by the database when
rows are inserted.
PDFShadingPattern.
Created by carl.gould on 5/5/2015.
Created by carl.gould on 5/5/2015.
This class provides UI for editing the currently selected shapes stroke, fill, effect, transparency.
This class manages the Swing UI for editing the currently selected shapes fill attributes, like fill color,
stroke color, transparency, etc.
Provides UI inspector for Shape image fills.
Implements a simple control to edit shadow position.
An inspector for general shape attributes, like property keys, name, text wrap around, etc.
An inspector for general shape attributes, like property keys, name, text wrap around, etc.
Handy class that lets you use a Shape as an icon.
This class provides UI editing for the currently selected shapes layout attributes (in parent).
This class provides Swing UI editing for the currently selected shapes location and size.
This class provides Swing GUI editing for the currently selected shapes location and size.
An inner class to provide a simple springs and struts control.
This meta annotation contains the keys used by the palette.
Created by carl.gould on 4/17/2015.
Holds colors, paint modes, and stroke widths - everything needed to paint a shape
This class provides Swing UI editing for the currently selected shapes location and size.
This class provides Swing UI editing for the currently selected shapes location and size.
Use this annotation on a property's getter or setter method to indicate that it is a property that should be
exposed through the report module's property inspector.
This class provides Swing UI editing for advanced transforms such as rotation, scale and skew for the
currently selected shapes.
This class provides Swing UI editing for advanced transforms such as rotation, scale and skew for the
currently selected shapes.
This class offers a command line interface to some of ReportMill's functionality.
This class offers a command line interface to some of ReportMill's functionality.
This class provides information about a path that has been "shelved", such as when it was shelved, and by whom, and
the actual path.
com.inductiveautomation.ignition.common.alarming.evaluation.ShelvedPath
com.inductiveautomation.ignition.common.alarming.evaluation.ShelvedPath
Tab for editing shutdown intercept event scripts.
When objects are uninitialized, it could be due to a normal shutdown, or to something else-
like the item being deleted.
Tab for editing shutdown event scripts.
This is the event object for the route to post to the page's gauva event bus, to get picked up by this delegate.
This is the event object that will be passed to the `onSignatureSubmitted` actions.
A simple username and password pair.
Created by Colby on 8/11/2015.
An implementation of
Binding that hides the complicated method signature required
of that interface.Deprecated.
THIS CLASS IS DEPRECATED.
Deprecated.
THIS CLASS IS DEPRECATED.
A property adapter that hooks up a property to a tag.
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (without unicode processing).
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (without unicode processing).
Simple recursive descent parser for simple arithmetic expressions.
An abstract formatter factory that always returns the same AbstractFormatter
This class helps with "simple" pattern matching.
A simple (and rather inefficient) implementation of a PredicateMap.
Filename: SimpleSqlQueryConfig
Author: Perry Arellano-Jones
Created: 13April2015
Project: Reporting 3.0
Filename: SimpleSqlQueryConfigPanel
Author: Perry Arellano-Jones
Created: 13April2015
SimpleSqlQuerySource provides a SQL Query data source that allows for binding-like paths to be added via {} refs in
SQL queries.
Puts a JTree and a JTable next to each other so that it feels like the JTree is the first column of a resulting
new "table".
This is a simplified wrapper around the legacy PropertyTableModel that is used in the classic chart customizer.
Deprecated.
A wrapper around a delegate TagPath that strips the path of its property, for use with managing subscriptions to
tags.
The simulator historian provider offers simple simulation functions that are guaranteed to be repeatable for a
given source and timeframe.
This is the actual historian query.
Generators are what...
Created by colby.clegg on 11/16/2015.
SingleFiledLayout lays out components singled filed.
A version of project resource listener that only listens for changes to a specific resource, and is suppressible.
A migration strategy for a singleton record which will become singleton resources.
A handler for a singleton resource.
Enum representing the status of a data sink.
The slide-over pane displays one component at full-size, and then allows another component to slide over the top of
that component.
A panel that can be used along with the SlideOverPane, or any popup panel system.
SlidingPane is a panel that acts very much like a CardLayout, as in: one pane displayed at a time.
Very simple logging system.
An implementation of SLog to allow Simpleorm to log via Slf4j.
An
EmailProfile which supports SMTP.Encapsulates an authentication credential used to authenticate the SMTP client against the SMTP server
The connection settings used for establishing a connection to an SMTP server
Deprecated.
This class represents an RGBA color, just like Java.awt.Color.
Represents the data (from a file)
This class represents a font for use in rich text.
This class represents all the information about a font that is independent of size.
Provides some utility methods for Fonts.
A row for SnapSite.
A lightweight immutable "snapshot" of a
ResourceCollection.Represents an entity capable of creating and managing snapshots.
This class provides shared functionality to redundant providers that use RedundantSnapshots to calculate differences
between redundant nodes.
A class to manage resources for a Snap site (a data source subclass).
A DataTable for SnapSite.
A class to represent a dataset generated from a table, a query and query parameters.
A class to evaluate SnapTableView keys.
Miscellaneous Utility methods.
Acts as a bag (kind of like an un-ordered list or a set of like items) whose entries are kept in SoftReferences.
A very simple cache map implementation using soft references around the keys.
Fills the area with a solid fill at some transparency level.
This class provides a basic description for comparison and sorting with a simple key and order (ascending or
descending).
A sorter for TableModels.
A tag path that delegates to another tag path, but alters the source.
A tag path that delegates to another tag path, but alters the source.
Represents a change point for source changes.
Represents the value of a source change.
A binary adapter for serializing and deserializing
SourceChangePoint objects.Source configuration
This condition is basically a standard path condition, but the value is an array of paths.
Runtime exception thrown when attempting to process a point against a
DataNodeSession
with a source path that doesn't match what the node session represents.Connects to
EventStreamSource based on current state of Event Stream.
// Indexes of Data Types
// Unknown placeholder for future expansion.
// Indexes of Data Types
// Unknown placeholder for future expansion.
Protobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValue.DataSetValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValue.DataSetValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.RowProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.RowProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetaDataProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetaDataProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetricProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetricProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetListProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetListProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValue.PropertyValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValue.PropertyValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.TemplateProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.TemplateProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.ParameterProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.ParameterProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.Parameter.ParameterValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.Parameter.ParameterValueExtensionThis class just runs a simple modal panel to register user name and email on first run.
This class just runs a simple modal panel to register user name and email on first run.
For a SplitPane that you want to have the visibility of one of the two components set in the SplitPane to be
toggled between being visible and being not visible, you can use this class to provide that capability.
Deprecated.
A class to layout children using springs/struts settings.
Provides UI editing for shapes with SpringsLayout.
An inner class to provide a simple springs and struts control.
This class is the root of all Rib files.
A helper class for SpringsPane.
JComponentShape subclass for SpringsPane.
Provides inspector for SpringsPaneShape.
This class draws the buttons in the border chooser, plus holds utility methods for choosing borders
A 1.4 file that provides utility methods for creating form- or grid-style layouts with SpringLayout.
A class for running operations in the background.
The SQL Configurator configures an
SQLPropertyAdapter.Created by colby.clegg on 11/12/2015.
Created by colby.clegg on 11/12/2015.
Created by colby.clegg on 11/13/2015.
Created by colby.clegg on 3/15/2016.
Created by colby.clegg on 11/12/2015.
This class provides information and utilities concerning SQLTags, and Complex Types in particular.
com.inductiveautomation.ignition.common.sqltags.model.types.AlertAckMode
com.inductiveautomation.ignition.common.sqltags.model.types.ClampMode
com.inductiveautomation.ignition.common.sqltags.model.types.DataType
Note that there is a gap between 20 and 29.
com.inductiveautomation.ignition.common.sqltags.model.types.DeadbandMode
com.inductiveautomation.ignition.common.sqltags.history.InterpolationMode
com.inductiveautomation.ignition.common.sqltags.model.types.OpcDataMode
com.inductiveautomation.ignition.common.sqltags.history.ReturnFormat
com.inductiveautomation.ignition.common.sqltags.model.types.ScaleMode
com.inductiveautomation.ignition.common.sqltags.model.types.ScanClassComparison
com.inductiveautomation.ignition.common.sqltags.model.types.SQLQueryType
Protobuf type
common.protobuf.SqlTagEnumsPBProtobuf type
common.protobuf.SqlTagEnumsPB
com.inductiveautomation.ignition.common.sqltags.model.types.TimestampSource
Convenience class that can serialize the common sqltag enums
The main Query interface that provides structured queries.
SFOR_UPDATE causes addtional database locking (Typically SELECT ...
DialogPage that wraps an instance of an AbstractPropertyEditorPanel in a JIDE DialogPage, adding a banner on top.
Each SRecordInstance represents an individual record in memory that either correspond to a row in the database or a
new record that has yet to be inserted.
Exception thrown due to broken optimistic locks.
Defines the meta data for a
SRecordInstance such as the table name.Public interface to globaly choose which fields to retrieve
SDESCRIPTIVE : only descriptive fields, typically pkeys and labels
SNORMAL : all fields except those marked SUNQUIERED
SALL : all fields, including SUNQUIERED
SNONE : used for SQuery.join to not add joined columns to Select list.
Used to link to the SSession from SDataSet, and thus record instances etc.
Performs all the interactions between a DataSet and a JDBC Connection.
Listen for this event on the GatewayContext's EventBus to be notified when the Gateway Web Server's TLS Setup
has changed
This class has the logic used by all 3 AD user sources to handle a single-sign-on (SSO) request.
Gathers and displays per session statistics.
Stage represents each unit of work a
StageEvent will pass through.Encapsulates communication between stages.
Diagnostics for an individual stage
Signals an
EventStream has been shut down.Stage has been disabled.
Exception was encountered during creation or startup of Stage.
Stage has successfully been created and is awaiting events.
Stage has been disabled.
Exception was encountered during creation or startup of Stage.
Stage has successfully been created and is awaiting events.
This class exists just for testing and development purposes.
An enumeration representing standard types of change points in the historian system.
Standard implementation of the CollectionContext interface that contains
all the information needed for a data collection operation.
An enumeration representing standard types of complex points in the historian system.
Standard types for data points, mapping to their respective implementations.
Will return paths normalized to [sys:/prov]
Tab for editing startup event scripts
Extends BaseAction by adding support for item events like Toggle buttons and Checkbox menu items.
Deprecated.
Use com.inductiveautomation.ignition.client.util.action.StateChangeAction instead.
The response to a
ResourceAction that does not affect anything outside this resource.StaticDataConfigPanel
Implementation of property tree privacy model that allows for static (hard-coded) configuration.
StaticReportDataObject
StaticReportDataSource
A StatMetric keeps track of various statistics for one metric.
com.inductiveautomation.ignition.common.StatMetric
com.inductiveautomation.ignition.common.StatMetric
Provides status for storage and query capabilities of a historian.
A JLabel that will display a status message with an optional hold time.
A factory that creates editing UIs for SFC chart elements.
This is where you register your
StepConfigFactory in the designer if you're implementing a new type of step.Created by Colby on 12/9/2015.
Base interface for factory that creates objects to represent steps.
This is the control interface for step elements.
StepFactorys are responsible for instantiating StepElements;
the interface encapsulating the execution logic of a an SFC step.A FilterInputStream that updates the launch step's progress automatically
Created by colby.clegg on 3/18/2015.
A Stitching function is a function that contains an array of subfunctions.
Call
StopCellEditTableSupport.stopCellEditing() to stop editing for all child components of JComponent passed in the
constructor StopCellEditTableSupport(JComponent) StopCellEditTableSupport}.The StorageEngine interface defines a contract for storing and applying various types of
points, including atomic points, complex points, and change points, in an underlying storage system.
An enumeration that represents the storage forwarding policy.
Identifies a specific storage destination within an engine.
Deprecated.
since 8.3.0
Represents the result of a storage operation.
Represents a storage operation that resulted in an exception.
Represents a failed storage operation where all data failed to be stored.
Represents a storage operation that resulting in nothing occurring.
Represents a partially failed storage operation where some data were stored
successfully and others failed.
Represents a fully successful storage operation where all data were stored successfully.
com.inductiveautomation.gateway.tags.history.distributed.StorageResult.Result
com.inductiveautomation.historian.distributed.StorageResult
com.inductiveautomation.historian.distributed.StorageResult
Deprecated.
The StoreAndForwardEngine interface provides a common API for store and forward engines.
The main manager interface for handling all store and forward operations.
A class containing constants used in the store and forward logging system.
This is an implementation of Dataset that received data in a streaming manner.
Protobuf type
ignition.rpc.StreamingDatasetPbProtobuf type
ignition.rpc.StreamingDatasetPbProtobuf type
ignition.rpc.StreamingDatasetPb.CellProtobuf type
ignition.rpc.StreamingDatasetPb.CellProtobuf type
ignition.rpc.StreamingDatasetPb.ColumnProtobuf type
ignition.rpc.StreamingDatasetPb.Column
Data is always either a row in the dataset, or an error thrown on the gateway
Data is always either a row in the dataset, or an error thrown on the gateway
Protobuf type
ignition.rpc.StreamingDatasetPb.HandshakeProtobuf type
ignition.rpc.StreamingDatasetPb.HandshakeProtobuf type
ignition.rpc.StreamingDatasetPb.RowProtobuf type
ignition.rpc.StreamingDatasetPb.RowHolds a map of integer ID -> String.
Much like the enum condition, but matches against a list of strings.
Represents a String-typed field in a PersistentRecord.
Like StringBuffer but with double formatting.
A pair of strings.
This parser handles a literal string which contains references.
A simple path based on string based path components.
A case-sensitive subclass of
StringPath.
com.inductiveautomation.ignition.common.StringPath
com.inductiveautomation.ignition.common.StringPath
This class is a collection of convenient static String utils.
This class is a collection of convenient static String utils.
Represents a simple string value, such as "value ".
Fills the area with a solid fill at some transparency level.
The response to a
ResourceAction that does affect other resources, such as when a resource
is deleted, renamed, or otherwise modified in a way that requires other resources to be updated or references to be
checked.Created by pjones on 6/1/17.
Enum that determines the origin of this event.
Simple document listener that performs the consumers operation on any text changes.
Represents a style class's stored configuration.
An editor for Borders
A "style declaration" is a map of style attribute to value.
Class: StyleListener
Small rectangular component that displays a color, and when pressed, shows a popup editor.
Use a table to fake a list so we can more easily support cell editors
Interface that marks a component as one who supports the notion of Styles.
A style variant is one style or animated style, which might serve as the base style for a Style Class or as
a media-query or pseudo-selector variant style.
A SubCache resides under the main cache, and represents the cache for a certain set of parameters.
A SubIndex represents a way to get a sub element from a value.
This expression takes a reference to an array, dataset, collection, or map and subscripts inside it to
pull out a value, like:
{dataset}[0,5]The SubSystemIdentifiers class contains constants for all known subsystems
that store data through the store and forward system.
A basic WriteOperation that is always instantly successful.
An editor that uses a non-editable combo box displaying a list of pre-canned items
A suggestion is intended to be used on an enum whose values are suggestions for a free-form type of field.
Created by Colby on 8/10/2015.
Filename - SumPensDatasource Author: Perry Arellano-Jones Year: 2014
Emits only the Object provided by Supplier
Miscellaneous static utility methods that have nowhere else to live.
Validates that a numeric value is greater than or equal to a given value, normally 0.
This class will consume all the SVG files in a folder, and emit a JSON file representation of all of their paths,
which is the format we ship with Ignition for the client-api's built-in vector icons.
This SVG importer imports the SVG into a single component.
Models the "d" attribute of SVG using objects that understand how to mimic the same path using Path2D.
Parses an svg path using the "d" attribute format.
Modified from the standard color swatch chooser.
This class helps to load and manage panels of UI components in the form of a UI file, which is a simple
XML description of UI controls.
An editor which represents a boolean value.
Swing version of a Border property editor.
Swing version of a Color property editor.
A file class to represent Ribs Swing files.
A PropertyEditor for editing a Dimension object.
A class to manage dragging.
A File Transferable.
Base class of all Swing based property editors.
A property editor for a swing enumerated type.
This class encapsulates information for UI changes, like button clicks, text field entries, list selections, etc..
A timer event.
A class to listen for Swing events and send them on.
Provides fill inspector for JComponentShape Swing shape attributes.
A Font property editor.
A gallery panel for ribs Swing components.
This class provides Ribs functionality for abstract widgets (display objects).
An editor for editing Insets.
Created by Carl.Gould on 11/23/2015.
A property editor which allows for the display and instantaition of arbitrary objects.
A base controller class class that manages a JComponent usually loaded from a rib file.
A PropertyEditor for editing a Point object.
An editor for editing Rectangle.
A runner than invokes success/failure methods in Swing EventDispatch thread.
A property editor for editing strings.
A UITimer for Swing and SwingOwner.
This class offers a number of useful general purpose utilities used by ribs classes.
A class to manage the Window of a SwingOwner.
This class encapsulates a list of child components which can be switched in and out, like a tab view without the
tabs.
Swing Helper for SwitchPane.
An RMShape subclass for SwitchPane.
A class to act as switch pane's inspector.
An object used to drop SVG symbols onto vision windows.
This interface provides functions for sending syncable data to a remote system.
This allows state provider to notify the manager that something has changed.
This is a provider for a subsystem that wishes to synchronize data across redundancy.
Classes that implement this interface will provide a RedundancySnapshot to the redundancy system as needed,
typically during sync operations.
Represents the result of a sync operation.
Defines the behavior of this Syncable, which will be used by the
SyncManager to create a self-scheduled
runnable.A simple text style class.
Class with several utility functions used by jEdit's syntax colorizing subsystem.
A JIDE GroupList that is compatible with our look and feel
A Synthetica
ProgressBarPainter so we can set the Synthetica.background client prop before
painting the progress bar foreground.A Synthetica
ToggleButtonPainter so we can set the Synthetica.background client prop before
painting the background if the user has applied a background color with no alpha.SystemEncryptionService exposes APIs to:
Encrypt any arbitrary plaintext into ciphertext
Decrypt previously encrypted ciphertext back into the plaintext
An exception associated with the SystemEncryptionService methods
Filters to only logging events that are "system events", or get logged with a "system" marker.
A subclass of the Ignition platform's
ScriptConfig class that adds JSON serialization / deserialization.Convenience class for getting access to the system details and ID.
A marker interface that should be put on classes that provide system functions or fields to scripting, e.g.
Provides a listener that can react to SystemPropertyRecord changes.
Manages access to the SystemPropertiesResource.
Whenever a SystemPropertiesListener fires, this provides a read-only version of the system properties map
that can be safely passed to listeners.
Deprecated.
As of 8.3, use
SystemPropertiesResource, SecurityPropertiesResource,
and LocalSystemPropertiesResource instead.The collection of
SystemProps used in the Vision module.The collection of
SystemProps used in the Historian module.The collection of
SystemProps used in the Ignition core platform.The collection of
SystemProps used in the Perspective module.The collection of
SystemProps used in the Reporting module.The collection of
SystemProps used in the SFC module.SystemProps contributed to this registry will be presented on the Gateway.This is a resource workspace that allows multiple resources to be open at once using a tabbed interface.
Created by carl.gould on 8/6/2014.
This is the base class for the different types of column attributes.
A file that represents a table of data.
Filename: TableGroupShapeConfigFactory.java
Created on Jun 30, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
This class handles UI editing of table groups.
A label that paints its background and border to look like a JTable header.
TableLayout is a layout manager that is more powerful than GridBagLayout yet much easier to use.
TableLayoutConstants define the constants used by all the TableLayout classes.
TableLayoutConstraints binds components to their constraints.
This class provides Swing UI editing for table rows.
This wizard subclass is used to create a simple table.
Deprecated.
Totally unused.
This wizard is just like TablesBasic, but with additional screens for:
Created by carl.gould on 5/5/2015.
This class has some RJTable utility methods in it (for drag and drop).
This class provides Swing UI editing for Tables.
A DefaultTableCellRenderer subclass to add tool tips.
A JTable subclass to make table as big as scrollpane for drag and drop.
We use the term "table" for everything, including procedures, so this is used to actually know what we're talking
about.
A file for managing table views.
A TagActor can be thought of as part of a pipeline.
A TagActorFactory creates TagActors, which are the execution building blocks of tags.
since 8.0
Tag attributes are related to TagProp, but are usually more complicated data types.
A
BindingFactory for creating the appropriate AbstractBinding instance driven by the
TagBindingConfigExtends the standard FolderNode, which allow us to filter child tags before they are passed to the TagBrowserTree
model.
Extends the standard TagProviderNode with a version that can filter out tags at the root level.
Extends the standard RootTagManagerNode with a version where we can add TagBrowseProviderNode, which are extended
TagProviderNodes.
Filename: TagCalculationQueryConfig.java
Created on Aug 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Filename: TagCalculationQueryConfigPanel.java
Created on Aug 06, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
An event listener that is notified when a tag changes
An event listener that is notified when a tag changes
Holds the configuration for a gateway or client scoped tag change script.
Tab for editing tag change event scripts.
The TagCollection interface is used to denote an object that contains many tags.
The basic definition of any tag type.
A TagConfiguration represent the local configuration of a single tag node.
This form of the builder is for child member builders, and only adds the "close()" function that will finish that
builder and return the parent.
This is the manager responsible for handling custom tag editing extensions.
Created by colby.clegg on 7/14/2015.
A tag definition is essentially a collection of properties, with various helpers to aid with the wide range of
features a tag has.
The tag details table records information about a tag path, such as
when it was created, retired, and what data type it was.
This class provides information about a currently executing SQLTag, including its definition, last error, last value,
etc.
This class provides information about a currently executing Tag, including its definition, last error, last value,
etc.
com.inductiveautomation.ignition.common.DiagnosticsSample.DiagnosticLevel
com.inductiveautomation.ignition.common.DiagnosticsSample.Diagnostic
com.inductiveautomation.ignition.common.DiagnosticsSample.Diagnostic
com.inductiveautomation.ignition.common.DiagnosticsSample
com.inductiveautomation.ignition.common.DiagnosticsSample
com.inductiveautomation.ignition.common.tags.status.TagDiagnostics
com.inductiveautomation.ignition.common.tags.status.TagDiagnostics
A Tag Diff represents an edit to a tag that may encompass various fields.
To add a TagDropHandler to a bean, set an instance of one as a property named "tagDropHandler" in the bean's
BeanDescriptor
This class add a little extra information on top of the base PropertyConfigurationController about the tag
configuration that we are editing.
These flags dictate what editing capabilities custom SQLTags support.
Used to decouple Tag Editor parent components from their child components
This is a property set comprised of all of the items that might be relative to a tag provider.
Created by mattgross on 12/4/2017.
com.inductiveautomation.ignition.common.tags.config.CollisionPolicy
com.inductiveautomation.ignition.common.tags.model.InheritanceRelationship
com.inductiveautomation.ignition.common.tags.config.MemoryTagValuePersistence
com.inductiveautomation.ignition.common.tags.config.SampleMode
com.inductiveautomation.ignition.gateway.tags.distributed.TagProviderService2.SubscriptionState
com.inductiveautomation.ignition.common.TagCreatorUtil.Modify
Protobuf type
common.protobuf.TagEnumPBProtobuf type
common.protobuf.TagEnumPB
com.inductiveautomation.ignition.common.tags.config.TagExecutionMode
com.inductiveautomation.ignition.common.tags.config.TagGroupMode
com.inductiveautomation.ignition.common.tags.config.types.TagObjectType
The tag event scripts are python code that execute for certain events.
A source that listens for tag changes and publishes them as events.
Settings to determine how a tag is executed by an execution manager.
This function factory adds additional expression functions that are used by SQLTags, and not by bindings.
com.inductiveautomation.ignition.common.tags.config.TagGroupConfiguration
com.inductiveautomation.ignition.common.tags.config.TagGroupConfiguration
since 8.0
Filename: TagHistorianDataSourceConfigPanel.java
Created on Jul 10, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
A cache system for SQLTags History data.
Parameters with a different time range, and a return size adjusted accordingly.
The "Configurator" for the Tag History binding type
Deprecated.
since 8.0
Deprecated.
This class defines static values that can be set on the flag field of
TagHistoryQueryParams in order to
change the behavior of the query.This interface shares some functions with TagHistoryProvider.
This interface defines the parameters for a tag history query.
Note that this class only handles serialization for BasicTagHistoryQueryParams; other classes that extend from
TagHistoryQueryParams are not sent over the gateway network.
This class is used to store TagGroupHistorySets from our new Historian system.
The actual data is stored through the Tag History intent,
but we use this service to monitor state, and to prevent sending data if the remote side doesn't want us to.
Filename: TagHistorianReportDataObject.java
Created on Jul 10, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Deprecated.
A class that can listen for tag changes and notify an InteractionListener.
Deprecated.
Deprecated.
Provides information about a type of SQLTag.
This class tags a tag node and returns the flattened hierarchy beneath it in iterator form.
This is a special exception used by the expression tag to indicate that a referenced tag was not found.
The root interface for objects in the SQLTags type system.
This enum represents the core set of object types in the tag system.
Deprecated.
Filename: TagPathAliasObject.java
Created on Jul 10, 2015
Author: Kathy Applebaum
Copyright Inductive Automation 2015
Project: Reporting
Deprecated.
com.inductiveautomation.ignition.common.tags.paths.BasicTagPath
com.inductiveautomation.ignition.common.tags.paths.BasicTagPath
com.inductiveautomation.ignition.common.tags.paths.PropertyAlteredTagPath
com.inductiveautomation.ignition.common.tags.paths.PropertyAlteredTagPath
com.inductiveautomation.ignition.common.tags.tagpaths.SimplifiedTagPath
com.inductiveautomation.ignition.common.tags.tagpaths.SimplifiedTagPath
com.inductiveautomation.ignition.common.tags.paths.SourceAlteredTagPath
com.inductiveautomation.ignition.common.tags.paths.SourceAlteredTagPath
Base interface is com.inductiveautomation.ignition.common.tags.model.TagPath
Base interface is com.inductiveautomation.ignition.common.tags.model.TagPath
A general purpose expression that can read a tag path from a generic reader function.
Class contains a text area that can be used to specify multiple
TagPath, and
validate them.Represents a tree of objects, accessible by a tag path.
Created by colby.clegg on 7/14/2015.
This condition checks the path, but does not take tag provider into account.
A Condition implementation with the smarts to be able to search a TagPermissionsModel for a certain value
Deprecated.
Deprecated.
Deprecated.
Wraps a tag as a property set.
The value of a property that can be stored to a tag store.
com.inductiveautomation.ignition.common.tags.config.EditRights
com.inductiveautomation.ignition.common.tags.config.EditRights
com.inductiveautomation.ignition.common.tags.model.TagProviderProps
com.inductiveautomation.ignition.common.tags.model.TagProviderProps
com.inductiveautomation.ignition.common.tags.config.TagTypeDescriptor
com.inductiveautomation.ignition.common.tags.config.TagTypeDescriptor
Deprecated.
This class was used to provide remote tag access to 7.9 gateways.
Implements all of the functions necessary for remote tag providers.
This class does some trickery to avoid sending our new Parameters and ParameterValues to old gateays.
Swaps serialVersionUID of SubPropertyCondition to allow previous classes to deserialize even though they
have different serialVersionUID.
Supports AlarmFilter and TagQueryFilter
Supports AlarmFilter and TagQueryFilter
Deprecated.
A Tag Query is a set of conditions for querying tags.
The TagQueryFilter wraps a query to add on additional temporal data, such as current continuation point, offset, etc.
Protobuf type
common.protobuf.ComparisonConditionPBProtobuf type
common.protobuf.ComparisonConditionPBProtobuf type
common.protobuf.ConditionPBProtobuf type
common.protobuf.ConditionPBProtobuf type
common.protobuf.HierarchyItemPBProtobuf type
common.protobuf.HierarchyItemPB
com.inductiveautomation.ignition.common.tags.query.conditions.NodeIdCondition
com.inductiveautomation.ignition.common.tags.query.conditions.NodeIdCondition
com.inductiveautomation.ignition.common.tags.query.TagQuery.Options
com.inductiveautomation.ignition.common.tags.query.TagQuery.Options
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
PropertyConditions can get quite complex.
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
PropertyConditions can get quite complex.
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition.QualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition.QualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.SetCondition
For tag queries, the SetCondition is a Set of NodeAttributes
com.inductiveautomation.ignition.common.tags.query.conditions.SetCondition
For tag queries, the SetCondition is a Set of NodeAttributes
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.tagObjectType
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.tagObjectType
com.inductiveautomation.ignition.common.tags.query.conditions.TagPathWithoutSourceCondition
com.inductiveautomation.ignition.common.tags.query.conditions.TagPathWithoutSourceCondition
com.inductiveautomation.ignition.common.tags.query.TagQueryFilter
com.inductiveautomation.ignition.common.tags.query.TagQueryFilter
com.inductiveautomation.ignition.common.tags.query.TagQuery
com.inductiveautomation.ignition.common.tags.query.TagQuery
com.inductiveautomation.ignition.common.tags.query.conditions.TypeHierarchyCondition
com.inductiveautomation.ignition.common.tags.query.conditions.TypeHierarchyCondition
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.valueSource
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.valueSource
This is a proxy for the tags, used for querying.
This action, which needs to be initalized with a text component, will show a dialog box prompting the user to find a
tag.
The TagReferenceBinder is a parse context that looks for references to tags, and possibly properties.
Used to provide different types of situations in different contexts, gets passed into TagReferenceAction to create
the component for reference selection.
Deprecated.
Since 8.3.0, only in place for backwards compatibility.
com.inductiveautomation.ignition.common.browsing.TagResult
com.inductiveautomation.ignition.common.browsing.TagResult
This class is used to communicate tag retirement to the data sinks.
Deprecated.
The TagScriptManager handles the compilation and execution of tag event scripts.
Deprecated.
Since 8.3.0, only in place for backwards compatibility.
Performs a gateway-side Tag search
An interface that can be implemented by anything that provides selection of tags.
A tree model for use with a simple tag selection tree.
Displays a simple tree of
BrowseTreeNodes used for selecting tag paths.Copied over from the TagSelectionComponentBuilder class used in 7.9
A tag store is where configured tags are saved.
A TagStoreObject is something that is stored by the tag store and is pass around along with an id that can be used to
efficiently operate on the object later.
Used to display a tag tree with relative paths to the root node.
com.inductiveautomation.ignition.common.tags.model.TagStructureTree.TagNode
com.inductiveautomation.ignition.common.tags.model.TagStructureTree.TagNode
com.inductiveautomation.ignition.common.tags.model.TagStructureTree
com.inductiveautomation.ignition.common.tags.model.TagStructureTree
A combination of a tag path and listener, with hashCode and equals implemented in order to make it properly hashable.
The TagSubscriptionModel holds subscriptions to tags, broken up by provider.
Designed to import Vision client tags via XML text
Represents a tree of Tags, accessible by their path.
Base for a tag action on the tag browser panel.
since 8.0
This interface is the same as QualifiedValue.
An exception that can be used in the process of canceling a task.
Extends from
ProgressListener to add the ability to tell the task
that it has been canceled.Provides the current state of a progress operation.
This is a helper wrapper class that simply adds an increment() function around the ProgressListener, and tracks
the current progress internally.
Convenience builder to create telemetry contributors that contribute some part of a json document.
Vision component that renders multiple template instances inside it.
Event object for template events.
Created by carl.gould on 10/21/2014.
This is an editor (to be used in the vision module's property table) that uses an editable tree combo box that
browses the template hierarchy
Represents a temporal point in the historian system.
A record representing a batch of temporal points and their associated storage result.
Represents a type of temporal point in the historian system.
Describes a translatable term inside of a component.
Describes a translatable term inside of a component.
This class lets us map source strings to hash table results using different types of rules.
Test class.
This is just a class that's here to have a convenient main() method to run
Helpers for writing tests.
This class represents text.
A text editor subclass for editing text in a Swing component.
String table cell editor with touchscreen support
A base class for using Snap Text in Swing.
A special drop handler for components who are setting the tag value to a text property.
A text area subclass for consoles.
A basic subclass of JTextField that fires more property change events for "text" by adding a document listener
Wrapper around various components that can be modeled like a JTextComponent.
A class to represent text with attributes.
A custom class.
A panel for editing text files.
Fills the area with a solid fill at some transparency level.
A base class for text classes that have location and size.
The Run class represents a range of characters in an TextLine that share common attributes.
A class to represent a selection of text.
Created by carl.gould on 5/5/2015.
A class to hold style attributes for a text run.
A class to represent a group of characters in a line that share a set of attributes.
This class provides Swing GUI editing for text shapes.
This tool provides inspector functionality for advanced text attributes.
Text constants.
Text Utilities.
Engine for validating text.
Interface for validating text.
The class this annotation is attached may be assumed thread-safe.
Aggregates items, grouping them if they are submitted consecutively within a specified delay or if
a specified maximum delivery frequency dictates that no more deliveries can be made at the time.
A class of utility methods to make exception handling cleaner.
This class is a GoF "Decorator" that augments the "raw"
Date_selector_panel with a title that displays
the time of day Create a time date selector like this:This aggregate returns a Integer time for the number of seconds
that a value has been On (or Off, depending on on the mode).
Runnable which wraps another runnable and records its execution duration using a
TimerA timeline is a simple list of time segments.
A timeline list is a list of values that cover a span of time.
This class is used to organize overlapping time events.
com.inductiveautomation.ignition.common.util.TimelineList + com.inductiveautomation.ignition.common.util.Timeline
com.inductiveautomation.ignition.common.util.TimelineList + com.inductiveautomation.ignition.common.util.Timeline
com.inductiveautomation.ignition.common.util.TimelineSet
com.inductiveautomation.ignition.common.util.TimelineSet
com.inductiveautomation.ignition.common.util.Timeline.TimelineStyle
com.inductiveautomation.ignition.common.util.TimelineList.TimeSegment
com.inductiveautomation.ignition.common.util.TimelineList.TimeSegment
This dataset wrapper limits the view to a specific time range.
This class provides information about the specific absolute time to run, but also the symbolic time of day, and
the id of the event that was used to generate it.
Represents a time range with optional boundary inclusion.
A binary adapter for serializing and deserializing
TimeRange objects.Protobuf type
common.protobuf.TimeRangePBProtobuf type
common.protobuf.TimeRangePBCreated by carlg on 4/28/2016.
Serializer for encoding and decoding
TimerKey attributesTab for editing timer event scripts.
Config UI for the reporting module's timeseries chart.
com.inductiveautomation.ignition.common.util.TimeUnits
Protobuf type
common.protobuf.TimeUnitsPBProtobuf type
common.protobuf.TimeUnitsPBCreated by Colby on 8/11/2015.
Represents a window of time with a size and unit.
A binary adapter for serializing and deserializing
TimeWindow objects.Protobuf type
common.protobuf.TimeWindowPBProtobuf type
common.protobuf.TimeWindowPBProtobuf enum
common.protobuf.WindowUnitAn
EventBus Event for publishing time zone changes within the designer.Listens for
TimeZoneChangeEvent on the CommonContext.getEventBus() by registration.TimeZone editor that lets the user choose any of the internal timezones, or the special timezones "Gateway Timezone"
or "Client Timezone"
Deprecated.
Annotation for adding a string title to a Resource Schema objects.
This class is a GoF "Decorator" that augements the "raw"
Date_selector_panel with a title that displays
the month name and year.Annotation for adding i18n Title keys to Resource object fields.
The shared title pane for any AbstractManagerPanel.
Marker interface for classes that are slated for deletion
A linked list of tokens.
Describes the input token stream.
Describes the input token stream.
Represents a portion of a char sequence.
Describes the input token stream.
Describes the input token stream.
A basic implementation of a Token.
CUP generated class containing symbol constants.
A class to extract tokens from a char sequence.
Token Manager Error.
This is the base class for tools in RM - the objects that provide GUI editing for RM shapes.
An inner class describing a shape and a handle.
Simply concatenates all sub expressions into a single string value.
Use this class in panels where you want a AutoResizingTextArea with touch screen capability.
Filename: TouchscreenEnabledTable.java
Created on Dec 26, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: FactoryPMI_Client
Moved to api/client/components/touchscreen
This mouse listener implements touchscreen logic for most
TouchscreenMouseListener.TouchscreenEnabledComponent vision components.Filename: TouchscreenTable.java
Created on Dec 26, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: SRClientAPI
Use this class in panels where you want a text field to have touch screen capability.
TPC = Thread Performance Context
This class simply contains some constant strings for common systems to encourage consistency.
Describes the context in which a thread is executing
Callback object returned by the various "set*" methods that is used to un-set whatever was previously set.
A Byte array that notifies an instance of child interface "Tracker" about the progress through the stream
An interface for a set of transactions.
Created by carlg on 1/26/2017.
Configuration required for transform
A way to create transform instances of a certain transform type.
Transforms events based return value from user's script function.
Use on either the getter or setter method (or both) of a property to mark it as transient with respect to the
XMLSerializer.
TransitionFactorys are responsible for instantiating
TransitionElements; the interface encapsulating the execution
logic of an SFC transition.Filename: TranslatablePanelTitledBorder.java
Created on Sep 26, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
Filename: TranslatableTitledBorder.java
Created on Sep 26, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
This class contains translated terms for a specific locale.
Holds all of the translations for a specific key.
A translation package holds the keys and one or more translations for the keys.
Message sent to the perspective client containing information about the localization terms available for a locale.
Tools used for translating component properties.
Deprecated.
No longer needed since Java 5
A Class that implements the listener registration and event fire methods for a TreeModel.
A JPanel that combines a tree and a table for the tag browser in a clever way to make it look like a bonafide
treetable! Hack-a-riffic!
This annotation can be used to protect any gateway network intent object (service, service method, or intent)
such that it can only be called if the specified moduleId is licensed, or if the demo period is not expired.
A JList-like component that uses TristateCheckBoxes for each item
Simple implementation of
X509ExtendedTrustManager that trusts all certificates.Simple implementation of
X509TrustManager that trusts all certificates.The TTSEngineManager is exposed as a module service in order to permit modules to register new engines, and modules
to utilize TTS when available.
A very simple interface that generates an audioinputstream for text.
com.inductiveautomation.ignition.common.tags.browsing.TypeDefBrowseValue
com.inductiveautomation.ignition.common.tags.browsing.TypeDefBrowseValue
TypeDescriptors for common backend types that aren't available in the designer for autocompletion.This filter is used to specify types of annotations to return during a query.
A binary adapter for serializing and deserializing
TypeFilter objects.Protobuf type
common.protobuf.TypeFilterPB
com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter
Protobuf type
common.protobuf.TypeFilterPB
com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter
Represents a condition that dictates how potentially matches should relate to the given type id.
Initializes most basic classes.
This is a definition of a Udt type, including all of its members.
Used when we need to dynamically build out a BrowseNodeInfo tree based on the current StructureNodes in the tag
editor.
This property node represents a sub-tag of a UDT property.
Represents a UI event sent to a UIOwner.
Types for events.
A class to provide utility methods for UI components.
A base controller class class that manages a SwingPanel usually loaded from a rib file.
A Vision Module settings resource object.
A utility class for UI related needs.
Underline border that is best used for JLabels.
Deprecated.
in favor of
UnderlineBorder
Used to take control of the undo/redo stack.
Swing UI editing for undos.
An UndoAction to allow page configuration changes to be controlled via the UndoManger.
Represents a de-constructed component group for helping to support undo/redo
Implement to not exposed child nodes.
A marker class, used to indicate that the EventData came from a remote source and all props should be
trusted/accepted
A tag browse tree that displays realtime and historical providers together in one tree
A exception thrown whenever the system tries to do or access something that has not been licensed.
Extension of
ProjectResourcePathValidatedTextField which performs an additional
validation after the path check to ensure that the path resolved to a query
with an update type (see FB9017).Configuration resource for gateway update scripts.
A tab for editing update scripts
This is available to the user as the saveContext variable passed in on certain extension functions.
Filename: UserManagementPanelTermFinder.java
Created on Dec 26, 2013
Author: Kathy Applebaum
Copyright Inductive Automation 2013
Project: Vision
com.inductiveautomation.ignition.common.user.User
com.inductiveautomation.ignition.common.user.User
Event object for when the user sends a message to one of the perspective event buses.
Represents the data that gets stored in the users.json file for each internal user source profile.
This enumeration contains capabilities that a user source can support.
Base class for
ExtensionPoints that provide a UserSourceProfile implementation.A user management profile provides access to users, groups, and provides authentication verification for users.
Configuration for a user source profile.
The nucleus of a User Source Profile.
Deprecated.
As of 8.3, use
UserSourceProfileConfig instead.An abstract class that extends
ValidatedComboBox with an abstract ValidatedWorkerComboBox.doInBackground() method to
return a List of the supplied type T.This record (which is designed to be directly GSON-serializable) models validation error messages.
A kind of
DecodingException that contains specific validation errorsComponent that displays an icon indicating the validation status.
This is basically a glorified wrapper around a Multimap<DocumentNode, String>
Protobuf type
ignition.rpc.ValueProtobuf type
ignition.rpc.ValueProtobuf type
ignition.rpc.Value.ValueCollectionProtobuf type
ignition.rpc.Value.ValueCollectionProtobuf enum
ignition.rpc.Value.ValueCollection.ImplementationThis is the primary type of result node, that processes values and makes them available to be read by the query.
A cache of value shared across all sessions.
This is the tag script for any change of value (including quality change).
This editor knows how to edit the basic types for json: string, boolean, null, and number, as well as two special
types: Date and Dataset.
since 8.0
A historical column that contains a list of arbitrary values.
Deprecated.
Enum representing the origin of values for the data collection.
A condition that dictates whether the target value should be a specific quality, or a more general quality condition,
like "good".
Handles scaling of values for tags.
clearVariables() clears all of the stored variables and returns the number of variables cleared.
deleteVariable(name) deletes a named variable.
storeVariable(name, value) stores the variable and returns the stored value.
Filename: VarianceAggregate.java
Created on Feb 26, 2016
Author: Kathy Applebaum
Copyright Inductive Automation 2016
Project: SRGatewayAPI
A Vector icon is an Icon implementation that uses Java2D to draw the icon from a Shape object, rather than using
a raster image.
Represents a source of
VectorIcon instances.This interface is for a property set that has knowledge of which properties have changed since a certain point.
com.inductiveautomation.ignition.common.model.Version
com.inductiveautomation.ignition.common.model.Version
Just like FlowLayout, but vertical!
Just like FlowLayout, but vertical!
Just like VerticalFlowLayout, but columns share width equally
A modified version of FlowLayout that allows containers using this Layout to behave in a reasonable manner when
placed inside a JScrollPane
Config object for a single view definition.
Message which is used in both the Designer.js handler, and in the
PerspectiveDesignSession.Subclass of JavaJsBridge for the view editor, to provide the link between the methods defined in the bridge and
the editing of the view.
Tree node implementation used for browsing views.
A class used to specify a specific instance of a running
DesignerViewModel, where the resourcepath designates
a specific view's path in the Resource hierarchy as seen in the designer's resource browser tree.This is a marker interface denoting classes intended for usage as view models.
Delegates to the actual view, this prevents the scripting system from being able to call everything
on ViewModel, like startup(), shutdown, etc.
Created by carlg on 6/6/2017.
Encapsulates the logic of creating the "Parameters" sub-menu for synchronizing view parameters in perspective
component property editor and docked view config popup ui.
PerspectiveEditor is used as the editor when the Perspective Workspace is active and editing a Perspective Project
Resource.
Serialization helper class for view saves that includes size info about the view itself, used for
getting appropriately sized screenshots
Created by carlg on 11/23/2016.
Created by carlg on 11/23/2016.
Created by carlg on 6/13/2017.
Fired on the
DesignerViewModel's EventBus when a component is added, removed, or replacedThis is the
ResourceWorkspace for perspective View resources.Actions associated with the Perspective workspace
Created by colby.clegg on 1/30/2015.
A binding that will set the Visible state of the annotated component to the state of a model
boolean.
Enum to specify if normal or inverted comparisons should be used.
Inner utility class that performs the runtime wiring of all
VisibleIf bindings.This validator, which is a proprietary json-schema extension that we added for Ignition, supplies a condition
to control when a given property should be visible by specifying a sibling property and value(s) for which
this property is considered relevant.
A Table component that features greater features like Drag and Drop rows, multi-column sorting, filtering, etc.
Filename: VisionAdvancedTableTermFinder.java
Created on Oct 31, 2014
Author: Kathy Applebaum
Copyright Inductive Automation 2014
Project: Vision
Bean Descriptor
Minor extension of ClientContext that gets used to initialize bindings and components
The public API interface for the Vision client.
An aggregate interface that marks the typical interfaces required by most Vision components.
An interface that marks a component that is used as a container for other components.
Optional sub-interface for customizers that want to be notified when they are displayed
This is the core of the Vision module, implementing both
DesignerModuleHook and
VisionDesignerInterface.This is the custom JDesktopPane that makes up the top level of the Vision client that manages all the
open windows.
An interface that allows modules to listen to when windows are opened and closed.
Interface for a visitor class.
A Label with a warning indicator to the right of some text.
A normal textfield, that supports a watermark which is displayed when the text box is empty.
Superclass for
BindableModel instances, this class handles the binding
tasks for subclassed models.A stand-alone implementation of
BindableModel.This class manages data site.
Encapsulates useful information for diagnosing authorization decisions
Encapsulates a snapshot of authentication and authorization state
Immutable details of a user who is federated into the system
Provides context about a user who authenticated using web-based protocols such as OIDC or SAML
Provides a fluent-API (builder-style) pattern for creating new
WebAuthUserContext objectsA
JsonSerializer and JsonDeserializer implementation for serializing and de-serializing WebAuthUserContext objects to / from JSON using GSON APIs.A class loader for a WebSite.
A frame which presents the chromium debug tools for the currently selected/active Perspective View Resource.
Represents a file from a WebSite.
An interface for classes that want to post modifications to files.
Web Server settings taking into account all of the web servers settings to provide connection details for the
Gateway.
This is an abstract class to provide data management (create, get, put, delete) and file management.
Interface for Servlet.
This class provides functionality to import a list of connected maps.
Encapsulates a WebSocket Session and logic to send messages conforming to the messaging protocol between the Gateway
and the Designer / Vision Clients.
A
WebSocketChannel connection that is mounted for realtime messaging between a running web-client and the
Ignition gateway's Perspective module.This Exception is thrown when there is a problem sending a message over the WebSocketChannel
Protobuf type
ignition.rpc.WebsocketProtoMessageProtobuf type
ignition.rpc.WebsocketProtoMessageProtobuf type
ignition.rpc.WebsocketProtoMessage.ConnectionModeProtobuf type
ignition.rpc.WebsocketProtoMessage.ConnectionMode
Actual enum constants match those defined in GatewayConstants
Protobuf type
ignition.rpc.WebsocketProtoMessage.PingProtobuf type
ignition.rpc.WebsocketProtoMessage.PingProtobuf type
ignition.rpc.WebsocketProtoMessage.PushNotificationProtobuf type
ignition.rpc.WebsocketProtoMessage.PushNotificationRepresents a UI component that can be rendered in the web UI.
A session for the react-based web ui for the Gateway, introduced in Ignition 8.3.0.
A
WebUiSession.WebUiSessionAccessControl which requires that each request furnish a valid CSRF token.An
AbstractGatewayAccessControlStrategy where auth context such as user information and granted
security levels are derived from Web UI session cookies.A class to represent a URL for a WebSite and WebFile (it can be both for nested sources).
A class to load URLs.
Utility methods for Web classes.
This class provides the welcome panel for RM.
This class provides the welcome panel for RM.
This class provides the welcome panel for RM.
A final class that provides well-defined system flavors.
This class is used as a base for enum-like static definitions of AlarmProperties.
These are path identifiers used by
QualifiedPath for the well-known objects in Ignition.Deprecated.
The
TabbedResourceWorkspace calls this right after it obtained the ResourceEditor that
it's about to through the sequence to close the editor.Implement one of these and register it with the VisionDesignerInterface if you want to add drop handling to the
window workspace.
A project resource object stored for only the Designer's scope.
WindowInfo is a wrapper type that contains an FPMIWindow.
Implementors of this class will be used to initialize a window right before its bindings are connected and
started up.
Custom scale controls that color themselves according to anchoring layout
Executes wmic (Windows Management Instrumentation Command-line) with various (extensible) parameters to pull various
system elements.
The methodns in "NavUtilities" mounted under system.nav.* used to be mounted under system.gui.*
These are the scripting functions mounted at system.gui.* Changes to this class must be made carefully,
as some of the true implementations actually reside in the subclass, WindowUtilitiesForDesktop.
An object that is used to let the windowing system know when a popup is about to be shown,
and when it has hidden.
This class contains methods that are mounted under system.gui.* that are specific to individual
desktop instances.
Defines the options available for drawing dependency arrows
Interface for classes that actually perform a specific wiring.
This class manages a specific wizard, like "Form 1040EZ" or "Table with Groupings"
This class runs the main welcome panel.
A wizard screen is a one screen module that provides UI to get wizard data.
Listener for workspace de/activation
Note: it is recommended to extend the
SecureWriteHandler instead of the WriteHandler directly.A WriteOperation is returned in response to a write request for a tag.
To participate in a tag write pipeline, a TagActor must implement this interface.
Created by carlg on 11/23/2016.
Deprecated.
since 8.3.0, use WSChannelSettingsResource instead
Deprecated.
since 8.3.0, use WSConnectionSettingsResource instead
A resource that holds settings for an outgoing Gateway Network connection.
A wizard screen used to select a detail keys.
A wizard screen used to select a grouping key.
A wizard screen used to select header names.
A wizard screen used to select a list key.
A wizard screen used to select sort keys.
This provides static methods to convert an XML text into a JSONObject,
and to covert a JSONObject into an XML text.
This class maintains a pool of XMLReaders.
Used while serializing to keep track of references and indentation.
The XMLTokener extends the JSONTokener to provide additional methods
for the parsing of XML texts.
Deprecated.
since 8.3.
A WebSite subclass for Zip files.
A ZipFile.
The ZipMap provides a convenient way of working with zip files by providing a
Map that is backed by a zip
file.Represents a permission requirement, where the request must originate from a specific security zone
and/or be initiated by a user which has a certain role.
Tests an input IP address against a comma-delimited pattern list.
If the setting is true, the value must be true, otherwise true or false works.
A ZoomableResourceEditor is a designer interface that allows that allows for the 'zooming' in and out on the content
in the main resource workspace panel such as seen in and Report resources.
Filename: ZoomIndicator
Author: Perry Arellano-Jones
Created on: 6/30/15
Project: ignition_dev_7_8B
ADAuthPropertiesResourceinstead.