Package com.inductiveautomation.ignition.common.script.hints

Interface ScriptFunctionDocProvider

All Known Implementing Classes:

PropertiesFileDocProvider

public interface ScriptFunctionDocProvider

Entrypoint to the autocomplete system for scripting functions.

As scripting functions are added (e.g. via addScriptModule or addStaticFields), the doc provider will be asked to provide a CompletionDescriptor describing the element.

Example implementation that provides documentation from a custom source:

 public class MyDocProvider implements ScriptFunctionDocProvider {
     public CompletionDescriptor.Method getMethodDescriptor(String path, Method m) {
         String desc = myBundle.getString(m.getName() + ".desc");
         return new CompletionDescriptor.Method(m.getName(), path, desc, ...);
     }
     // ... other methods
 }
 

See Also:

• PropertiesFileDocProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptFunctionDocProvider	NO_DOC_PROVIDER	A ScriptFunctionDocProvider that provides no documentation.

Method Summary

Modifier and Type	Method	Description
@Nullable com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute	getFieldDescriptor(String path, Field f)
@Nullable com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method	getMethodDescriptor(String path, Method m)

Field Details

NO_DOC_PROVIDER

static final ScriptFunctionDocProvider NO_DOC_PROVIDER

A ScriptFunctionDocProvider that provides no documentation.

Should only be used when providing function implementations for backwards compatibility purposes, where the method should be callable but not clutter autocomplete.

See Also:

• PropertiesFileDocProvider
• - if using a PropertiesFileDocProvider, NoHint can be used to hide specific implementations from autocomplete.

Method Details

getMethodDescriptor

@Nullable com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method getMethodDescriptor(String path,
 Method m)

Parameters:

path - The path this function is being added at, as given to the ScriptManager.

m - The Method being added as a scripting function.

Returns:

A descriptor for the method.

See Also:

• CompletionDescriptor.Method
• TypeDescriptor

getFieldDescriptor

@Nullable com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Attribute getFieldDescriptor(String path,
 Field f)

Parameters:

path - The path this field is being added at, as given to the ScriptManager.

f - The Field being added as a scripting field.

Returns:

A descriptor for the field.

See Also:

• CompletionDescriptor.Attribute
• TypeDescriptor