org.hkijena.jipipe.utils

Class UIUtils

java.lang.Object

org.hkijena.jipipe.utils.UIUtils

public class UIUtils
extends Object

Utils for UI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIUtils.DragThroughMouseListener

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DARK_THEME
static FileNameExtensionFilter	EXTENSION_FILTER_AVI
static FileNameExtensionFilter	EXTENSION_FILTER_BMP
static FileNameExtensionFilter	EXTENSION_FILTER_CSV
static FileNameExtensionFilter	EXTENSION_FILTER_HTML
static FileNameExtensionFilter	EXTENSION_FILTER_IMAGEIO_IMAGES
static FileNameExtensionFilter	EXTENSION_FILTER_JIP
static FileNameExtensionFilter	EXTENSION_FILTER_JIPC
static FileNameExtensionFilter	EXTENSION_FILTER_JIPE
static FileNameExtensionFilter	EXTENSION_FILTER_JPEG
static FileNameExtensionFilter	EXTENSION_FILTER_JSON
static FileNameExtensionFilter	EXTENSION_FILTER_MD
static FileNameExtensionFilter	EXTENSION_FILTER_PDF
static FileNameExtensionFilter	EXTENSION_FILTER_PNG
static FileNameExtensionFilter	EXTENSION_FILTER_ROI
static FileNameExtensionFilter	EXTENSION_FILTER_ROI_ZIP
static FileNameExtensionFilter	EXTENSION_FILTER_ROIS
static FileNameExtensionFilter	EXTENSION_FILTER_SVG
static FileNameExtensionFilter	EXTENSION_FILTER_TIFF
static FileNameExtensionFilter	EXTENSION_FILTER_TSV
static FileNameExtensionFilter	EXTENSION_FILTER_TXT
static FileNameExtensionFilter	EXTENSION_FILTER_XLSX
static FileNameExtensionFilter	EXTENSION_FILTER_ZIP
static Map<String,ImageIcon>	ICON_FROM_RESOURCES_CACHE
static Map<String,ImageIcon>	ICON_INVERTED_FROM_RESOURCES_CACHE
static Insets	UI_PADDING

Constructor Summary

Constructors

Constructor and Description
UIUtils()

Method Summary

