Inductive Automation Ignition SDK

https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/
Admin
Inductive Automation Ignition SDK is a comprehensive Java development kit for building industrial...
Tokens:7,100,929
Snippets:71,830
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### GatewayModuleHook setup Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/GatewayModuleHook.html

The setup method is called before startup, allowing modules to add extension points and update schemas. Managers are not yet started at this point.

```java
void setup(GatewayContext context)
```

--------------------------------

### setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/SystemPropertiesManager.html

Performs setup operations for the SystemPropertiesManager.

```APIDOC
## setup

### Description
Performs setup operations for the SystemPropertiesManager.

### Signature
public void setup()
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/designer/workspace/ExpandedGroupHighlight.html

Installs the highlight into the workspace.

```APIDOC
## install

### Description
Installs the highlight into the workspace.
```

--------------------------------

### System Name and Setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/SystemPropertiesManager.html

Methods to retrieve the system name and perform initial setup.

```APIDOC
## getSystemName

### Description
Retrieves the name of the system.

### Method
`String getSystemName()`

## setup

### Description
Initializes the SystemPropertiesManager. This method should be called during the gateway's startup process.

### Method
`void setup()`
```

--------------------------------

### setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/reporting/designer/workspace/inspector/AnnotatedProperty.html

Performs setup operations for the property.

```APIDOC
## setup

### Description
Performs setup operations for the property.

### Method Signature
`public void setup()`
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/util/gui/MouseAdapterEx.html

Installs this mouse listener onto a JComponent.

```APIDOC
## install(JComponent comp)

### Description
Installs the mouse listener onto the specified JComponent.

### Method
`void install(JComponent comp)`

### Parameters
* **comp** (JComponent) - The component to install the listener on.
```

--------------------------------

### setup(GatewayContext gatewayContext)

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/GatewayHook.html

Called before startup. This is the chance for the module to add its extension points and update persistent records and schemas. None of the managers will be started up at this point, but the extension point managers will accept extension point types.

```APIDOC
## setup(GatewayContext gatewayContext)

### Description
Called before startup. This is the chance for the module to add its extension points and update persistent records and schemas. None of the managers will be started up at this point, but the extension point managers will accept extension point types.

Specified by:
`setup` in interface `GatewayModuleHook`

### Method
`public void setup(GatewayContext gatewayContext)`

### Parameters
#### Path Parameters
- **gatewayContext** (GatewayContext) - Required - The GatewayContext instance.
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/blockandconnector/blockui/BasicBlockUI.html

Installs this block UI onto a BlockComponent.

```APIDOC
## void install(BlockComponent parent)

### Description
Installs this block UI onto the provided BlockComponent.

### Parameters
* **parent** (BlockComponent) - The parent component to install the UI onto.
```

--------------------------------

### setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/assets/themes/ThemeManagerImpl.html

Sets up the Asset Manager. Copies any defaults into the asset home directory. Should be run before startup.

```APIDOC
## setup
public void setup()

Sets up the Asset Manager. Copies any defaults into the asset home directory. Should be run before `AbstractLifecycle.startup()`.

Overrides:
    `setup` in class `AbstractAssetManager<String,String>`
```

--------------------------------

### Guide Color

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/designable/BasicGridSettings.html

Methods to get and set the color for the guides.

```APIDOC
## getGuideColor()

### Description
Retrieves the color used for the guides.

### Method
`Color getGuideColor()`

### Returns
The `Color` of the guides.
```

```APIDOC
## setGuideColor(Color guideColor)

### Description
Sets the color for the guides.

### Method
`void setGuideColor(Color guideColor)`

### Parameters
#### Path Parameters
- **guideColor** (Color) - Required - The color to set for the guides.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/launch/LaunchHook.html

Called after setup() to initiate the application's main startup process.

```APIDOC
## startup

### Description
Called after setup() to start the application.

### Method
`void startup()`

### Throws
`Exception`
```

--------------------------------

### On Start Script

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/sfc/uimodel/ChartUIModel.html

Methods to get and set the script that executes when the chart starts.

```APIDOC
## getOnStartScript

### Description
Gets the script that executes when the chart starts.

### Method
GET

### Endpoint
N/A (Java method)

### Returns
- String: The script to execute on chart start.
```

```APIDOC
## setOnStartScript

### Description
Sets the script to execute when the chart starts.

### Method
SET

### Endpoint
N/A (Java method)

### Parameters
#### Parameters
- `onStartScript` (String) - The script to execute on chart start.
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/tabbedworkspace/ResourceNode.html

Installs the node into the navigation tree.

```APIDOC
## install

### Description
Installs the node into the navigation tree.

### Signature
public void install(AbstractNavTreeNode parent)

### Overrides
`install` in class `AbstractResourceNavTreeNode`
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/designable/IDesignTool.html

Installs the tool for the given panel. Tools are built to be re-used by repeatedly being installed and then uninstalled as tools get switched out.

