PackageHint

java.lang.Object
- com.inductiveautomation.ignition.designer.scripteditor.component.PackageHint

All Implemented Interfaces:

ScriptFunctionHint, java.io.Serializable
```
public class PackageHint
extends java.lang.Object
implements ScriptFunctionHint
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PackageHint(java.lang.String pathElement, java.lang.String currentPath)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAutocompleteText()`
`java.lang.String`	`getMethodDescription()`
`java.lang.String`	`getMethodSignature()`
`java.util.Map<java.lang.String,java.lang.String>`	`getParameterDescriptions()`
`java.lang.String`	`getReturnValueDescription()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PackageHint
```
public PackageHint(java.lang.String pathElement,
                   java.lang.String currentPath)
```
- Method Detail
  - getAutocompleteText
```
public java.lang.String getAutocompleteText()
```
    Specified by:
    
    getAutocompleteText in interface ScriptFunctionHint
    
    Returns:
    
    The String to insert if the user chooses to auto-complete this hint.
  - getMethodSignature
```
public java.lang.String getMethodSignature()
```
    Specified by:
    
    getMethodSignature in interface ScriptFunctionHint
    
    Returns:
    
    The formatted String to use as the method signature.
  - getMethodDescription
```
public java.lang.String getMethodDescription()
```
    Specified by:
    
    getMethodDescription in interface ScriptFunctionHint
    
    Returns:
    
    A description of what the function does.
  - getParameterDescriptions
```
public java.util.Map<java.lang.String,java.lang.String> getParameterDescriptions()
```
    Specified by:
    
    getParameterDescriptions in interface ScriptFunctionHint
    
    Returns:
    
    Map of parameter names matched to their descriptions.
  - getReturnValueDescription
```
public java.lang.String getReturnValueDescription()
```
    Specified by:
    
    getReturnValueDescription in interface ScriptFunctionHint
    
    Returns:
    
    A description of the function's return value.