Modifier and Type	Method and Description
static void	addEscapeListener(JDialog dialog) Makes a JDialog close when the escape key is hit
static void	addFillerGridBagComponent(Container component, int row, int column) Equivalent of Box.verticalGlue() for GridBagLayout
static JPopupMenu	addPopupMenuToComponent(AbstractButton target) Adds a popup menu to a button.
static JPopupMenu	addPopupMenuToComponent(AbstractButton target, JPopupMenu popupMenu) Adds an existing popup menu to a button
static JPopupMenu	addReloadablePopupMenuToComponent(AbstractButton target, JPopupMenu popupMenu, Runnable reloadFunction) Adds an existing popup menu to a button Adds a function that is run before the popup is shown
static JPopupMenu	addReloadableRightClickPopupMenuToComponent(AbstractButton target, JPopupMenu popupMenu, Runnable reloadFunction) Adds an existing popup menu to a button Adds a function that is run before the popup is shown
static JPopupMenu	addRightClickPopupMenuToComponent(AbstractButton target) Adds an existing popup menu to a button Adds a function that is run before the popup is shown
static JPopupMenu	addRightClickPopupMenuToComponent(AbstractButton target, JPopupMenu popupMenu) Adds an existing popup menu to a button Adds a function that is run before the popup is shown
static void	applyThemeToCodeEditor(org.fife.ui.rsyntaxtextarea.RSyntaxTextArea textArea)
static int	askOpenInCurrentWindow(Component parent, String title) Asks the user how to open a project: In the current window or a new window
static JPanel	boxHorizontal(Component... components)
static JPanel	boxVertical(Component... components)
static boolean	checkAndAskIfFileExists(Component parent, Path path, String title) Checks if a file exists and asks the user if it should be overwritten
static boolean	confirmResetParameters(JIPipeWorkbench parent, String title)
static void	copyToClipboard(String string) Copies the string to the clipboard
static JLabel	createInfoLabel(String text, String subtext)
static JLabel	createJLabel(String text, Icon icon)
static JLabel	createJLabel(String text, Icon icon, int fontSize)
static JLabel	createJLabel(String text, int fontSize)
static JMenuItem	createMenuItem(String label, String description, Icon icon, Runnable action)
static Map<String,JMenu>	createMenuTree(JMenu rootMenu, Set<String> menuPaths) Creates a hierarchy of menus based on the menu paths vector
static JLabel	createStarRatingLabel(String title, double stars, int maximum) Creates a read-only "star-rating" label
static JSeparator	createVerticalSeparator()
static void	expandAllTree(JTree tree) Expands the whole tree
static void	fitRowHeights(JTable table) Fits the row heights of a JTable
static String	getAWTWindowTitle(Window window)
static Color	getBorderColorFor(JIPipeNodeInfo info) Returns a border color for JIPipeNodeInfo
static Optional<Double>	getDoubleByDialog(Component parent, String title, String message, double initialValue, double min, double max) Gets an integer by dialog
static BufferedImage	getExtensionBuilderLogo400()
static Color	getFillColorFor(JIPipeNodeInfo info) Returns a fill color for JIPipeNodeInfo
static BufferedImage	getHeaderPanelBackground()
static HTMLText	getHTMLByDialog(JIPipeWorkbench workbench, Component parent, String title, String message, HTMLText initialValue) Gets a formatted HTML string by dialog
static ImageIcon	getIcon128FromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static ImageIcon	getIcon16FromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static ImageIcon	getIcon32FromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static ImageIcon	getIcon64FromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static ImageIcon	getIcon8FromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static SolidColorIcon	getIconFromColor(Color color) Creates 16x16 a color icon
static ImageIcon	getIconFromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static ImageIcon	getIconInverted32FromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static ImageIcon	getIconInvertedFromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static URL	getIconURLFromResources(String iconName) Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager
static Optional<Integer>	getIntegerByDialog(Component parent, String title, String message, int initialValue, int min, int max) Gets an integer by dialog
static BufferedImage	getLogo()
static BufferedImage	getLogo400()
static String	getMultiLineStringByDialog(Component parent, String title, String message, String initialValue) Gets a multiline string by dialog
static <T> List<T>	getSelectionByDialog(Component parent, Collection<T> input, Collection<T> selected, String title, String message, ListCellRenderer<T> renderer, ListSelectionMode selectionMode) Lets the user select one or multiple items from a list
static String	getStringFromClipboard() Returns a string from clipboard or an empty string
static JIPipeUITheme	getThemeFromRawSettings()
static String	getUniqueStringByDialog(Component parent, String message, String initialValue, Predicate<String> exists) Continuously asks for an unique string
static JPanel	gridHorizontal(Component... components)
static JPanel	gridVertical(Component... components)
static void	installMenuExtension(JIPipeWorkbench workbench, JMenu targetMenu, JIPipeMenuExtensionTarget targetMenuType, boolean withSeparator) Installs an extension menu
static void	invokeScrollToTop(JScrollPane scrollPane)
static void	loadLookAndFeelFromSettings() Attempts to override the look and feel based on the JIPipe settings
static JTextPane	makeBorderlessReadonlyTextPane(String text, boolean opaque) Creates a readonly text pane (that can do HTML)
static void	makeBorderlessWithoutMargin(AbstractButton component) Makes a component borderless
static void	makeFlat(AbstractButton component) Makes a button flat
static void	makeFlat(AbstractButton component, Color borderColor, int top, int left, int right, int bottom) Makes a button flat
static void	makeFlat25x25(AbstractButton component) Makes a button flat and 25x25 size
static void	makeFlatH25(AbstractButton component) Makes a button flat and have a height of 25px
static JTextPane	makeMarkdownReader(MarkdownDocument document, String[] css) Creates a JTextPane that displays Markdown content
static JTextArea	makeReadonlyBorderlessTextArea(String text) Creates a readonly text area
static JTextField	makeReadonlyBorderlessTextField(String value) Creates a readonly text field
static JTextArea	makeReadonlyTextArea(String text) Creates a readonly text area Cannot do HTML.
static JTextField	makeReadonlyTextField(String value) Creates a readonly text field
static JTextPane	makeReadonlyTextPane(String text) Creates a readonly text pane (that can do HTML)
static void	makeToggleReadonly(JToggleButton toggleButton) Makes a toggle button readonly without greying it out
static JLabel	makeURLLabel(String url) Makes a label that contains a URL and opens the URL when clicked
static void	openErrorDialog(Component parent, Exception exception) Opens a dialog showing an exception
static void	openFileInNative(Path path) Opens a website with given URL
static void	openNotificationsDialog(JIPipeWorkbench workbench, Component parent, JIPipeNotificationInbox notifications, String title, String infoText, boolean autoClose)
static void	openValidityReportDialog(Component parent, JIPipeIssueReport report, String title, String infoText, boolean modal) Opens a dialog showing a validity report
static void	openWebsite(String url) Opens a website with given URL
static void	packDataTable(org.jdesktop.swingx.JXTable table) packAll() for a data table (with a limit)
static void	redirectDragEvents(Component component, Component target)
static void	registerHyperlinkHandler(JTextPane content)
static void	sendTrayNotification(String caption, String message, TrayIcon.MessageType messageType)
static void	setJTextPaneFont(JTextPane jtp, Font font, Color c) Utility method for setting the font and color of a JTextPane.
static void	setNodeExpandedState(JTree tree, DefaultMutableTreeNode node, boolean expanded)
static void	setToAskOnClose(JFrame window, String message, String title) Installs an event to the window that asks the user before the window is closes
static void	setToAskOnClose(JFrame window, Supplier<String> message, String title) Installs an event to the window that asks the user before the window is closes
static void	setTreeExpandedState(JTree tree, boolean expanded)
static void	showConnectionErrorMessage(Component parent, JIPipeDataSlot source, JIPipeDataSlot target)
static boolean	showOKCancelDialog(Component parent, Component component, String title) Shows a component in a JIPipe-styled dialog with OK and Cancel button

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_FILTER_CSV