```APIDOC
void install(DesignPanel panel)
```

--------------------------------

### setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/assets/AbstractAssetManager.html

Sets up the Asset Manager by copying default assets.

```APIDOC
## setup

### Description
Setup the Asset Manager. Copies any defaults into the asset home directory. Should be run before `AbstractLifecycle.startup()`.
```

--------------------------------

### Click Count to Start

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/PMITable.html

Methods for getting and setting the click count required to start editing a cell.

```APIDOC
## getClickCountToStart

### Description
Gets the number of clicks required to start editing a cell.

### Method
GET

### Endpoint
N/A (Method Call)

### Returns
- **int**: The number of clicks required for editing.

## setClickCountToStart

### Description
Sets the number of clicks required to start editing a cell.

### Method
SET

### Endpoint
N/A (Method Call)

### Parameters
- **clickCountToStart** (int) - Required - The number of clicks to set.

```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/designer/workspace/nav/ComponentNode.html

Installs the component node into the navigation tree.

```APIDOC
## install

### Description
Installs the component node into the navigation tree, optionally attaching it to a parent node.

### Method
POST

### Endpoint
`install(AbstractNavTreeNode parent)`

### Parameters
* **parent** (AbstractNavTreeNode) - The parent node to attach this node to.
```

--------------------------------

### install Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/util/gui/SelectAllOnFocusListener.html

Installs the SelectAllOnFocusListener on a given JComponent.

```APIDOC
## install(JComponent component)

### Description
Installs the SelectAllOnFocusListener on a given JComponent. This method should be called to attach the listener to the desired component.

### Method
`static void install(JComponent component)`

### Parameters
#### Path Parameters
- **component** (JComponent) - The component to install the listener on.
```

--------------------------------

### Install Debug Pane

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/viewer/GraphicsDebugPane.html

Call this method to start debugging a component and all its children. This will install the GraphicsDebugPane to visualize repaint regions.

```APIDOC
## installDebugPane

### Description
Installs the GraphicsDebugPane on the specified component to visualize repaint regions.

### Method
static void

### Signature
installDebugPane(JComponent aComponent)

### Parameters
* **aComponent** (JComponent) - The component to install the debug pane on.
```

--------------------------------

### Get All Modules

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/ModuleManager.html

Returns a list of all installed modules.

```APIDOC
## getModules

### Description
Returns a list of all modules.

### Method
List<GatewayModule>
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/runtime/ClientContextImpl.html

Initializes the client context.

```APIDOC
## startup

### Description
Initializes the client context.

### Method
void

### Signature
startup()
```

--------------------------------

### startup Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/template/VisionTemplate.html

Starts up the template, including adapters and components.

```APIDOC
## startup()

### Description
Starts up the template, including its adapters and components. Specified in the `BindingRoot` interface.

### Method
`public void startup()`
```

--------------------------------

### getAutoZoomStartHour Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/PMIWeekView.html

Gets the start hour for auto-zoom.

```APIDOC
## getAutoZoomStartHour()

### Description
Gets the start hour for auto-zoom.

### Method
`public int getAutoZoomStartHour()`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/FPMIWindow.html

Starts up the window.

```APIDOC
## void startup()

### Description
Initiates the startup sequence for the window, making it ready for use. This is typically called after initialization.
```

--------------------------------

### getQuoteBegin

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/adbs/syntax/AccessSyntaxProvider.html

Gets the starting character for quoted identifiers.

```APIDOC
## getQuoteBegin

### `getQuoteBegin()`

**Returns:** `String` - The starting quote character.

Overrides: `getQuoteBegin` in class `BaseSyntaxProvider`

Gets the starting character for quoted identifiers.
```

--------------------------------

### setupNewRecord

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/web/components/actions/NewRecordAction.html

Performs initial setup for a new record before it is edited.

```APIDOC
## setupNewRecord

### Description
Performs any necessary initial setup or configuration on a new record instance before it is presented for editing.

### Signature
`protected void setupNewRecord(T record)`

### Parameters
* **record** (T) - The new record instance to set up.
```

--------------------------------

### getGuideLocation

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/editor/RMEditorInputAdapter.html

Gets the location of a specific guide within a document.

```APIDOC
## getGuideLocation

### Description
Returns the guide location for the given index.

### Signature
public static double getGuideLocation(RMDocument aDoc, int anIndex)

### Parameters
* **aDoc** (RMDocument) - The document containing the guide.
* **anIndex** (int) - The index of the guide.

### Returns
* **double** - The location of the guide.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/binding/http/HttpBinding.html

Start up the binding. Will be called on-queue.

```APIDOC
## startup

### Description
Start up the binding. Will be called on-queue.

### Method
`public void startup()`

### Implements
`startup` in interface `Binding`

