Package com.intellij.codeInsight.documentation

Interface DocumentationManagerProtocol

public interface DocumentationManagerProtocol

The protocols used for links to elements in quick documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEEP_SCROLLING_POSITION_REF A special 'ref' value (see PSI_ELEMENT_PROTOCOL_REF_SEPARATOR) which can be used to request keeping the scrolling position unchanged.
static java.lang.String	PSI_ELEMENT_PROTOCOL The protocol used for linking to PSI elements in quick documentation.
static java.lang.String	PSI_ELEMENT_PROTOCOL_REF_SEPARATOR Separator between PSI element link and a reference to specific text fragment, which should be scrolled to on navigation.

Field Detail

PSI_ELEMENT_PROTOCOL

static final java.lang.String PSI_ELEMENT_PROTOCOL

The protocol used for linking to PSI elements in quick documentation.

See Also:

DocumentationManagerUtil, Constant Field Values

PSI_ELEMENT_PROTOCOL_REF_SEPARATOR

static final java.lang.String PSI_ELEMENT_PROTOCOL_REF_SEPARATOR

Separator between PSI element link and a reference to specific text fragment, which should be scrolled to on navigation. Can be used with PSI_ELEMENT_PROTOCOL links, full link should look like psi_element://link###ref.

See Also:

Constant Field Values

KEEP_SCROLLING_POSITION_REF

static final java.lang.String KEEP_SCROLLING_POSITION_REF

A special 'ref' value (see PSI_ELEMENT_PROTOCOL_REF_SEPARATOR) which can be used to request keeping the scrolling position unchanged. This can be useful e.g. if navigation over some link just appends some content to already displayed content.

See Also:

Constant Field Values