org.hkijena.jipipe.utils

Class TooltipUtils

java.lang.Object

org.hkijena.jipipe.utils.TooltipUtils

public class TooltipUtils
extends Object

Utilities that generate tooltips or other text from JIPipe data data structures

Method Summary

Modifier and Type	Method and Description
static MarkdownDocument	getAlgorithmDocumentation(JIPipeGraphNode node)
static MarkdownDocument	getAlgorithmDocumentation(JIPipeNodeInfo info)
static String	getAlgorithmTooltip(JIPipeGraphNode node, boolean withTitle) Creates a tooltip for an algorithm
static String	getAlgorithmTooltip(JIPipeNodeInfo info) Creates a tooltip for an algorithm.
static String	getAlgorithmTooltip(JIPipeNodeInfo info, boolean withTitle) Creates a tooltip for an algorithm
static String	getAlgorithmTooltip(JIPipeNodeTemplate template, boolean withTitle) Creates a tooltip for an algorithm
static String	getDataTableTooltip(JIPipeDataTable dataTable) Creates a tooltip for an JIPipeDataSlot
static String	getDataTooltip(JIPipeDataInfo info) Creates a tooltip for data
static String	getProjectCompartmentTooltip(JIPipeProjectCompartment compartment, JIPipeGraph projectGraph) Creates a tooltip for a project compartment
static String	getSlotTable(Collection<JIPipeDataSlotInfo> slotDefinitions) Creates a slot definition table.

Methods inherited from class java.lang.Object

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

Method Detail

getProjectCompartmentTooltip

public static String getProjectCompartmentTooltip(JIPipeProjectCompartment compartment,
                                                  JIPipeGraph projectGraph)

Creates a tooltip for a project compartment

Parameters:

compartment - the compartment

projectGraph - the project graph

Returns:

tooltip

getAlgorithmTooltip

public static String getAlgorithmTooltip(JIPipeNodeInfo info)

Creates a tooltip for an algorithm. Has a title

Parameters:

info - the algorithm type

Returns:

the tooltip

getAlgorithmDocumentation

public static MarkdownDocument getAlgorithmDocumentation(JIPipeNodeInfo info)

getAlgorithmDocumentation

public static MarkdownDocument getAlgorithmDocumentation(JIPipeGraphNode node)

getAlgorithmTooltip

public static String getAlgorithmTooltip(JIPipeNodeInfo info,
                                         boolean withTitle)

Creates a tooltip for an algorithm

Parameters:

info - the algorithm

withTitle - if a title is displayed

Returns:

the tooltip

getAlgorithmTooltip

public static String getAlgorithmTooltip(JIPipeNodeTemplate template,
                                         boolean withTitle)

Creates a tooltip for an algorithm

Parameters:

template - the node template

withTitle - if a title is displayed

Returns:

the tooltip

getAlgorithmTooltip

public static String getAlgorithmTooltip(JIPipeGraphNode node,
                                         boolean withTitle)

Creates a tooltip for an algorithm

Parameters:

node - the algorithm

withTitle - if a title is displayed

Returns:

the tooltip

getDataTableTooltip

public static String getDataTableTooltip(JIPipeDataTable dataTable)

Creates a tooltip for an JIPipeDataSlot

Parameters:

dataTable - the data table

Returns:

tooltip

getSlotTable

public static String getSlotTable(Collection<JIPipeDataSlotInfo> slotDefinitions)

Creates a slot definition table. Has a HTML root

Parameters:

slotDefinitions - the slots

Returns:

the tooltip

getDataTooltip

public static String getDataTooltip(JIPipeDataInfo info)

Creates a tooltip for data

Parameters:

info - the data type

Returns:

the tooltip