### Overrides
`startup` in class `AbstractPollingBinding<HttpUriRequestBuilder>`
```

--------------------------------

### getExecutionStarted

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/reporting/gateway/api/ReportExecutionContext.html

Gets the date and time when the report execution started.

```APIDOC
## getExecutionStarted

### Description
Gets the date and time when the report execution started.

### Method
Date
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/common/logging/LoggingManagerImpl.html

Initializes the logging system.

```APIDOC
## startup

### Description
Initializes the logging system.

### Method
void

### Endpoint
startup()
```

--------------------------------

### Get Modules

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/gateway_interface/GatewayInterface.html

Retrieves a list of installed modules on the gateway.

```java
getModules()
```

--------------------------------

### getWorkingStartHour Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/PMIWeekView.html

Gets the start hour of the working day.

```APIDOC
## getWorkingStartHour()

### Description
Gets the start hour of the working day.

### Method
`public int getWorkingStartHour()`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/runtime/ClientContextImpl.html

Initializes the client context and performs startup tasks.

```APIDOC
## startup

### Description
Initializes the client context and performs startup tasks.

### Method
```java
public void startup()
```
```

--------------------------------

### MidnightFunction execute

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/index-files/index-5.html

Executes the Midnight function to get the start of the day.

```APIDOC
## MidnightFunction execute

### Description
Returns a date object representing the beginning of the day (midnight) for a given date or the current date.

### Method
execute

### Parameters
- **expressions** (Expression[]) - Optionally contains a date value; if omitted, uses the current date.

### Response
- **result** (Date) - A date object set to midnight of the specified or current day.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/localdb/hsql/HsqlDbManager.html

Starts up the HSQLDB database manager.

```APIDOC
## startup()

### Description
Starts up the HSQLDB database manager. This method is called by the gateway during its startup sequence.

### Throws
* `DBStartupException` - If the database fails to start.
```

--------------------------------

### staticSetup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/launch/LaunchHook.html

This setup method is called first, before setup(), and only the first time in a given JVM. It's intended for one-time initialization tasks.

```APIDOC
## staticSetup

### Description
This setup will be called first, before setup(), but only the first time in a given JVM.

### Method
`void staticSetup()`

### Throws
`Exception`
```

--------------------------------

### getAnchor()

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/blockandconnector/model/AnchorPoint.html

Gets the actual anchor point coordinates where a connector will start or end.

```APIDOC
## getAnchor()

### Description
This is the actual anchor point that a connector will start/end at. This point may be inside the blocks bounds.

### Method
public abstract Point getAnchor()
```

--------------------------------

### run Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/binding/UDTProperty.SetupDirectBinding.html

Executes the direct binding setup process.

```APIDOC
## run Method

### Description
Executes the direct binding setup process. This method is part of the `Runnable` interface implementation.

### Signature
`public void run()`

### Implements
`run` in interface `Runnable`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/tags/model/ClientTagProvider.html

Initializes and starts the client tag provider.

```APIDOC
## startup

### Description
Initializes and starts the client tag provider.

### Method
void
```

--------------------------------

### startDate and endDate

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/EquipmentScheduleView.Timeline.html

Methods to get and set the start and end dates for the timeline.

```APIDOC
## getStartDate()

### Description
Gets the start date of the timeline.

### Method
public Date getStartDate()

## setStartDate(Date startDate)

### Description
Sets the start date of the timeline.

### Method
public void setStartDate(Date startDate)

### Parameters
- **startDate** (Date) - The start date to set.

## getEndDate()

### Description
Gets the end date of the timeline.

### Method
public Date getEndDate()

## setEndDate(Date endDate)

### Description
Sets the end date of the timeline.

### Method
public void setEndDate(Date endDate)

### Parameters
- **endDate** (Date) - The end date to set.
```

--------------------------------

### Divider Position and Length

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/shape/RMCrossTabDivider.html

Methods to get the start and end indices, and the length of the divider.

```APIDOC
## getStart()

### Description
Returns the starting row index (if column divider) or column index (if row divider) for this divider.

### Method
public int getStart()

### Returns
* **int** - The starting index of the divider.
```

```APIDOC
## getEnd()

### Description
Returns the ending row index (if column divider) or column index (if row divider) for this divider.

### Method
public int getEnd()

### Returns
* **int** - The ending index of the divider.
```

```APIDOC
## getLength()

### Description
Returns the length of the divider in terms of rows (or columns).

### Method
public int getLength()

### Returns
* **int** - The length of the divider.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/action/ScriptAction.html

Initializes the script action.

```APIDOC
## startup

### Description
Initializes the script action. This method is called when the action is started.

### Method
void
```

--------------------------------

### Get Module Count

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/ModuleManager.html

Returns the total count of modules currently installed in the system.

```APIDOC
## getModuleCount

### Description
The total count of modules currently installed.

### Method
int
```

--------------------------------

### Getting Path Position

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/reportmill/graphics/RMPath.html