public static final FileNameExtensionFilter EXTENSION_FILTER_CSV

EXTENSION_FILTER_TSV

public static final FileNameExtensionFilter EXTENSION_FILTER_TSV

EXTENSION_FILTER_XLSX

public static final FileNameExtensionFilter EXTENSION_FILTER_XLSX

EXTENSION_FILTER_PNG

public static final FileNameExtensionFilter EXTENSION_FILTER_PNG

EXTENSION_FILTER_IMAGEIO_IMAGES

public static final FileNameExtensionFilter EXTENSION_FILTER_IMAGEIO_IMAGES

EXTENSION_FILTER_SVG

public static final FileNameExtensionFilter EXTENSION_FILTER_SVG

EXTENSION_FILTER_MD

public static final FileNameExtensionFilter EXTENSION_FILTER_MD

EXTENSION_FILTER_PDF

public static final FileNameExtensionFilter EXTENSION_FILTER_PDF

EXTENSION_FILTER_HTML

public static final FileNameExtensionFilter EXTENSION_FILTER_HTML

EXTENSION_FILTER_JPEG

public static final FileNameExtensionFilter EXTENSION_FILTER_JPEG

EXTENSION_FILTER_BMP

public static final FileNameExtensionFilter EXTENSION_FILTER_BMP

EXTENSION_FILTER_TIFF

public static final FileNameExtensionFilter EXTENSION_FILTER_TIFF

EXTENSION_FILTER_JIP

public static final FileNameExtensionFilter EXTENSION_FILTER_JIP

EXTENSION_FILTER_JIPE

public static final FileNameExtensionFilter EXTENSION_FILTER_JIPE

EXTENSION_FILTER_JIPC

public static final FileNameExtensionFilter EXTENSION_FILTER_JIPC

EXTENSION_FILTER_JSON

public static final FileNameExtensionFilter EXTENSION_FILTER_JSON

EXTENSION_FILTER_TXT

public static final FileNameExtensionFilter EXTENSION_FILTER_TXT

