Package com.inductiveautomation.ignition.common.script

Enum ModuleLibrary.ScriptHintScope

java.lang.Object

java.lang.Enum<ModuleLibrary.ScriptHintScope>

com.inductiveautomation.ignition.common.script.ModuleLibrary.ScriptHintScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModuleLibrary.ScriptHintScope>

Enclosing class:

ModuleLibrary

public static enum ModuleLibrary.ScriptHintScope
extends java.lang.Enum<ModuleLibrary.ScriptHintScope>

Enum Constant Summary

Enum Constants

Enum Constant	Description
All
Designer
Gateway
None

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBundleKey()
java.lang.String	toString()
static ModuleLibrary.ScriptHintScope	valueOf(int scope)	Returns the enum constant of this type with the specified name.
static ModuleLibrary.ScriptHintScope	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ModuleLibrary.ScriptHintScope[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final ModuleLibrary.ScriptHintScope None

Designer

public static final ModuleLibrary.ScriptHintScope Designer

Gateway

public static final ModuleLibrary.ScriptHintScope Gateway

All

public static final ModuleLibrary.ScriptHintScope All

Method Detail

values

public static ModuleLibrary.ScriptHintScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModuleLibrary.ScriptHintScope c : ModuleLibrary.ScriptHintScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModuleLibrary.ScriptHintScope valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

valueOf

public static ModuleLibrary.ScriptHintScope valueOf(int scope)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

scope - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBundleKey

public java.lang.String getBundleKey()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ModuleLibrary.ScriptHintScope>