Retrieves the X and Y coordinates of the path's origin or starting point.

```java
double x = path.getX();
```

```java
double y = path.getY();
```

--------------------------------

### Get Instance Token

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/GatewayContextDecorator.html

Returns a UUID generated fresh every time the context starts up.

```APIDOC
## getInstanceToken()

### Description
Returns a UUID that is generated fresh every time the context starts up.

### Method
GET

### Endpoint
/gateway/context/getInstanceToken
```

--------------------------------

### Get Next Token Start Character

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/ribs/pdf/PDFCharStream.html

Returns the next character that marks the beginning of the next token.

```APIDOC
## BeginToken()

### Description
Returns the next character that marks the beginning of the next token.

### Method
final char
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/binding/BindingRoot.html

Starts up the binding root, including its adapters and child lifecycles.

```APIDOC
## startup

### Description
Start up the root. Start-up adapters, and start-up any children ComponentLifecycles.

### Method Signature
`void startup()`
```

--------------------------------

### setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/tags/model/GatewayTagProvider.html

Sets up the tag provider with a subscription model.

```APIDOC
## setup

### Description
Sets up the tag provider with a subscription model.

### Method
void

### Signature
setup(TagSubscriptionModel model)
```

--------------------------------

### Get All Datasources

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/datasource/DatasourceManager.html

Returns a list of all currently installed data sources. This list is a snapshot and is not backed by the manager.

```APIDOC
## getDatasources

### Description
Returns a list of all known datasources currently installed. This list is not backed by the manager - changes to it will not have any effect.

### Method Signature
`List<Datasource> getDatasources()`
```

--------------------------------

### Get Module License Details

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/licensing/LicenseManager.html

Looks up the module license details for a specific module, checking all installed licenses.

```APIDOC
## getModuleLicense

### Description
Looks up the module license details for a specific module. This method will look through all installed licenses, not just the primary license.

### Method Signature
`Optional<LicenseDetails> getModuleLicense(String moduleId)`

### Parameters
* `moduleId` (String) - Required - The id of the module to look up license details for.
```

--------------------------------

### run Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/launch/steps/StartupStep.html

Executes the logic for this startup step.

```APIDOC
## run Method

### Description
Executes the logic for this startup step. This method contains the core operations to be performed during the client startup sequence.

### Signature
`public void run() throws Exception`

### Throws
* **Exception** - If an error occurs during the execution of the startup step.
```

--------------------------------

### Node Role Configuration

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/redundancy/types/RedundancySettings.html

Methods to get and set the desired role of a node in the redundancy setup. This can be overridden by the system license.

```APIDOC
## getNodeRole

### Description
Retrieves the desired role of the node. This may be overridden by the system license.

### Method
GET

### Endpoint
/gateway/redundancy/settings/nodeRole

## setNodeRole

### Description
Sets the desired role of the node.

### Method
POST

### Endpoint
/gateway/redundancy/settings/nodeRole

### Parameters
#### Request Body
- **value** (NodeRole) - Required - The desired role for the node.
```

--------------------------------

### startup Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/common/expressions/functions/BaseFunction.html

Starts up the function. This is an empty implementation in BaseFunction.

```APIDOC
## startup()

### Description

Empty implementation from BaseFunction. Override if necessary.

### Method

`void startup()`
```

--------------------------------

### Initialize Ribs Functionality

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/ribs/Ribs.html

Initializes the Ribs functionality by installing an event queue and configuring the helper map. This should be called once at the start of the application.

```java
Ribs.init();
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/cache/PerspectiveProjectCacheImpl.html

Starts up the Perspective project cache.

```APIDOC
## startup()

### Description
Starts up the Perspective project cache.

### Method
void
```

--------------------------------

### Get Demo Countdown State

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/model/ModuleManager.html

Returns the current demo state of the system, indicating whether modules are installed, licensed, or in demo mode.

```APIDOC
## getDemoCountdownState

### Description
Returns what kind of demo state the system is currently in with relation to which modules are installed, which are licensed, and which are in demo mode.

### Method
DemoCountdownState
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/sqltags/ClientSubManager.html

Starts up the client tag manager.

```APIDOC
## startup

### Description
Starts up the client tag manager.

### Method Signature
`void startup()`
```

--------------------------------

### Get Boolean Array from PDF Dictionary

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/pdf/reader/PDFDictUtils.html

Extracts an array of booleans from a PDF dictionary. Example PDF structure: << /Vals [true false] >>

```java
public static boolean[] getBoolArray(Map dictionary, PDFFile srcFile, String key)
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/binding/AbstractPollingBinding.html

Starts up the binding. This method will be called on-queue.

```APIDOC
public void startup()

Description copied from interface: `Binding`
Start up the binding. Will be called on-queue 

Specified by:
    `startup` in interface `Binding`
```

--------------------------------

### Get Rectangle2D from PDF Dictionary

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/pdf/reader/PDFDictUtils.html