EXTENSION_FILTER_ZIP

public static final FileNameExtensionFilter EXTENSION_FILTER_ZIP

EXTENSION_FILTER_ROI_ZIP

public static final FileNameExtensionFilter EXTENSION_FILTER_ROI_ZIP

EXTENSION_FILTER_ROI

public static final FileNameExtensionFilter EXTENSION_FILTER_ROI

EXTENSION_FILTER_ROIS

public static final FileNameExtensionFilter EXTENSION_FILTER_ROIS

EXTENSION_FILTER_AVI

public static final FileNameExtensionFilter EXTENSION_FILTER_AVI

UI_PADDING

public static final Insets UI_PADDING

ICON_FROM_RESOURCES_CACHE

public static final Map<String,ImageIcon> ICON_FROM_RESOURCES_CACHE

ICON_INVERTED_FROM_RESOURCES_CACHE

public static final Map<String,ImageIcon> ICON_INVERTED_FROM_RESOURCES_CACHE

DARK_THEME

public static boolean DARK_THEME

Constructor Detail

UIUtils

public UIUtils()

Method Detail

createInfoLabel

public static JLabel createInfoLabel(String text,
                                     String subtext)

registerHyperlinkHandler

public static void registerHyperlinkHandler(JTextPane content)

sendTrayNotification

public static void sendTrayNotification(String caption,
                                        String message,
                                        TrayIcon.MessageType messageType)

packDataTable

public static void packDataTable(org.jdesktop.swingx.JXTable table)

packAll() for a data table (with a limit)

Parameters:

table - the table

loadLookAndFeelFromSettings

public static void loadLookAndFeelFromSettings()

Attempts to override the look and feel based on the JIPipe settings

applyThemeToCodeEditor

public static void applyThemeToCodeEditor(org.fife.ui.rsyntaxtextarea.RSyntaxTextArea textArea)

getThemeFromRawSettings

public static JIPipeUITheme getThemeFromRawSettings()

getExtensionBuilderLogo400

public static BufferedImage getExtensionBuilderLogo400()

getLogo400

public static BufferedImage getLogo400()

getLogo

public static BufferedImage getLogo()

getHeaderPanelBackground

public static BufferedImage getHeaderPanelBackground()

addFillerGridBagComponent

public static void addFillerGridBagComponent(Container component,
                                             int row,
                                             int column)

Equivalent of Box.verticalGlue() for GridBagLayout

Parameters:

component - the target component that has GridBagLayout

row - the row

column - the column

addPopupMenuToComponent

public static JPopupMenu addPopupMenuToComponent(AbstractButton target)

Adds a popup menu to a button. Creates a new popup menu instance.

Parameters:

target - target button

Returns:

the popup menu

addPopupMenuToComponent

public static JPopupMenu addPopupMenuToComponent(AbstractButton target,
                                                 JPopupMenu popupMenu)

Adds an existing popup menu to a button

Parameters:

target - target button

popupMenu - the popup menu

Returns:

the popup menu

addReloadablePopupMenuToComponent

public static JPopupMenu addReloadablePopupMenuToComponent(AbstractButton target,
                                                           JPopupMenu popupMenu,
                                                           Runnable reloadFunction)

Adds an existing popup menu to a button Adds a function that is run before the popup is shown

Parameters:

target - target button

popupMenu - the popup menu

reloadFunction - the function that is run before showing the popup

Returns:

the popup menu

addReloadableRightClickPopupMenuToComponent

public static JPopupMenu addReloadableRightClickPopupMenuToComponent(AbstractButton target,
                                                                     JPopupMenu popupMenu,
                                                                     Runnable reloadFunction)

Adds an existing popup menu to a button Adds a function that is run before the popup is shown

Parameters:

target - target button

popupMenu - the popup menu

reloadFunction - the function that is run before showing the popup

Returns:

the popup menu

addRightClickPopupMenuToComponent

public static JPopupMenu addRightClickPopupMenuToComponent(AbstractButton target)

Adds an existing popup menu to a button Adds a function that is run before the popup is shown

Parameters:

target - target button

