Package jetbrains.mps.smodel.presentation

Class NodePresentationUtil

java.lang.Object

jetbrains.mps.smodel.presentation.NodePresentationUtil

public class NodePresentationUtil
extends Object

This class provides utility methods for default presentation logic for referenced nodes. Here is some implementation notes how presentation text is calculated: 1) default presentation: - custom text by overriding BC#getPresentation() or ISmartReferent#getPresentation(context) - name from INamedConcept - special presentation for smart. refs. TODO should be removed - concept alias 2) matching text: - custom text by overriding ISmartReferent#getMatchingText(context) - resolveInfo from IResolveInfo TODO IResolveInfo now uses mostly to separate matchingText and visibleMatchingText - default presentation 3) visible matching text: - custom text by overriding ISmartReferent#getVisibleMatchingText(context) - default presentation 4) description text: - custom text by overriding ISmartReferent#getDescriptionText(context) - {conceptName} ( {where} ) These facilities should be used only in editor-runtime for specifying the textual presentation of referenced node in completion, etc. Other subsystems should not rely on it and use SNode.getPresentation() or SNode.getName() instead. TODO Should be moved to editor-runtime?

Constructor Summary

Constructors

Constructor	Description
NodePresentationUtil()

Method Summary

Modifier and Type	Method	Description
static String	descriptionText(SAbstractConcept concept)
static String	descriptionText(SAbstractConcept concept, boolean referentPresentation)	Deprecated. use descriptionText(SAbstractConcept) instead
static String	descriptionText(SNode node)
static String	descriptionText(SNode node, boolean referent_presentation)	Deprecated. use descriptionText(SNode) instead.
static String	descriptionText(SNode node, SNode context)
static String	getAliasOrConceptName(SNode node)
static int	getFontStyle(SNode referenceNode, SNode referentNode)
static String	getPathToRoot(SNode node)
static String	getRoleInParentOrConceptName(SNode node)
static int	getSortPriority(SNode referenceNode, SNode referentNode)
static boolean	isLocalTo(SNode referenceNode, SNode referentNode)
static String	matchingText(SAbstractConcept concept)
static String	matchingText(SAbstractConcept concept, boolean referentPresentation)	Deprecated. use matchingText(SAbstractConcept) instead.
static String	matchingText(SNode node)	Deprecated. This method provides a visible matching text instead of real matching text, that might be confusing.
static String	matchingText(SNode node, boolean referent_presentation)	Deprecated. This method provides a visible matching text instead of real matching text, that might be confusing.
static String	matchingText(SNode node, boolean referent_presentation, boolean visible)	Deprecated. use matchingText(SNode, SNode), matchingText(SNode, SNode, boolean) or visibleMatchingText(SNode, SNode)
static String	matchingText(SNode node, SNode context)	Provides a text that will be matched with user-typed pattern in completion menu.
static String	matchingText(SNode node, SNode context, boolean visible)	It's preferred to use matchingText(SNode, SNode) or visibleMatchingText(SNode, SNode) instead.
static String	presentation(SNode node, SNode context)	Provides a text that should be shown in editor to present a referenced node.
static String	visibleMatchingText(SNode node, SNode context)	Provides a text that presents given node in completion menu.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodePresentationUtil

public NodePresentationUtil()

Method Detail

isLocalTo

public static boolean isLocalTo(SNode referenceNode,
                                SNode referentNode)

getFontStyle

public static int getFontStyle(SNode referenceNode,
                               SNode referentNode)

getSortPriority

public static int getSortPriority(SNode referenceNode,
                                  SNode referentNode)

presentation

public static String presentation(@NotNull
                                  SNode node,
                                  @Nullable
                                  SNode context)

Provides a text that should be shown in editor to present a referenced node.

matchingText

public static String matchingText(SAbstractConcept concept)

matchingText

@Deprecated
public static String matchingText(SAbstractConcept concept,
                                  boolean referentPresentation)

Deprecated.

use matchingText(SAbstractConcept) instead.

matchingText

@Deprecated
public static String matchingText(SNode node)

Deprecated.

This method provides a visible matching text instead of real matching text, that might be confusing. Should be replaced with visibleMatchingText(SNode, SNode).

matchingText

@Deprecated
public static String matchingText(SNode node,
                                  boolean referent_presentation)

Deprecated.

This method provides a visible matching text instead of real matching text, that might be confusing. Should be replaced with visibleMatchingText(SNode, SNode).

matchingText

@Deprecated
public static String matchingText(SNode node,
                                  boolean referent_presentation,
                                  boolean visible)

Deprecated.

use matchingText(SNode, SNode), matchingText(SNode, SNode, boolean) or visibleMatchingText(SNode, SNode)

matchingText

public static String matchingText(@NotNull
                                  SNode node,
                                  @Nullable
                                  SNode context)

Provides a text that will be matched with user-typed pattern in completion menu.

matchingText

public static String matchingText(@NotNull
                                  SNode node,
                                  @Nullable
                                  SNode context,
                                  boolean visible)

It's preferred to use matchingText(SNode, SNode) or visibleMatchingText(SNode, SNode) instead.

visibleMatchingText

public static String visibleMatchingText(@NotNull
                                         SNode node,
                                         @Nullable
                                         SNode context)

Provides a text that presents given node in completion menu. This text also can be used for matching with user-typed pattern, if there is no necessity to facilitate the separation between real matching text and visible matching text.

descriptionText

public static String descriptionText(SAbstractConcept concept)

descriptionText

@Deprecated
public static String descriptionText(SAbstractConcept concept,
                                     boolean referentPresentation)

Deprecated.

use descriptionText(SAbstractConcept) instead

descriptionText

public static String descriptionText(SNode node)

descriptionText

@Deprecated
public static String descriptionText(SNode node,
                                     boolean referent_presentation)

Deprecated.

use descriptionText(SNode) instead.

descriptionText

public static String descriptionText(SNode node,
                                     SNode context)

getAliasOrConceptName

public static String getAliasOrConceptName(SNode node)

getRoleInParentOrConceptName

public static String getRoleInParentOrConceptName(SNode node)

getPathToRoot

public static String getPathToRoot(SNode node)