Extracts a Rectangle2D object from a PDF dictionary. Example PDF structure: << /BBox [0 0 612 792] >>

```java
public static Rectangle2D getRectangle(Map dictionary, PDFFile srcFile, String key)
```

--------------------------------

### main Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/designer/projectproperties/ClientLaunchPropsPanel.html

Entry point for the ClientLaunchPropsPanel application.

```APIDOC
## main
public static void main(String[] args)

### Description
Starts the ClientLaunchPropsPanel application. This is the main entry point for execution.
```

--------------------------------

### Get Float Array from PDF Dictionary

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/pdf/reader/PDFDictUtils.html

Extracts an array of floats from a PDF dictionary. Example PDF structure: << /Nums [1.414 2.717 3.1415 ] >>

```java
public static float[] getFloatArray(Map dictionary, PDFFile srcFile, String key)
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/history/sf/sinks/AggregateSink.html

Starts the AggregateSink and all its aggregated DataSinks.

```APIDOC
## startup

### Description
Starts the AggregateSink and all its aggregated DataSinks.

### Method
public void startup()
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/tags/tree/node/RootTagManagerNode.html

Called when the node is created.

```APIDOC
## install(TagTreeModel model, int index)

### Description
Called when the node is created.

### Parameters
- **model** (TagTreeModel) - Required - The tag tree model.
- **index** (int) - Required - The index at which this node occurs in its parent.
```

--------------------------------

### getAction

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/designable/IDesignTool.html

Provides a way for external objects to get a hold of Actions that the tool defines. For example, the `SelectionTool` defines a number of alignment and z-order actions.

```APIDOC
Action getAction(Object key)
```

--------------------------------

### Get Integer Array from PDF Dictionary

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/pdf/reader/PDFDictUtils.html

Extracts an array of integers from a PDF dictionary. Example PDF structure: << /Ints [1 3 5 7] >>

```java
public static int[] getIntArray(Map dictionary, PDFFile srcFile, String key)
```

--------------------------------

### Welcome Constructor

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/reportmill/Welcome.html

Creates a new instance of the Welcome panel.

```APIDOC
## Welcome Constructor

### Description
Creates a new Welcome panel.

### Method Signature
`public Welcome()`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/chart/easychart/AbstractCalculatedPenDatasource.html

Starts this datasource up. This should certainly mean that the data gets generated at least once, and possibly more based upon the chart's polling settings. May be called again after shutdown().

```APIDOC
## startup(PMIEasyChart chart)

### Description
Starts this datasource up. This should certainly mean that the data gets generated at least once, and possibly more based upon the chart's polling settings. May be called again after shutdown().

Specified by:
`startup` in interface `IPenDatasource`

### Method
`public void startup(PMIEasyChart chart)`
```

--------------------------------

### main

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/common/upgrader/Upgrader.html

The main method is designed to be called from the installer executables.

```APIDOC
## main(String[] args)

### Description
The main method is designed to be called from the installer executables.

### Method
static void

### Parameters
* args (String[]) - Description not available
```

--------------------------------

### Get AffineTransform from PDF Dictionary

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/pdf/reader/PDFDictUtils.html

Extracts an AffineTransform object from a PDF dictionary. Example PDF structure: << /Matrix [1 0 0 1 0 0] >>

```java
public static AffineTransform getTransform(Map dictionary, PDFFile srcFile, String key)
```

--------------------------------

### doInBackground Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/scripteditor/GlobalScriptEditor.GatewayIntellihintsInstaller.html

Performs the background task of installing gateway Intellihints.

```APIDOC
## doInBackground Method

### Description
This method is executed in a background thread and is responsible for fetching and processing Intellihints from the gateway.

### Signature
`protected Map<String,List<ScriptFunctionHint>> doInBackground() throws Exception`

### Returns
A map where keys are script names and values are lists of `ScriptFunctionHint` objects.

### Throws
`Exception` - If any error occurs during the background processing.
```

--------------------------------

### QualityMonitor Implementation Example

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/vision/api/client/components/model/QualityMonitor.html

This common implementation pattern shows how to manage data quality within a component. It includes methods for getting and setting quality, updating quality based on property changes, and painting overlays.

```java
private QualityCode quality = null;

 public QualityCode getDataQuality() {
   return quality;
 }

 public void setDataQuality(QualityCode value) {
      QualityCode oldQuality = this.quality;
      this.quality = value;
      firePropertyChange("dataQuality", oldQuality, value);
      repaint();
 }

 public void updateQuality(String propName, QualityCode quality) {
   OverlayUtility.updateQuality(this, propName, quality);
 }

 @Override
 protected void paintChildren(Graphics g) {
   super.paintChildren(g);
   OverlayUtility.paintOverlay(this, g);
 }
 