Returns:

the popup menu

addRightClickPopupMenuToComponent

public static JPopupMenu addRightClickPopupMenuToComponent(AbstractButton target,
                                                           JPopupMenu popupMenu)

Adds an existing popup menu to a button Adds a function that is run before the popup is shown

Parameters:

target - target button

Returns:

the popup menu

createVerticalSeparator

public static JSeparator createVerticalSeparator()

getIcon16FromResources

public static ImageIcon getIcon16FromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIconInvertedFromResources

public static ImageIcon getIconInvertedFromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIconInverted32FromResources

public static ImageIcon getIconInverted32FromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIconFromResources

public static ImageIcon getIconFromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIcon32FromResources

public static ImageIcon getIcon32FromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIcon64FromResources

public static ImageIcon getIcon64FromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIcon128FromResources

public static ImageIcon getIcon128FromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIcon8FromResources

public static ImageIcon getIcon8FromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIconURLFromResources

public static URL getIconURLFromResources(String iconName)

Returns an icon from JIPipe resources If you want to utilize resources from your Java extension, use JIPipeResourceManager

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIconFromColor

public static SolidColorIcon getIconFromColor(Color color)

Creates 16x16 a color icon

Parameters:

color - the color

Returns:

the icon

makeFlat

public static void makeFlat(AbstractButton component)

Makes a button flat

Parameters:

component - the button

makeFlat

public static void makeFlat(AbstractButton component,
                            Color borderColor,
                            int top,
                            int left,
                            int right,
                            int bottom)

Makes a button flat

Parameters:

component - the button

borderColor - border color

top - top border size

left - left border size

right - right border size

bottom - bottom border size

makeFlat25x25

public static void makeFlat25x25(AbstractButton component)

Makes a button flat and 25x25 size

Parameters:

component - the button

getAWTWindowTitle

public static String getAWTWindowTitle(Window window)

makeFlatH25

public static void makeFlatH25(AbstractButton component)

Makes a button flat and have a height of 25px

Parameters:

component - the button

makeBorderlessWithoutMargin

public static void makeBorderlessWithoutMargin(AbstractButton component)

Makes a component borderless

Parameters:

component - the component

setToAskOnClose

public static void setToAskOnClose(JFrame window,
                                   String message,
                                   String title)

Installs an event to the window that asks the user before the window is closes

Parameters:

window - the window

message - the close message

title - the close message title

setToAskOnClose

public static void setToAskOnClose(JFrame window,
                                   Supplier<String> message,
                                   String title)

Installs an event to the window that asks the user before the window is closes

Parameters:

window - the window

message - the close message

title - the close message title

expandAllTree

public static void expandAllTree(JTree tree)

Expands the whole tree

Parameters:

tree - the tree

createJLabel

public static JLabel createJLabel(String text,
                                  Icon icon)

createJLabel

public static JLabel createJLabel(String text,
                                  int fontSize)

createJLabel

public static JLabel createJLabel(String text,
                                  Icon icon,
                                  int fontSize)

askOpenInCurrentWindow

public static int askOpenInCurrentWindow(Component parent,
                                         String title)

Asks the user how to open a project: In the current window or a new window

Parameters:

parent - parent component

title - window title

Returns:

JOptionPane.YES_OPTION to open in this window; JOptionPane.NO_OPTION to open in a new window; JOptionPane.CANCEL_OPTION to cancel.

checkAndAskIfFileExists

public static boolean checkAndAskIfFileExists(Component parent,
                                              Path path,
                                              String title)

Checks if a file exists and asks the user if it should be overwritten

Parameters:

parent - the parent component

path - the path. can be null, will return false

title - the title

Returns:

true if the path is OK or the user confirmed, otherwise false

createStarRatingLabel

public static JLabel createStarRatingLabel(String title,
                                           double stars,
                                           int maximum)

Creates a read-only "star-rating" label

Parameters:

title - the label title

stars - the number of stars

maximum - the maximum number of stars

Returns:

the generated label

openErrorDialog

public static void openErrorDialog(Component parent,
                                   Exception exception)

Opens a dialog showing an exception

