Toolkit

Object
- Toolkit

```
public class Toolkit
extends Object
```
Utility functions for base that require a java.awt.Toolkit object. These are broken out from Base as we start moving toward the possibility of the code running in headless mode.

Field Summary

Fields
Modifier and Type Field and Description

static int BORDER

static KeyStroke WINDOW_CLOSE_KEYSTROKE
Command-W on Mac OS X, Ctrl-W on Windows and Linux

Fields
Modifier and Type	Field and Description
`static int`	`BORDER`
`static KeyStroke`	`WINDOW_CLOSE_KEYSTROKE` Command-W on Mac OS X, Ctrl-W on Windows and Linux

Constructor Summary

Constructors
Constructor and Description

Toolkit()

Constructors
Constructor and Description
`Toolkit()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addDisabledItem(JMenu menu, String title)`
`static void`	`beep()`
`static JButton`	`createIconButton(String base)` Same as above, but with no text title (follows JButton constructor)
`static JButton`	`createIconButton(String title, Icon icon)`
`static JButton`	`createIconButton(String title, String base)` Create a JButton with an icon, and set its disabled and pressed images to be the same image, so that 2x versions of the icon work properly.
`static Shape`	`createRoundRect(float x1, float y1, float x2, float y2, float tl, float tr, float br, float bl)`
`static double`	`getAscent(Graphics g)` Synthesized replacement for FontMetrics.getAscent(), which is dreadfully inaccurate and inconsistent across platforms.
`static int`	`getButtonWidth()` Standardized width for buttons.
`static ImageIcon`	`getIconX(File dir, String base)`
`static ImageIcon`	`getIconX(File dir, String base, int size)` Get an icon of the format base-NN.png where NN is the size, but if it's a hidpi display, get the NN*2 version automatically, sized at NN
`static KeyStroke`	`getKeyStrokeExt(String base)` Return the correct KeyStroke per locale and platform.
`static ImageIcon`	`getLibIcon(String filename)` Get an ImageIcon from the Processing 'lib' folder.
`static ImageIcon`	`getLibIconX(String base)` Get an image icon with hi-dpi support.
`static ImageIcon`	`getLibIconX(String base, int size)`
`static Image`	`getLibImage(String filename)` Return an Image object from inside the Processing 'lib' folder.
`static int`	`getMenuItemIndex(JMenu menu, JMenuItem item)`
`static Font`	`getMonoFont(int size, int style)`
`static String[]`	`getMonoFontFamilies()`
`static String`	`getMonoFontName()`
`static Font`	`getSansFont(int size, int style)`
`static String`	`getSansFontName()`
`static Dimension`	`getScreenSize()`
`static Clipboard`	`getSystemClipboard()`
`static boolean`	`highResImages()`
`static boolean`	`isRetina()`
`static JCheckBoxMenuItem`	`newJCheckBoxMenuItem(String title, int what)`
`static JMenuItem`	`newJMenuItem(Action action, int what)`
`static JMenuItem`	`newJMenuItem(String title, int what)` A software engineer, somewhere, needs to have their abstraction taken away.
`static JMenuItem`	`newJMenuItemAlt(String title, int what)` Same as newJMenuItem(), but adds the ALT (on Linux and Windows) or OPTION (on Mac OS X) key as a modifier.
`static JMenuItem`	`newJMenuItemExt(String base)` Create a menu item and set its KeyStroke by name (so it can be stored in the language settings or the preferences.
`static JMenuItem`	`newJMenuItemShift(Action action, int what)` Like newJMenuItem() but adds shift as a modifier for the shortcut.
`static JMenuItem`	`newJMenuItemShift(String title, int what)` Like newJMenuItem() but adds shift as a modifier for the shortcut.
`static Image`	`offscreenGraphics(Component comp, int width, int height)` Create an Image to be used as an offscreen drawing context, automatically doubling the size if running on a retina display.
`static Graphics2D`	`prepareGraphics(Graphics g)` Handles scaling for high-res displays, also sets text anti-aliasing options to be far less ugly than the defaults.
`static void`	`registerWindowCloseKeys(JRootPane root, ActionListener disposer)` Registers key events for a Ctrl-W and ESC with an ActionListener that will take care of disposing the window.
`static void`	`setBorder(JComponent comp)`
`static void`	`setBorder(JComponent comp, int top, int left, int bottom, int right)`
`static void`	`setIcon(Frame frame)`
`static void`	`setIcon(Window window)` Give this Frame the Processing icon set.
`static void`	`setMenuMnemonics(JMenuBar menubar)` As setMenuMnemonics(JMenuItem...).
`static void`	`setMenuMnemonics(JMenuItem... menu)` Removes all mnemonics, then sets a mnemonic for each menu and menu item recursively by these rules: It tries to assign one of KDE's defaults. Failing that, it loops through the first letter of each word, where a word is a block of Unicode "alphabetical" chars, looking for an upper-case ASCII mnemonic that is not taken.
`static void`	`setMenuMnemonics(JPopupMenu menu)` As setMenuMnemonics(JMenuItem...).
`static void`	`setMenuMnemsInside(JMenu menu)` Calls setMenuMnemonics(JMenuItem...) on the sub-elements only.
`static int`	`zoom(int pixels)`
`static Dimension`	`zoom(int w, int h)`

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WINDOW_CLOSE_KEYSTROKE
```
public static final KeyStroke WINDOW_CLOSE_KEYSTROKE
```
    Command-W on Mac OS X, Ctrl-W on Windows and Linux
  - BORDER
```
public static final int BORDER
```
- Constructor Detail
  - Toolkit
```
public Toolkit()
```
- Method Detail
  - getButtonWidth
```
public static int getButtonWidth()
```
    Standardized width for buttons. Mac OS X 10.3 wants 70 as its default, Windows XP needs 66, and my Ubuntu machine needs 80+, so 80 seems proper. This is now stored in the languages file since this may need to be larger for languages that are consistently wider than English.
  - getKeyStrokeExt
```
public static KeyStroke getKeyStrokeExt(String base)
```
    Return the correct KeyStroke per locale and platform. Also checks for any additional overrides in preferences.txt.
    
    Parameters:
    
    base - the localization key for the menu item (.keystroke and .platform will be added to the end)
    
    Returns:
    
    KeyStroke for base + .keystroke + .platform (or the value from preferences) or null if none found
  - newJMenuItemExt
```
public static JMenuItem newJMenuItemExt(String base)
```
    Create a menu item and set its KeyStroke by name (so it can be stored in the language settings or the preferences. Syntax is here: https://docs.oracle.com/javase/8/docs/api/javax/swing/KeyStroke.html#getKeyStroke-java.lang.String-
    
    Parameters:
    
    sequence - the name, as outlined by the KeyStroke API
    
    fallback - what to use if getKeyStroke() comes back null
  - newJMenuItem
```
public static JMenuItem newJMenuItem(String title,
                                     int what)
```
    A software engineer, somewhere, needs to have their abstraction taken away. Who crafts the sort of API that would require a five-line helper function just to set the shortcut key for a menu item?
  - newJMenuItem
```
public static JMenuItem newJMenuItem(Action action,
                                     int what)
```
    Parameters:
    
    action: - use an Action, which sets the title, reaction and enabled-ness all by itself.
  - newJMenuItemShift
```
public static JMenuItem newJMenuItemShift(String title,
                                          int what)
```
    Like newJMenuItem() but adds shift as a modifier for the shortcut.
  - newJMenuItemShift
```
public static JMenuItem newJMenuItemShift(Action action,
                                          int what)
```
    Like newJMenuItem() but adds shift as a modifier for the shortcut.
  - newJMenuItemAlt
```
public static JMenuItem newJMenuItemAlt(String title,
                                        int what)
```
    Same as newJMenuItem(), but adds the ALT (on Linux and Windows) or OPTION (on Mac OS X) key as a modifier. This function should almost never be used, because it's bad for non-US keyboards that use ALT in strange and wondrous ways.
  - newJCheckBoxMenuItem
```
public static JCheckBoxMenuItem newJCheckBoxMenuItem(String title,
                                                     int what)
```
  - addDisabledItem
```
public static void addDisabledItem(JMenu menu,
                                   String title)
```
  - setMenuMnemonics
```
public static void setMenuMnemonics(JMenuItem... menu)
```
    Removes all mnemonics, then sets a mnemonic for each menu and menu item recursively by these rules:
    1. It tries to assign one of KDE's defaults.
    2. Failing that, it loops through the first letter of each word, where a word is a block of Unicode "alphabetical" chars, looking for an upper-case ASCII mnemonic that is not taken. This is to try to be relevant, by using a letter well-associated with the command. (MS guidelines)
    3. Ditto, but with lowercase.
    4. Next, it tries the second ASCII character, if its width >= half the width of 'A'.
    5. If the first letters are all taken/non-ASCII, then it loops through the ASCII letters in the item, widest to narrowest, seeing if any of them is not taken. To improve readability, it discriminates against decenders (qypgj), imagining they have 2/3 their actual width. (MS guidelines: avoid decenders). It also discriminates against vowels, imagining they have 2/3 their actual width. (MS and Gnome guidelines: avoid vowels.)
    6. Failing that, it will loop left-to-right for an available digit. This is a last resort because the normal setMnemonic dislikes them.
    7. If that doesn't work, it doesn't assign a mnemonic.
    As a special case, strings starting "sketchbook → " have that bit ignored because otherwise the Recent menu looks awful. However, the name "sketchbook → Sketch", for example, will have the 'S' of "Sketch" chosen, but the 's' of 'sketchbook will get underlined. No letter by an underscore will be assigned. Disabled on Mac, per Apple guidelines. menu may contain nulls. Author: George Bateman. Initial work Myer Nore.
    Parameters:
    
    menu - A menu, a list of menus or an array of menu items to set mnemonics for.
  - setMenuMnemonics
```
public static void setMenuMnemonics(JMenuBar menubar)
```
    As setMenuMnemonics(JMenuItem...).
  - setMenuMnemonics
```
public static void setMenuMnemonics(JPopupMenu menu)
```
    As setMenuMnemonics(JMenuItem...).
  - setMenuMnemsInside
```
public static void setMenuMnemsInside(JMenu menu)
```
    Calls setMenuMnemonics(JMenuItem...) on the sub-elements only.
  - getScreenSize
```
public static Dimension getScreenSize()
```
  - getLibImage
```
public static Image getLibImage(String filename)
```
    Return an Image object from inside the Processing 'lib' folder. Moved here so that Base can stay headless.
  - getLibIcon
```
public static ImageIcon getLibIcon(String filename)
```
    Get an ImageIcon from the Processing 'lib' folder.
    
    Since:
    
    3.0a6
  - getIconX
```
public static ImageIcon getIconX(File dir,
                                 String base)
```
  - getIconX
```
public static ImageIcon getIconX(File dir,
                                 String base,
                                 int size)
```
    Get an icon of the format base-NN.png where NN is the size, but if it's a hidpi display, get the NN*2 version automatically, sized at NN
  - getLibIconX
```
public static ImageIcon getLibIconX(String base)
```
    Get an image icon with hi-dpi support. Pulls 1x or 2x versions of the file depending on the display type, but sizes them based on 1x.
  - getLibIconX
```
public static ImageIcon getLibIconX(String base,
                                    int size)
```
  - createIconButton
```
public static JButton createIconButton(String title,
                                       String base)
```
    Create a JButton with an icon, and set its disabled and pressed images to be the same image, so that 2x versions of the icon work properly.
  - createIconButton
```
public static JButton createIconButton(String base)
```
    Same as above, but with no text title (follows JButton constructor)
  - createIconButton
```
public static JButton createIconButton(String title,
                                       Icon icon)
```
  - setIcon
```
public static void setIcon(Frame frame)
```
  - setIcon
```
public static void setIcon(Window window)
```
    Give this Frame the Processing icon set. Ignored on OS X, because they thought different and made this function set the minified image of the window, not the window icon for the dock or cmd-tab.
  - createRoundRect
```
public static Shape createRoundRect(float x1,
                                    float y1,
                                    float x2,
                                    float y2,
                                    float tl,
                                    float tr,
                                    float br,
                                    float bl)
```
  - registerWindowCloseKeys
```
public static void registerWindowCloseKeys(JRootPane root,
                                           ActionListener disposer)
```
    Registers key events for a Ctrl-W and ESC with an ActionListener that will take care of disposing the window.
  - beep
```
public static void beep()
```
  - getSystemClipboard
```
public static Clipboard getSystemClipboard()
```
  - offscreenGraphics
```
public static Image offscreenGraphics(Component comp,
                                      int width,
                                      int height)
```
    Create an Image to be used as an offscreen drawing context, automatically doubling the size if running on a retina display.
  - prepareGraphics
```
public static Graphics2D prepareGraphics(Graphics g)
```
    Handles scaling for high-res displays, also sets text anti-aliasing options to be far less ugly than the defaults. Moved to a utility function because it's used in several classes.
    
    Returns:
    
    a Graphics2D object, as a bit o sugar
  - zoom
```
public static int zoom(int pixels)
```
  - zoom
```
public static Dimension zoom(int w,
                             int h)
```
  - setBorder
```
public static void setBorder(JComponent comp)
```
  - setBorder
```
public static void setBorder(JComponent comp,
                             int top,
                             int left,
                             int bottom,
                             int right)
```
  - highResImages
```
public static boolean highResImages()
```
  - isRetina
```
public static boolean isRetina()
```
  - getMonoFontFamilies
```
public static String[] getMonoFontFamilies()
```
  - getMonoFontName
```
public static String getMonoFontName()
```
  - getMonoFont
```
public static Font getMonoFont(int size,
                               int style)
```
  - getSansFontName
```
public static String getSansFontName()
```
  - getSansFont
```
public static Font getSansFont(int size,
                               int style)
```
  - getAscent
```
public static double getAscent(Graphics g)
```
    Synthesized replacement for FontMetrics.getAscent(), which is dreadfully inaccurate and inconsistent across platforms.
  - getMenuItemIndex
```
public static int getMenuItemIndex(JMenu menu,
                                   JMenuItem item)
```

Class Toolkit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

WINDOW_CLOSE_KEYSTROKE

BORDER

Constructor Detail

Toolkit

Method Detail

getButtonWidth

getKeyStrokeExt

newJMenuItemExt

newJMenuItem

newJMenuItem

newJMenuItemShift

newJMenuItemShift

newJMenuItemAlt

newJCheckBoxMenuItem

addDisabledItem

setMenuMnemonics

setMenuMnemonics

setMenuMnemonics

setMenuMnemsInside

getScreenSize

getLibImage

getLibIcon

getIconX

getIconX

getLibIconX

getLibIconX

createIconButton

createIconButton

createIconButton

setIcon

setIcon

createRoundRect

registerWindowCloseKeys

beep

getSystemClipboard

offscreenGraphics

prepareGraphics

zoom

zoom

setBorder

setBorder

highResImages

isRetina

getMonoFontFamilies

getMonoFontName

getMonoFont

getSansFontName

getSansFont

getAscent

getMenuItemIndex