```

--------------------------------

### initialize

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/script/builtin/ClientSystemUtilities.html

Initializes the ClientSystemUtilities with the provided FPMIApp instance.

```APIDOC
## initialize(FPMIApp app)

### Description
Initializes the ClientSystemUtilities with the provided FPMIApp instance.

### Method Signature
`initialize(FPMIApp app)`

### Parameters
- **app** (FPMIApp) - The FPMI application instance.
```

--------------------------------

### getPDFHexString (byte[] overload)

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/rm/pdf/reader/PDFPageParser.html

Replace ascii hex in pageBytes with actual bytes. Start points to first char after the '<', end is the upper limit to seek through. r gets filled with the actual range of the converted bytes. Return value is index of last character swallowed.

```APIDOC
## Method

### Signature
`public static int getPDFHexString(byte[] pageBytes, int start, int end, com.inductiveautomation.rm.pdf.reader.Range r)`

### Description
Replace ascii hex in pageBytes with actual bytes. Start points to first char after the '<', end is the upper limit to seek through. r gets filled with the actual range of the converted bytes. Return value is index of last character swallowed.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/sqltags/impl/SubManagerAdapter.html

Starts up the tag provider.

```APIDOC
## startup

### Description
Initializes and starts up the tag provider, preparing it for operation.

### Method
`void startup()`
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/designer/model/navtree/AbstractTopLevelContainerNode.html

Installs the node into the navigation tree. Overrides the install method from AbstractResourceNavTreeNode.

```APIDOC
public void install(AbstractNavTreeNode parent)
Overrides:
    install in class AbstractResourceNavTreeNode
```

--------------------------------

### getStartupWindows()

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/model/WindowCache.html

Retrieves a list of paths for all windows that are configured to start automatically.

```APIDOC
## getStartupWindows()

### Description
Looks up the ids to all windows that are specified as startup windows.

### Method
List<String>
```

--------------------------------

### setup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/blockandconnector/routing/EdgeRouter.html

Sets up the edge router with the obstacles to avoid.

```APIDOC
## setup

### Description
Sets up the edge router with the obstacles to avoid.

### Method
void

### Parameters
#### Path Parameters
- **obstacles** (Map<UUID,Rectangle>) - Required - A map of obstacle UUIDs to their Rectangle definitions.
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/reporting/designer/workspace/nav/ShapeNode.html

Installs the ShapeNode, associating it with a parent node. Overrides the install method from AbstractNavTreeNode.

```APIDOC
## install

### Description
Installs the ShapeNode, associating it with a parent node.

### Method Signature
public void install(AbstractNavTreeNode parent)

### Parameters
* **parent** (AbstractNavTreeNode) - The parent node to which this node is being added.
```

--------------------------------

### start()

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/reportmill/RMApplet.html

Called when the applet is started or revisited. Overrides the start method from the Applet class.

```APIDOC
## start()

### Description
Called when applet is started or revisited.

### Method
public void start()

### Overrides
`start` in class `Applet`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/user/LockoutTrackingUserSourceProfileKernel.html

Initializes the user source profile kernel when it is created.

```APIDOC
## startup

### Description
Called when the user source is created before it is used. This method is part of the lifecycle management of the user source profile kernel.

### Method
public void startup(UserSourceManager manager)

### Parameters
#### Path Parameters
- **manager** (UserSourceManager) - Required - The user source manager instance.

### Request Example
```java
userSourceProfileKernel.startup(userSourceManager);
```
```

--------------------------------

### start

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/snap/swing/SwingTimer.html

Starts the timer.

```APIDOC
## start

### Description
Start timer.

### Method
`void start()`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/model/PropertyChangeScript.html

Subscribes to the target property and performs initialization tasks.

```APIDOC
## startup

### Description
Subscribes to the target property and performs initialization tasks.

### Method
`public void startup(PerspectiveElement component) throws Exception`

### Parameters
- **component** (PerspectiveElement) - The Perspective element to which this script is attached.

### Throws
- **Exception** - If an error occurs during startup.
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/util/gui/DebouncedCatchAllListener.html

Installs the DebouncedCatchAllListener on a JTextComponent.

```APIDOC
## install(JTextComponent component, Runnable callback)

### Description
Installs a debounced listener on the given JTextComponent. When the text component's content changes, the provided callback Runnable will be executed after a specified delay.

### Parameters
* **component** (JTextComponent) - The text component to attach the listener to.
* **callback** (Runnable) - The Runnable to execute after the delay.
```

--------------------------------

### startupBindings

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/binding/DefaultInteractionController.html

Starts up all registered bindings.

```APIDOC
## startupBindings()

### Description
Starts up all registered bindings.

### Method
`void startupBindings()`
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/runtime/ClientPanel.html

Main entrypoint, called from ClientLaunchHook.startup(). Adds notification listeners for project change and project deletion. If the gateway connection's session is already valid at this point, control goes to startupApp(ProjectInitializationParams) directly. Otherwise, installLoginPane(ProjectInitializationParams, boolean) is called.