Parameters:

parent - the parent component

exception - the exception

openNotificationsDialog

public static void openNotificationsDialog(JIPipeWorkbench workbench,
                                           Component parent,
                                           JIPipeNotificationInbox notifications,
                                           String title,
                                           String infoText,
                                           boolean autoClose)

openValidityReportDialog

public static void openValidityReportDialog(Component parent,
                                            JIPipeIssueReport report,
                                            String title,
                                            String infoText,
                                            boolean modal)

Opens a dialog showing a validity report

Parameters:

parent - the parent component

report - the report

title - the title

infoText - the info text

modal - make the dialog modal

getSelectionByDialog

public static <T> List<T> getSelectionByDialog(Component parent,
                                               Collection<T> input,
                                               Collection<T> selected,
                                               String title,
                                               String message,
                                               ListCellRenderer<T> renderer,
                                               ListSelectionMode selectionMode)

Lets the user select one or multiple items from a list

Type Parameters:

T - type

Parameters:

parent - parent component

input - list of input objects

selected - pre-selected items

title - the title

message - the message (can be null to disable message)

renderer - the renderer for the items (null to use default renderer)

selectionMode - the selection mode

Returns:

selected items or empty list if none was selected

showOKCancelDialog

public static boolean showOKCancelDialog(Component parent,
                                         Component component,
                                         String title)

Shows a component in a JIPipe-styled dialog with OK and Cancel button

Parameters:

parent - the parent component

component - the component

title - the title

Returns:

true of OK was pressed

getHTMLByDialog

public static HTMLText getHTMLByDialog(JIPipeWorkbench workbench,
                                       Component parent,
                                       String title,
                                       String message,
                                       HTMLText initialValue)

Gets a formatted HTML string by dialog

Parameters:

workbench - the workbench

parent - the parent component

title - the title

message - message

initialValue - initial value

Returns:

value or null

getMultiLineStringByDialog

public static String getMultiLineStringByDialog(Component parent,
                                                String title,
                                                String message,
                                                String initialValue)

Gets a multiline string by dialog

Parameters:

parent - the parent component

title - the title

message - message

initialValue - initial value

Returns:

value or null

getIntegerByDialog

public static Optional<Integer> getIntegerByDialog(Component parent,
                                                   String title,
                                                   String message,
                                                   int initialValue,
                                                   int min,
                                                   int max)

Gets an integer by dialog

Parameters:

parent - parent component

title - title

message - message

initialValue - initial value

min - minimum value

max - maximum value

Returns:

the selected integer or null if cancelled

getDoubleByDialog

public static Optional<Double> getDoubleByDialog(Component parent,
                                                 String title,
                                                 String message,
                                                 double initialValue,
                                                 double min,
                                                 double max)

Gets an integer by dialog

Parameters:

parent - parent component

title - title

message - message

initialValue - initial value

min - minimum value

max - maximum value

Returns:

the selected double or null if cancelled

getUniqueStringByDialog

public static String getUniqueStringByDialog(Component parent,
                                             String message,
                                             String initialValue,
                                             Predicate<String> exists)

Continuously asks for an unique string

Parameters:

parent - parent component

message - the message

initialValue - the initial string

exists - function that returns true if the value exists

Returns:

unique string or null if canceled

getFillColorFor

public static Color getFillColorFor(JIPipeNodeInfo info)

Returns a fill color for JIPipeNodeInfo

Parameters:

info - the algorithm type

Returns:

the fill color

getBorderColorFor

public static Color getBorderColorFor(JIPipeNodeInfo info)

Returns a border color for JIPipeNodeInfo

Parameters:

info - the algorithm type

Returns:

the border color

makeToggleReadonly

public static void makeToggleReadonly(JToggleButton toggleButton)

Makes a toggle button readonly without greying it out

Parameters:

toggleButton - toggle button

makeReadonlyTextField

public static JTextField makeReadonlyTextField(String value)

Creates a readonly text field

Parameters:

value - text

Returns:

textfield

makeReadonlyTextArea

public static JTextArea makeReadonlyTextArea(String text)

Creates a readonly text area Cannot do HTML.

