ScriptTokenInformation

public interface ScriptTokenInformation

Interface for querying information for an associated token.

The values of this interface may be lazily populated.

The token informations are usually displayed when the user hovers over a given token in the code editor, or explicitly requests information about it.

ScriptSyntaxModel.getTokenInformation(ScriptToken)

SimpleScriptTokenInformation

Methods

public PartitionedTextContent	getDescription() Gets the description for the corresponding token if available.
public default String	getSchemaIdentifier() Gets the identifier that is associated with this token information schema.
public default Map<String, String>	getSchemaMetaData() Gets the schema meta-data that is associated with the token information.

public abstract PartitionedTextContent getDescription()

Gets the description for the corresponding token if available.

This is usually displayed when an user hovers the mouse pointer over a script token in the IDE, or explicitly requests information about it.

The description.

public default String getSchemaIdentifier()

Gets the identifier that is associated with this token information schema.

The schema identifiers are arbitrary strings that should uniquely identify the nature of the token information. It can be used by IDE plugins and others to interpret the token information and present the user a more readable display.

One use case for this is to create IDE plugins that add various icons for the information display.

E.g.:

 "org.company.scripting.token.info"

The schema identifier or null if none.

public default Map<String, String> getSchemaMetaData()

Gets the schema meta-data that is associated with the token information.

The meta-data can contain arbitrary key-value pairs that can be used to describe various aspects of the information. This is used to convey information to the IDE plugins about different aspects of the token information.

The meta-data for the token information. May be null or empty.

getSchemaIdentifier()