```APIDOC
## startup
public void startup(ProjectInitializationParams params) throws Exception

### Description
Main entrypoint, called from `ClientLaunchHook.startup()`
Adds notification listeners for project change and project deletion.
If the gateway connection's session is already valid at this point, control goes to `startupApp(ProjectInitializationParams)` directly. Otherwise, `installLoginPane(ProjectInitializationParams, boolean)` is called.

### Throws
`Exception`
```

--------------------------------

### SetupDirectBinding Constructor

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/binding/UDTProperty.SetupDirectBinding.html

Initializes a new instance of the SetupDirectBinding class.

```APIDOC
## SetupDirectBinding Constructor

### Description
Initializes a new instance of the `SetupDirectBinding` class.

### Signature
`public SetupDirectBinding(UDTProperty udtProperty, JComponent component, String name)`

### Parameters
*   **udtProperty** (UDTProperty) - The UDT property to bind.
*   **component** (JComponent) - The component associated with the binding.
*   **name** (String) - The name of the binding.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/binding/expression/ExpressionBindingTagListener.html

Initializes the listener with the common context and interaction listener.

```APIDOC
## startup(CommonContext context, InteractionListener listener)

### Description
Initializes the listener with the common context and interaction listener.

### Method
`public void`

### Parameters
- **context** (CommonContext) - The common context for the listener.
- **listener** (InteractionListener) - The interaction listener.
```

--------------------------------

### install

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/scripteditor/component/ScriptIntelliHints.html

Installs ScriptIntelliHints for a given CodeEditor.

```APIDOC
## install(CodeEditor codeEditor, Map<String,List<ScriptFunctionHint>> hintsMap)

### Description
Static method to install script intelligence hints onto a code editor.

### Parameters
* **codeEditor** (CodeEditor) - The code editor to attach hints to.
* **hintsMap** (Map<String,List<ScriptFunctionHint>>) - The map of hints to provide.

### Returns
* ScriptIntelliHints - The installed ScriptIntelliHints instance.
```

--------------------------------

### Start Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/snap/util/SPRunner.html

Starts the execution of the runner.

```APIDOC
## start()

### Description
Starts the runner and its associated task.

### Method
`public SPRunner<T> start()`

### Returns
SPRunner<T> - The SPRunner instance.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/components/chart/easychart/HistogramQuery.html

Starts up the datasource and initializes it with the provided EasyChart component.

```APIDOC
## void startup(PMIEasyChart chart)

### Description
Starts this datasource up.

### Parameters
* **chart** (PMIEasyChart) - The EasyChart component to associate with this datasource.
```

--------------------------------

### startup(LicenseState activationState)

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/GatewayHook.html

Called to initialize the module. Will only be called once. Persistence interface is available, but only in read-only mode.

```APIDOC
## startup(LicenseState activationState)

### Description
Called to initialize the module. Will only be called once. Persistence interface is available, but only in read-only mode.

Specified by:
`startup` in interface `GatewayModuleHook`

### Method
`public void startup(LicenseState activationState)`

### Parameters
#### Path Parameters
- **activationState** (LicenseState) - Required - The current license state.
```

--------------------------------

### init Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/runtime/login/IgnitionLoginScreen.html

Initializes the login screen with the provided components and properties.

```APIDOC
## init(JComponent loginPanel, String projectTitle, String projectDescription, LoginProps loginProps, JButton exitButton, JToggleButton touchscreenButton)

### Description
Initializes the login screen UI and its associated properties.

### Method
public void init

### Parameters
- **loginPanel** (JComponent) - The main panel for the login interface.
- **projectTitle** (String) - The title of the project to be displayed.
- **projectDescription** (String) - A description of the project.
- **loginProps** (LoginProps) - Properties related to the login process.
- **exitButton** (JButton) - The button used to exit the application.
- **touchscreenButton** (JToggleButton) - A toggle button for touchscreen mode.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/localdb/DBManager.html

Starts up the internal database service.

```APIDOC
## startup

### Description
Starts up the internal database service.

### Method Signature
void startup() throws DBStartupException

### Throws
- `DBStartupException` - If the database fails to start.
```

--------------------------------

### startup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/localdb/sqlite/SQLiteDBManager.html

Starts up the SQLite database manager.

```APIDOC
## startup

### Description
Starts up the SQLite database manager.

### Method
`void startup()`
```

--------------------------------

### onStartup()

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/model/ComponentModel.html

Starts up the component, including its bindings and children.

```APIDOC
## onStartup()

### Description
Starts up the bindings and any children.
```

--------------------------------

### onStartup() - IdpProxyWebServer

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/index-files/index-15.html

Provides startup logic for IdpProxyWebServer.

```APIDOC
## onStartup()

### Description
Provides startup logic for IdpProxyWebServer.

### Method
`onStartup()`