Parameters:

text - text

Returns:

text area

makeReadonlyTextPane

public static JTextPane makeReadonlyTextPane(String text)

Creates a readonly text pane (that can do HTML)

Parameters:

text - text

Returns:

text area

setJTextPaneFont

public static void setJTextPaneFont(JTextPane jtp,
                                    Font font,
                                    Color c)

Utility method for setting the font and color of a JTextPane. The result is roughly equivalent to calling setFont(...) and setForeground(...) on an AWT TextArea.

makeBorderlessReadonlyTextPane

public static JTextPane makeBorderlessReadonlyTextPane(String text,
                                                       boolean opaque)

Creates a readonly text pane (that can do HTML)

Parameters:

text - text

opaque - if the area should be opaque

Returns:

text area

makeReadonlyBorderlessTextField

public static JTextField makeReadonlyBorderlessTextField(String value)

Creates a readonly text field

Parameters:

value - text

Returns:

textfield

makeReadonlyBorderlessTextArea

public static JTextArea makeReadonlyBorderlessTextArea(String text)

Creates a readonly text area

Parameters:

text - text

Returns:

text area

makeMarkdownReader

public static JTextPane makeMarkdownReader(MarkdownDocument document,
                                           String[] css)

Creates a JTextPane that displays Markdown content

Parameters:

document - the markdown document

css - style sheets

Returns:

text pane

fitRowHeights

public static void fitRowHeights(JTable table)

Fits the row heights of a JTable

Parameters:

table - the table

createMenuTree

public static Map<String,JMenu> createMenuTree(JMenu rootMenu,
                                               Set<String> menuPaths)

Creates a hierarchy of menus based on the menu paths vector

Parameters:

rootMenu - the root menu

menuPaths - strings that have menu items separated by newlines

Returns:

map from menu path to submenu

addEscapeListener

public static void addEscapeListener(JDialog dialog)

Makes a JDialog close when the escape key is hit

Parameters:

dialog - the dialog

makeURLLabel

public static JLabel makeURLLabel(String url)

Makes a label that contains a URL and opens the URL when clicked

Parameters:

url - the URL

Returns:

the label

boxVertical

public static JPanel boxVertical(Component... components)

boxHorizontal

public static JPanel boxHorizontal(Component... components)

gridVertical

public static JPanel gridVertical(Component... components)

setTreeExpandedState

public static void setTreeExpandedState(JTree tree,
                                        boolean expanded)

setNodeExpandedState

public static void setNodeExpandedState(JTree tree,
                                        DefaultMutableTreeNode node,
                                        boolean expanded)

gridHorizontal

public static JPanel gridHorizontal(Component... components)

installMenuExtension

public static void installMenuExtension(JIPipeWorkbench workbench,
                                        JMenu targetMenu,
                                        JIPipeMenuExtensionTarget targetMenuType,
                                        boolean withSeparator)

Installs an extension menu

Parameters:

workbench - the workbench

targetMenu - the menu

targetMenuType - the menu type

withSeparator - if a separator should be prepended if items are installed

copyToClipboard

public static void copyToClipboard(String string)

Copies the string to the clipboard

Parameters:

string - the string

getStringFromClipboard

public static String getStringFromClipboard()

Returns a string from clipboard or an empty string

Returns:

clipboard string or empty

openWebsite

public static void openWebsite(String url)

Opens a website with given URL

Parameters:

url - the URL

openFileInNative

public static void openFileInNative(Path path)

Opens a website with given URL

Parameters:

path - the file

confirmResetParameters

public static boolean confirmResetParameters(JIPipeWorkbench parent,
                                             String title)

showConnectionErrorMessage

public static void showConnectionErrorMessage(Component parent,
                                              JIPipeDataSlot source,
                                              JIPipeDataSlot target)

invokeScrollToTop

public static void invokeScrollToTop(JScrollPane scrollPane)

redirectDragEvents

public static void redirectDragEvents(Component component,
                                      Component target)

createMenuItem

public static JMenuItem createMenuItem(String label,
                                       String description,
                                       Icon icon,
                                       Runnable action)