GuiUtils (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.snt.gui.GuiUtils

```
public class GuiUtils
extends Object
```
Misc. utilities for SNT's GUI.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class GuiUtils.JTextFieldFile

Nested Classes
Modifier and Type	Class and Description
`class`	`GuiUtils.JTextFieldFile`

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_MENU_WEIGHT` The default sorting weight for the Plugins>Neuroanatomy> submenu
`static String`	`LAF_DARCULA`
`static String`	`LAF_DARK`
`static String`	`LAF_DEFAULT`
`static String`	`LAF_LIGHT`
`static String`	`LAF_LIGHT_INTJ`

Constructor Summary

Constructors
Constructor and Description

GuiUtils()

GuiUtils(Component parent)

Constructors
Constructor and Description
`GuiUtils()`
`GuiUtils(Component parent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addSeparator(JComponent component, JLabel label, boolean vgap, GridBagConstraints c)`
`static void`	`addSeparator(JComponent component, String heading, boolean vgap, GridBagConstraints c)`
`void`	`addTooltip(JComponent c, String text)`
`static String[]`	`availableLookAndFeels()`
`void`	`blinkingError(JComponent blinkingComponent, String msg)`
`void`	`centeredMsg(String msg, String title)`
`void`	`centeredMsg(String msg, String title, String buttonLabel)`
`static void`	`closeSplashScreen()`
`static void`	`collapseAllTreeNodes(JTree tree)`
`static ImageIcon`	`createIcon(Color color, int width, int height)`
`static String`	`ctrlKey()`
`static GridBagConstraints`	`defaultGbc()`
`JDialog`	`dialog(String msg, JComponent component, String title)`
`static JSpinner`	`doubleSpinner(double value, double min, double max, double step, int nDecimals)`
`static void`	`enableComponents(Container container, boolean enable)`
`void`	`error(String msg)`
`void`	`error(String msg, String title)`
`void`	`error(String msg, String title, String helpURI)`
`static void`	`errorPrompt(String msg)`
`static void`	`expandAllTreeNodes(JTree tree)`
`static double`	`extractDouble(JTextField textfield)`
`JDialog`	`floatingMsg(String msg, boolean autodismiss)`
`static AbstractButton`	`getButton(Container parent, String label)`
`String`	`getChoice(String message, String title, String[] choices, String defaultChoice)`
`Color`	`getColor(String title, Color defaultValue)`
`Color`	`getColor(String title, Color defaultValue, String... panes)` Simplified color chooser.
`ColorRGB`	`getColorRGB(String title, Color defaultValue, String... panes)`
`boolean`	`getConfirmation(String msg, String title)`
`boolean`	`getConfirmation(String msg, String title, String yesLabel, String noLabel)`
`Boolean`	`getConfirmation2(String msg, String title, String yesLabel, String noLabel)`
`boolean[]`	`getConfirmationAndOption(String msg, String title, String checkboxLabel, boolean checkboxDefault)`
`static Color`	`getDisabledComponentColor()`
`static JFileChooser`	`getDnDFileChooser()`
`Double`	`getDouble(String promptMsg, String promptTitle, Number defaultValue)`
`static int`	`getMenuItemHeight()`
`static List<JMenuItem>`	`getMenuItems(JMenuBar menuBar)`
`static List<JMenuItem>`	`getMenuItems(JPopupMenu popupMenu)`
`List<String>`	`getMultipleChoices(String message, String title, String[] choices)`
`boolean[]`	`getOptions(String msg, String[] options, boolean[] defaults, String title)`
`boolean[]`	`getPersistentConfirmation(String msg, String title)`
`Boolean`	`getPersistentWarning(String msg, String title)`
`float[]`	`getRange(String promptMsg, String promptTitle, float[] defaultRange)`
`String`	`getString(String promptMsg, String promptTitle, String defaultValue)`
`static JMenu`	`helpMenu()`
`static void`	`initSplashScreen()`
`static JSpinner`	`integerSpinner(int value, int min, int max, int step, boolean allowEditing)`
`static boolean`	`isLegacy3DViewerAvailable()`
`static JLabel`	`leftAlignedLabel(String text, boolean enabled)`
`static JLabel`	`leftAlignedLabel(String text, String uri, boolean enabled)`
`static JMenuItem`	`menubarButton(IconFactory.GLYPH glyphIcon, JMenuBar menuBar)`
`static JMenuItem`	`menuItemTriggeringURL(String label, String URL)`
`static JMenuItem`	`menuItemWithoutAccelerator()`
`static String`	`micrometer()`
`static String`	`modKey()`
`static void`	`removeIcon(Window window)`
`static void`	`restoreLookAndFeel()`
`File`	`saveFile(String title, File file, List<String> allowedExtensions)`
`static String`	`scaledMicrometer(double umLength, int digits)` Returns a more human readable representation of a length in micrometers.
`static void`	`setAutoDismiss(JDialog dialog)`
`static void`	`setLookAndFeel()`
`static boolean`	`setLookAndFeel(String lookAndFeelName, boolean persistentChoice, Component... componentsToUpdate)`
`void`	`setTmpMsgTimeOut(int mseconds)`
`static JDialog`	`showAboutDialog()`
`static void`	`showHTMLDialog(String msg, String title)`
`JDialog`	`showHTMLDialog(String msg, String title, boolean modal)`
`static JButton`	`smallButton(String text)`
`void`	`tempMsg(String msg)`
`void`	`tempMsg(String msg, int location)`
`static JTextField`	`textField(String placeholder)`
`int`	`yesNoDialog(String msg, String title)`
`int`	`yesNoDialog(String msg, String title, String yesButtonLabel, String noButtonLabel)`
`DialogPrompt.Result`	`yesNoPrompt(String message, String title)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- LAF_LIGHT
```
public static final String LAF_LIGHT
```
  See Also:
  
  Constant Field Values
- LAF_LIGHT_INTJ
```
public static final String LAF_LIGHT_INTJ
```
  See Also:
  
  Constant Field Values
- LAF_DARK
```
public static final String LAF_DARK
```
  See Also:
  
  Constant Field Values
- LAF_DARCULA
```
public static final String LAF_DARCULA
```
  See Also:
  
  Constant Field Values
- LAF_DEFAULT
```
public static final String LAF_DEFAULT
```
  See Also:
  
  Constant Field Values
- DEFAULT_MENU_WEIGHT
```
public static final double DEFAULT_MENU_WEIGHT
```
  The default sorting weight for the Plugins>Neuroanatomy> submenu
  
  See Also:
  
  Constant Field Values

Constructor Detail

GuiUtils
```
public GuiUtils(Component parent)
```

GuiUtils
```
public GuiUtils()
```

Method Detail

error
```
public void error(String msg)
```

error

public void error(String msg,
                  String title)

floatingMsg

public JDialog floatingMsg(String msg,
                           boolean autodismiss)

tempMsg
```
public void tempMsg(String msg)
```

tempMsg

public void tempMsg(String msg,
                    int location)

showHTMLDialog

public static void showHTMLDialog(String msg,
                                  String title)

isLegacy3DViewerAvailable

public static boolean isLegacy3DViewerAvailable()

setTmpMsgTimeOut

public void setTmpMsgTimeOut(int mseconds)

yesNoDialog

public int yesNoDialog(String msg,
                       String title,
                       String yesButtonLabel,
                       String noButtonLabel)

yesNoDialog

public int yesNoDialog(String msg,
                       String title)

yesNoPrompt

public DialogPrompt.Result yesNoPrompt(String message,
                                       String title)

getConfirmation

public boolean getConfirmation(String msg,
                               String title)

error

public void error(String msg,
                  String title,
                  String helpURI)

getConfirmation

public boolean getConfirmation(String msg,
                               String title,
                               String yesLabel,
                               String noLabel)

getConfirmation2

public Boolean getConfirmation2(String msg,
                                String title,
                                String yesLabel,
                                String noLabel)

getChoice

public String getChoice(String message,
                        String title,
                        String[] choices,
                        String defaultChoice)

getMultipleChoices

public List<String> getMultipleChoices(String message,
                                       String title,
                                       String[] choices)

getPersistentConfirmation

public boolean[] getPersistentConfirmation(String msg,
                                           String title)

getConfirmationAndOption

public boolean[] getConfirmationAndOption(String msg,
                                          String title,
                                          String checkboxLabel,
                                          boolean checkboxDefault)

getPersistentWarning

public Boolean getPersistentWarning(String msg,
                                    String title)

getString

public String getString(String promptMsg,
                        String promptTitle,
                        String defaultValue)

getColor

public Color getColor(String title,
                      Color defaultValue)

getColorRGB

public ColorRGB getColorRGB(String title,
                            Color defaultValue,
                            String... panes)

getColor
```
public Color getColor(String title,
                      Color defaultValue,
                      String... panes)
```
Simplified color chooser.

Parameters:

title - the title of the chooser dialog

defaultValue - the initial color set in the chooser

panes - the panes a list of strings specifying which tabs should be displayed. In most platforms this includes: "Swatches", "HSB" and "RGB". Note that e.g., the GTK L&F may only include the default GtkColorChooser pane

Returns:

the color

getDouble

public Double getDouble(String promptMsg,
                        String promptTitle,
                        Number defaultValue)

getRange

public float[] getRange(String promptMsg,
                        String promptTitle,
                        float[] defaultRange)

saveFile

public File saveFile(String title,
                     File file,
                     List<String> allowedExtensions)

centeredMsg

public void centeredMsg(String msg,
                        String title)

centeredMsg

public void centeredMsg(String msg,
                        String title,
                        String buttonLabel)

dialog

public JDialog dialog(String msg,
                      JComponent component,
                      String title)

getOptions

public boolean[] getOptions(String msg,
                            String[] options,
                            boolean[] defaults,
                            String title)

addTooltip

public void addTooltip(JComponent c,
                       String text)

blinkingError

public void blinkingError(JComponent blinkingComponent,
                          String msg)

showAboutDialog

public static JDialog showAboutDialog()

initSplashScreen
```
public static void initSplashScreen()
```

closeSplashScreen

public static void closeSplashScreen()

collapseAllTreeNodes

public static void collapseAllTreeNodes(JTree tree)

expandAllTreeNodes

public static void expandAllTreeNodes(JTree tree)

addSeparator

public static void addSeparator(JComponent component,
                                String heading,
                                boolean vgap,
                                GridBagConstraints c)

addSeparator

public static void addSeparator(JComponent component,
                                JLabel label,
                                boolean vgap,
                                GridBagConstraints c)

menubarButton

public static JMenuItem menubarButton(IconFactory.GLYPH glyphIcon,
                                      JMenuBar menuBar)

leftAlignedLabel

public static JLabel leftAlignedLabel(String text,
                                      boolean enabled)

leftAlignedLabel

public static JLabel leftAlignedLabel(String text,
                                      String uri,
                                      boolean enabled)

createIcon

public static ImageIcon createIcon(Color color,
                                   int width,
                                   int height)

getMenuItemHeight
```
public static int getMenuItemHeight()
```

menuItemWithoutAccelerator

public static JMenuItem menuItemWithoutAccelerator()

ctrlKey
```
public static String ctrlKey()
```

modKey
```
public static String modKey()
```

defaultGbc

public static GridBagConstraints defaultGbc()

getMenuItems

public static List<JMenuItem> getMenuItems(JMenuBar menuBar)

getMenuItems

public static List<JMenuItem> getMenuItems(JPopupMenu popupMenu)

textField

public static JTextField textField(String placeholder)

removeIcon

public static void removeIcon(Window window)

helpMenu
```
public static JMenu helpMenu()
```

menuItemTriggeringURL

public static JMenuItem menuItemTriggeringURL(String label,
                                              String URL)

getDisabledComponentColor

public static Color getDisabledComponentColor()

smallButton

public static JButton smallButton(String text)

integerSpinner

public static JSpinner integerSpinner(int value,
                                      int min,
                                      int max,
                                      int step,
                                      boolean allowEditing)

doubleSpinner

public static JSpinner doubleSpinner(double value,
                                     double min,
                                     double max,
                                     double step,
                                     int nDecimals)

extractDouble

public static double extractDouble(JTextField textfield)

enableComponents

public static void enableComponents(Container container,
                                    boolean enable)

micrometer
```
public static String micrometer()
```

scaledMicrometer
```
public static String scaledMicrometer(double umLength,
                                      int digits)
```
Returns a more human readable representation of a length in micrometers.
E.g., scaledMicrometer(0.01,1) returns "1.0nm"

Parameters:

umLength - the length in micrometers

digits - the number of output decimals

Returns:

the scaled unit

errorPrompt

public static void errorPrompt(String msg)

availableLookAndFeels

public static String[] availableLookAndFeels()

setLookAndFeel
```
public static void setLookAndFeel()
```

getButton

public static AbstractButton getButton(Container parent,
                                       String label)

getDnDFileChooser

public static JFileChooser getDnDFileChooser()

restoreLookAndFeel

public static void restoreLookAndFeel()

setLookAndFeel

public static boolean setLookAndFeel(String lookAndFeelName,
                                     boolean persistentChoice,
                                     Component... componentsToUpdate)

setAutoDismiss

public static void setAutoDismiss(JDialog dialog)

showHTMLDialog

public JDialog showHTMLDialog(String msg,
                              String title,
                              boolean modal)

Class GuiUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LAF_LIGHT

LAF_LIGHT_INTJ

LAF_DARK

LAF_DARCULA

LAF_DEFAULT

DEFAULT_MENU_WEIGHT

Constructor Detail

GuiUtils

GuiUtils

Method Detail

error

error

floatingMsg

tempMsg

tempMsg

showHTMLDialog

isLegacy3DViewerAvailable

setTmpMsgTimeOut

yesNoDialog

yesNoDialog

yesNoPrompt

getConfirmation

error

getConfirmation

getConfirmation2

getChoice

getMultipleChoices

getPersistentConfirmation

getConfirmationAndOption

getPersistentWarning

getString

getColor

getColorRGB

getColor

getDouble

getRange

saveFile

centeredMsg

centeredMsg

dialog

getOptions

addTooltip

blinkingError

showAboutDialog

initSplashScreen

closeSplashScreen

collapseAllTreeNodes

expandAllTreeNodes

addSeparator

addSeparator

menubarButton

leftAlignedLabel

leftAlignedLabel

createIcon

getMenuItemHeight

menuItemWithoutAccelerator

ctrlKey

modKey

defaultGbc

getMenuItems

getMenuItems

textField

removeIcon

helpMenu

menuItemTriggeringURL

getDisabledComponentColor

smallButton

integerSpinner

doubleSpinner

extractDouble

enableComponents

micrometer

scaledMicrometer