### Class
`com.inductiveautomation.ignition.client.auth.IdpProxyWebServer`
```

--------------------------------

### start() Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/ribs/helpers/JListHpr.Range.html

Retrieves the starting index of the range.

```APIDOC
## start()

### Description
Returns the start of the range.

### Signature
`int start()`

### Returns
* **int** - The starting index of the range.
```

--------------------------------

### Startup Method Implementation

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/vision/api/client/ClientModuleHook.html

The main entrypoint for a module hook, called once per project. Implementations should handle initialization logic here.

```java
void startup(ClientContext context, LicenseState activationState) throws Exception
```

--------------------------------

### start with delay

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/snap/swing/SwingTimer.html

Starts the timer with an initial delay.

```APIDOC
## start

### Description
Start timer.

### Method
`void start(long aDelay)`

### Parameters
#### Path Parameters
- **aDelay** (long) - Required - The initial delay in milliseconds before the timer starts.
```

--------------------------------

### onStartup

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/perspective/gateway/session/PerspectiveProjectSession.html

Handles the startup logic for the session kernel wrapper.

```APIDOC
## onStartup

### Description
Handles the startup logic for the session.

### Method
protected void onStartup()

### Overrides
`onStartup` in class `SessionKernelWrapper<SecuredPerspectiveProjectSession>`
```

--------------------------------

### Guide Visibility

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/designer/designable/BasicGridSettings.html

Methods to control the visibility of the guides.

```APIDOC
## isGuidesVisible()

### Description
Checks if the guides are currently visible.

### Method
`boolean isGuidesVisible()`

### Returns
`true` if the guides are visible, `false` otherwise.
```

```APIDOC
## setGuidesVisible(boolean guidesVisible)

### Description
Sets the visibility of the guides.

### Method
`void setGuidesVisible(boolean guidesVisible)`

### Parameters
#### Path Parameters
- **guidesVisible** (boolean) - Required - Determines whether the guides should be visible.
```

--------------------------------

### main

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/common/upgrader/Upgrader.html

The main method is designed to be called from the installer executables. It handles the core upgrade logic based on provided arguments.

```APIDOC
## main

### Description
The main method is designed to be called from the installer executables. Usage is as follows:
args[0]= the path to the base install folder. The installer executable knows what this path is.
args[1]= the path to the data folder. The installer executable also knows what this path is.
args[2]= the path to the logs folder. The installer executable also knows what this path is.
args[3]= the file to process. Passing "file=ignition.conf" will cause the upgrader to add items to ignition.conf until it has all items required at the CURRENT_VERSION variable. Change this to whitelabel.conf as needed for white label builds. Passing "file=config.xml" should only be used when upgrading a pre-7.3 installation to 7.3 or later. It will cause the upgrader to retrieve information from config.xml, such as the http port and ssl port that are used by the current installation. These values are then added to gateway.xml.

### Method
public static void main(String[] args)
```

--------------------------------

### init()

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/util/ClientLoggingSystem.html

Initializes the client logging system.

```APIDOC
## init()

### Description
Initializes the client logging system. This method should be called before any other logging operations.

### Method
static void

### Signature
init()
```

--------------------------------

### start()

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/client/sqltags/impl/ChangeNotifier.html

Starts the execution of the ChangeNotifier, ensuring it runs on the EDT.

```APIDOC
## start()

### Description
Starts the ChangeNotifier. If the current thread is not the Event Dispatch Thread (EDT), this method will enqueue the Runnable onto the EDT. Otherwise, it will call the `run()` method directly.

### Method
`void start()`
```

--------------------------------

### setupNewRecord

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/ignition/gateway/web/components/actions/NewRecordAction.html

Performs setup operations for a new record before it is saved.

```APIDOC
## setupNewRecord

### Signature
```java
protected void setupNewRecord(T record)
```

### Description
Performs necessary setup operations on a record before it is created or saved.

### Parameters
*   **record** (T) - The record to set up.
```

--------------------------------

### start Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/runtime/UpdateScriptModulesPane.html

Starts the UpdateScriptModulesPane with the given window state.

```APIDOC
## start Method

### Description
Starts the UpdateScriptModulesPane, applying the specified window state.

### Signature
public void start(WindowStateCollection windowState)

### Parameters
* **windowState** (WindowStateCollection) - The collection of window states to apply.
```

--------------------------------

### start Method

Source: https://sdk.inductiveautomation.com/javadoc/ignition81/8.1.53/com/inductiveautomation/factorypmi/application/runtime/UpdateScriptModulesPane.html

Starts the UpdateScriptModulesPane with the given window state.

```APIDOC
## void start(WindowStateCollection windowState)

### Description
Initiates the UpdateScriptModulesPane, typically called when the associated window or component is starting.

### Parameters
#### Path Parameters
- **windowState** (WindowStateCollection) - Required - The collection of window states to apply.
```
Tokens:
Raw