Useful Utility Classes

Designer API

Class	Description
EDTUtil	Provides convenience functions for working with the EDT, and a useful coalescingInvokeLater() function that can be used to group multiple calls into a single event.
ErrorUtil	Provides many functions for displaying errors, but also other dialogs such as info messages, warning messages, and prompts.
IconUtil	Retrieves icons provided with Ignition.
Later	Contains helpful functions for queueing actions to run later. Every function included wraps it's logic into a runnable submitted to EventQueue.invokeLater(Runnable).
VectorIcons	Represents a source of VectorIcon instances. This class is made to be used with a JSON source file which stores the source of the vector icons. The JSON format is expected to be an array of objects, each object containing name and paths. Default icons used in Ignition can also be retrieved by name with the static methods on this class.
SvgIconUtil	Loads SVG files from the classpath of the Designer or your module as Swing icons.

Resource API

Class	Description
ResourceUtil	Provides various functions for retrieving specific details of a resource.
ProjectEncoder	Provides a collection of utility methods to encode and decode resource collection and related objects to/from JSON. Note that the methods on this class use the project encoding style.
ConfigModeEncoder	Collection of utility methods to encode and decode resource collection and related objects to/from JSON. Note that the methods on this class use the configuration mode encoding style.
ImmutableBytes	Provides useful instance methods to pass to existing APIs, and it can also be constructed from a variety of static factory methods. The ImmutableBytes class is used throughout the configuration and project resource systems.

General API

Class	Description
TypeUtilities	Provides various functions to perform type conversions.
FormatUtil	Provides convenience functions for working with various data type formatting.
JsonUtilities	Provides many functions for working with JSON data.

Scripting API

Class	Description
PyUtilities	Provides various functions for working with Python objects.
PyArgParser	Converts Jython's keyword argument signature PyObject[], String[] into more useful Java base classes. Argument names specified in camelCase in Java code will be accepted in either camelCase or snake_case from Jython.
AbstractJythonSequence	Simulates a Jython "sequence" (Pythonic list). If you don't want to implement a method, you can leave it a no-op, and add PyIgnoreMethodTag to the throws declaration to prevent it from being exposed to Jython.
AbstractJythonMap	Simulates a Python map (dictionary) for easy implementation. If you don't want to implement a method, you can leave it a no-op, and add PyIgnoreMethodTag to the throws declaration to prevent it from being exposed to Jython.