org.gjt.sp.jedit
Class GUIUtilities

java.lang.Object
  org.gjt.sp.jedit.GUIUtilities

public class GUIUtilities
extends java.lang.Object

Various GUI functions.

The most frequently used members of this class are:

• loadIcon(String)
• confirm(Component,String,Object[],int,int)
• error(Component,String,Object[])
• message(Component,String,Object[])
• showPopupMenu(JPopupMenu,Component,int,int)
• showVFSFileDialog(View,String,int,boolean)
• loadGeometry(Window,String)
• saveGeometry(Window,String)

Field Summary

static javax.swing.Icon	DIRTY_BUFFER_ICON Deprecated. Use GUIUtilities.loadIcon("dirty.gif"); instead.
static javax.swing.Icon	NEW_BUFFER_ICON Deprecated. Use GUIUtilities.loadIcon("new.gif"); instead.
static javax.swing.Icon	NORMAL_BUFFER_ICON Deprecated. Use GUIUtilities.loadIcon("normal.gif"); instead.
static javax.swing.Icon	READ_ONLY_BUFFER_ICON Deprecated. Use GUIUtilities.loadIcon("readonly.gif"); instead.
static javax.swing.Icon	WINDOW_ICON Deprecated. Use GUIUtilities.loadIcon("jedit-icon.gif"); instead.

Method Summary

static void	adjustForScreenBounds(java.awt.Rectangle desired) Gives a rectangle the specified bounds, ensuring it is within the screen bounds.
static void	centerOnScreen(java.awt.Window win) Centers the given window on the screen.
static int	confirm(java.awt.Component comp, java.lang.String name, java.lang.Object[] args, int buttons, int type) Displays a confirm dialog box and returns the button pushed by the user.
static javax.swing.JComponent	createMultilineLabel(java.lang.String str) Creates a component that displays a multiple line message.
static void	error(java.awt.Component comp, java.lang.String name, java.lang.Object[] args) Displays an error dialog box.
static java.lang.String	getColorHexString(java.awt.Color c) Converts a color object to its hex value.
static java.awt.Component	getComponentParent(java.awt.Component comp, java.lang.Class clazz) Finds a parent of the specified component.
static java.awt.Image	getEditorIcon() Returns the default editor window image.
static javax.swing.JDialog	getParentDialog(java.awt.Component c) Traverses the given component's parent tree looking for an instance of JDialog, and return it.
static java.awt.Image	getPluginIcon() Returns the default plugin window image.
static java.lang.String	getStyleString(SyntaxStyle style) Converts a style into it's string representation.
static View	getView(java.awt.Component comp) Finds the view parent of the specified component.
static void	hideSplashScreen() Ensures that the splash screen is not visible.
static java.lang.String	input(java.awt.Component comp, java.lang.String name, java.lang.Object def) Displays an input dialog box and returns any text the user entered.
static java.lang.String	input(java.awt.Component comp, java.lang.String name, java.lang.Object[] args, java.lang.Object def) Displays an input dialog box and returns any text the user entered.
static java.lang.String	inputProperty(java.awt.Component comp, java.lang.String name, java.lang.Object[] args, java.lang.String def) Displays an input dialog box and returns any text the user entered.
static java.lang.String	inputProperty(java.awt.Component comp, java.lang.String name, java.lang.String def) Displays an input dialog box and returns any text the user entered.
static boolean	isAncestorOf(java.awt.Component comp1, java.awt.Component comp2) Returns if the first component is an ancestor of the second by traversing up the component hierarchy.
static boolean	isMiddleButton(int modifiers)
static boolean	isPopupTrigger(java.awt.event.MouseEvent evt) Returns if the specified event is the popup trigger event.
static boolean	isRightButton(int modifiers)
static int	listConfirm(java.awt.Component comp, java.lang.String name, java.lang.String[] args, java.lang.Object[] listModel) Displays a confirm dialog box and returns the button pushed by the user.
static void	loadGeometry(java.awt.Window win, java.lang.String name) Loads a windows's geometry from the properties.
static javax.swing.Icon	loadIcon(java.lang.String iconName) Loads an icon.
static javax.swing.JMenu	loadMenu(ActionContext context, java.lang.String name) Creates a menu.
static javax.swing.JMenu	loadMenu(java.lang.String name) Creates a menu.
static javax.swing.JMenuBar	loadMenuBar(ActionContext context, java.lang.String name) Creates a menubar.
static javax.swing.JMenuBar	loadMenuBar(java.lang.String name) Creates a menubar.
static javax.swing.JMenuItem	loadMenuItem(ActionContext context, java.lang.String name, boolean setMnemonic) Creates a menu item.
static javax.swing.JMenuItem	loadMenuItem(java.lang.String name) Creates a menu item.
static javax.swing.JMenuItem	loadMenuItem(java.lang.String name, boolean setMnemonic) Creates a menu item.
static javax.swing.JPopupMenu	loadPopupMenu(ActionContext context, java.lang.String name) Creates a popup menu.
static javax.swing.JPopupMenu	loadPopupMenu(java.lang.String name) Creates a popup menu.
static SyntaxStyle[]	loadStyles(java.lang.String family, int size) Loads the syntax styles from the properties, giving them the specified base font family and size.
static SyntaxStyle[]	loadStyles(java.lang.String family, int size, boolean color) Loads the syntax styles from the properties, giving them the specified base font family and size.
static javax.swing.Box	loadToolBar(ActionContext context, java.lang.String name) Creates a toolbar.
static javax.swing.Box	loadToolBar(java.lang.String name) Creates a toolbar.
static EnhancedButton	loadToolButton(ActionContext context, java.lang.String name) Loads a tool bar button.
static EnhancedButton	loadToolButton(java.lang.String name) Loads a tool bar button.
static void	message(java.awt.Component comp, java.lang.String name, java.lang.Object[] args) Displays a dialog box.
static java.awt.Color	parseColor(java.lang.String name) Converts a color name to a color object.
static java.awt.Color	parseColor(java.lang.String name, java.awt.Color defaultColor)
static SyntaxStyle	parseStyle(java.lang.String str, java.lang.String family, int size) Converts a style string to a style object.
static SyntaxStyle	parseStyle(java.lang.String str, java.lang.String family, int size, boolean color) Converts a style string to a style object.
static java.lang.String	prettifyMenuLabel(java.lang.String label) `Prettifies' a menu item label by removing the `$' sign.
static void	requestFocus(java.awt.Window win, java.awt.Component comp) Focuses on the specified component as soon as the window becomes active.
static void	saveGeometry(java.awt.Window win, java.lang.String name) Saves a window's geometry to the properties.
static void	setIconPath(java.lang.String iconPath) Sets the path where jEdit looks for icons.
static void	showPopupMenu(javax.swing.JPopupMenu popup, java.awt.Component comp, int x, int y) Shows the specified popup menu, ensuring it is displayed within the bounds of the screen.
static void	showPopupMenu(javax.swing.JPopupMenu popup, java.awt.Component comp, int x, int y, boolean point) Shows the specified popup menu, ensuring it is displayed within the bounds of the screen.
static java.lang.String[]	showVFSFileDialog(View view, java.lang.String path, int type, boolean multipleSelection) Displays a VFS file selection dialog box.

Methods inherited from class java.lang.Object

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

Field Detail

NEW_BUFFER_ICON

public static javax.swing.Icon NEW_BUFFER_ICON

Deprecated. Use GUIUtilities.loadIcon("new.gif"); instead.

DIRTY_BUFFER_ICON

public static javax.swing.Icon DIRTY_BUFFER_ICON

Deprecated. Use GUIUtilities.loadIcon("dirty.gif"); instead.

READ_ONLY_BUFFER_ICON

public static javax.swing.Icon READ_ONLY_BUFFER_ICON

Deprecated. Use GUIUtilities.loadIcon("readonly.gif"); instead.

NORMAL_BUFFER_ICON

public static javax.swing.Icon NORMAL_BUFFER_ICON

Deprecated. Use GUIUtilities.loadIcon("normal.gif"); instead.

WINDOW_ICON

public static javax.swing.Icon WINDOW_ICON

Deprecated. Use GUIUtilities.loadIcon("jedit-icon.gif"); instead.

Method Detail

setIconPath

public static void setIconPath(java.lang.String iconPath)

Sets the path where jEdit looks for icons.

Since:

jEdit 4.2pre5

loadIcon

public static javax.swing.Icon loadIcon(java.lang.String iconName)

Loads an icon.

Parameters:

iconName - The icon name

Since:

jEdit 2.6pre7

getEditorIcon

public static java.awt.Image getEditorIcon()

Returns the default editor window image.

getPluginIcon

public static java.awt.Image getPluginIcon()

Returns the default plugin window image.

loadMenuBar

public static javax.swing.JMenuBar loadMenuBar(java.lang.String name)

Creates a menubar. Plugins should not need to call this method.

Parameters:

name - The menu bar name

Since:

jEdit 3.2pre5

loadMenuBar

public static javax.swing.JMenuBar loadMenuBar(ActionContext context,
                                               java.lang.String name)

Creates a menubar. Plugins should not need to call this method.

Parameters:

context - An action context

name - The menu bar name

Since:

jEdit 4.2pre1

loadMenu

public static javax.swing.JMenu loadMenu(java.lang.String name)

Creates a menu. The menu label is set from the name.label property. The menu contents is taken from the name property, which is a whitespace separated list of action names. An action name of - inserts a separator in the menu.

Parameters:

name - The menu name

Since:

jEdit 2.6pre2

See Also:

loadMenuItem(String)

loadMenu

public static javax.swing.JMenu loadMenu(ActionContext context,
                                         java.lang.String name)

Creates a menu. The menu label is set from the name.label property. The menu contents is taken from the name property, which is a whitespace separated list of action names. An action name of - inserts a separator in the menu.

Parameters:

context - An action context; either jEdit.getActionContext() or VFSBrowser.getActionContext().

name - The menu name

Since:

jEdit 4.2pre1

See Also:

loadMenuItem(String)

loadPopupMenu

public static javax.swing.JPopupMenu loadPopupMenu(java.lang.String name)

Creates a popup menu.

Parameters:

name - The menu name

Since:

jEdit 2.6pre2

loadPopupMenu

public static javax.swing.JPopupMenu loadPopupMenu(ActionContext context,
                                                   java.lang.String name)

Creates a popup menu.

Parameters:

context - An action context; either jEdit.getActionContext() or VFSBrowser.getActionContext().

name - The menu name

Since:

jEdit 4.2pre1

loadMenuItem

public static javax.swing.JMenuItem loadMenuItem(java.lang.String name)

Creates a menu item. The menu item is bound to the action named by name with label taken from the return value of the EditAction.getLabel() method.

Parameters:

name - The menu item name

Since:

jEdit 2.6pre1

See Also:

loadMenu(String)

loadMenuItem

public static javax.swing.JMenuItem loadMenuItem(java.lang.String name,
                                                 boolean setMnemonic)

Creates a menu item.

Parameters:

name - The menu item name

setMnemonic - True if the menu item should have a mnemonic

Since:

jEdit 3.1pre1

loadMenuItem

public static javax.swing.JMenuItem loadMenuItem(ActionContext context,
                                                 java.lang.String name,
                                                 boolean setMnemonic)

Creates a menu item.

Parameters:

context - An action context; either jEdit.getActionContext() or VFSBrowser.getActionContext().

name - The menu item name

setMnemonic - True if the menu item should have a mnemonic

Since:

jEdit 4.2pre1

loadToolBar

public static javax.swing.Box loadToolBar(java.lang.String name)

Creates a toolbar.

Parameters:

name - The toolbar name

Since:

jEdit 4.2pre2

loadToolBar

public static javax.swing.Box loadToolBar(ActionContext context,
                                          java.lang.String name)

Creates a toolbar.

Parameters:

context - An action context; either jEdit.getActionContext() or VFSBrowser.getActionContext().

name - The toolbar name

Since:

jEdit 4.2pre2

loadToolButton

public static EnhancedButton loadToolButton(java.lang.String name)

Loads a tool bar button. The tooltip is constructed from the name.label and name.shortcut properties and the icon is loaded from the resource named '/org/gjt/sp/jedit/icons/' suffixed with the value of the name.icon property.

Parameters:

name - The name of the button

loadToolButton

public static EnhancedButton loadToolButton(ActionContext context,
                                            java.lang.String name)

Loads a tool bar button. The tooltip is constructed from the name.label and name.shortcut properties and the icon is loaded from the resource named '/org/gjt/sp/jedit/icons/' suffixed with the value of the name.icon property.

Parameters:

context - An action context; either jEdit.getActionContext() or VFSBrowser.getActionContext().

name - The name of the button

Since:

jEdit 4.2pre1

prettifyMenuLabel

public static java.lang.String prettifyMenuLabel(java.lang.String label)

`Prettifies' a menu item label by removing the `$' sign. This can be used to process the contents of an action.label property.

message

public static void message(java.awt.Component comp,
                           java.lang.String name,
                           java.lang.Object[] args)

Displays a dialog box. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property. The message is formatted by the property manager with args as positional parameters.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

args - Positional parameters to be substituted into the message text

error

public static void error(java.awt.Component comp,
                         java.lang.String name,
                         java.lang.Object[] args)

Displays an error dialog box. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property. The message is formatted by the property manager with args as positional parameters.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

args - Positional parameters to be substituted into the message text

input

public static java.lang.String input(java.awt.Component comp,
                                     java.lang.String name,
                                     java.lang.Object def)

Displays an input dialog box and returns any text the user entered. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

def - The text to display by default in the input field

inputProperty

public static java.lang.String inputProperty(java.awt.Component comp,
                                             java.lang.String name,
                                             java.lang.String def)

Displays an input dialog box and returns any text the user entered. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

def - The property whose text to display in the input field

input

public static java.lang.String input(java.awt.Component comp,
                                     java.lang.String name,
                                     java.lang.Object[] args,
                                     java.lang.Object def)

Displays an input dialog box and returns any text the user entered. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

def - The text to display by default in the input field

args - Positional parameters to be substituted into the message text

Since:

jEdit 3.1pre3

inputProperty

public static java.lang.String inputProperty(java.awt.Component comp,
                                             java.lang.String name,
                                             java.lang.Object[] args,
                                             java.lang.String def)

Displays an input dialog box and returns any text the user entered. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

args - Positional parameters to be substituted into the message text

def - The property whose text to display in the input field

Since:

jEdit 3.1pre3

confirm

public static int confirm(java.awt.Component comp,
                          java.lang.String name,
                          java.lang.Object[] args,
                          int buttons,
                          int type)

Displays a confirm dialog box and returns the button pushed by the user. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property.

Parameters:

comp - The component to display the dialog for

name - The name of the dialog

args - Positional parameters to be substituted into the message text

buttons - The buttons to display - for example, JOptionPane.YES_NO_CANCEL_OPTION

type - The dialog type - for example, JOptionPane.WARNING_MESSAGE

Since:

jEdit 3.1pre3

listConfirm

public static int listConfirm(java.awt.Component comp,
                              java.lang.String name,
                              java.lang.String[] args,
                              java.lang.Object[] listModel)

Displays a confirm dialog box and returns the button pushed by the user. The title of the dialog is fetched from the name.title property. The message is fetched from the name.message property. The dialog also shows a list of entries given by the listModel parameter.

Since:

jEdit 4.3pre1

showVFSFileDialog

public static java.lang.String[] showVFSFileDialog(View view,
                                                   java.lang.String path,
                                                   int type,
                                                   boolean multipleSelection)

Displays a VFS file selection dialog box.

Parameters:

view - The view, should be non-null

path - The initial directory to display. May be null

type - The dialog type. One of VFSBrowser.OPEN_DIALOG, VFSBrowser.SAVE_DIALOG, or VFSBrowser.CHOOSE_DIRECTORY_DIALOG.

multipleSelection - True if multiple selection should be allowed

Returns:

The selected file(s)

Since:

jEdit 2.6pre2

parseColor

public static java.awt.Color parseColor(java.lang.String name)

Converts a color name to a color object. The name must either be a known string, such as `red', `green', etc (complete list is in the java.awt.Color class) or a hex color value prefixed with `#', for example `#ff0088'.

Parameters:

name - The color name

parseColor

public static java.awt.Color parseColor(java.lang.String name,
                                        java.awt.Color defaultColor)

getColorHexString

public static java.lang.String getColorHexString(java.awt.Color c)

Converts a color object to its hex value. The hex value prefixed is with `#', for example `#ff0088'.

Parameters:

c - The color object

parseStyle

public static SyntaxStyle parseStyle(java.lang.String str,
                                     java.lang.String family,
                                     int size)
                              throws java.lang.IllegalArgumentException

Converts a style string to a style object.

Parameters:

str - The style string

family - Style strings only specify font style, not font family

size - Style strings only specify font style, not font family

Throws:

java.lang.IllegalArgumentException - if the style is invalid

Since:

jEdit 3.2pre6

parseStyle

public static SyntaxStyle parseStyle(java.lang.String str,
                                     java.lang.String family,
                                     int size,
                                     boolean color)
                              throws java.lang.IllegalArgumentException

Converts a style string to a style object.

Parameters:

str - The style string

family - Style strings only specify font style, not font family

size - Style strings only specify font style, not font family

color - If false, the styles will be monochrome

Throws:

java.lang.IllegalArgumentException - if the style is invalid

Since:

jEdit 4.0pre4

getStyleString

public static java.lang.String getStyleString(SyntaxStyle style)

Converts a style into it's string representation.

Parameters:

style - The style

loadStyles

public static SyntaxStyle[] loadStyles(java.lang.String family,
                                       int size)

Loads the syntax styles from the properties, giving them the specified base font family and size.

Parameters:

family - The font family

size - The font size

Since:

jEdit 3.2pre6

loadStyles

public static SyntaxStyle[] loadStyles(java.lang.String family,
                                       int size,
                                       boolean color)

Loads the syntax styles from the properties, giving them the specified base font family and size.

Parameters:

family - The font family

size - The font size

color - If false, the styles will be monochrome

Since:

jEdit 4.0pre4

loadGeometry

public static void loadGeometry(java.awt.Window win,
                                java.lang.String name)

Loads a windows's geometry from the properties. The geometry is loaded from the name.x, name.y, name.width and name.height properties.

Parameters:

win - The window

name - The window name

adjustForScreenBounds

public static void adjustForScreenBounds(java.awt.Rectangle desired)

Gives a rectangle the specified bounds, ensuring it is within the screen bounds.

Since:

jEdit 4.2pre3

saveGeometry

public static void saveGeometry(java.awt.Window win,
                                java.lang.String name)

Saves a window's geometry to the properties. The geometry is saved to the name.x, name.y, name.width and name.height properties.

Parameters:

win - The window

name - The window name

centerOnScreen

public static void centerOnScreen(java.awt.Window win)

Centers the given window on the screen. This method is needed because JDK 1.3 does not have a JWindow.setLocationRelativeTo() method.

Since:

jEdit 4.2pre3

hideSplashScreen

public static void hideSplashScreen()

Ensures that the splash screen is not visible. This should be called before displaying any dialog boxes or windows at startup.

createMultilineLabel

public static javax.swing.JComponent createMultilineLabel(java.lang.String str)

Creates a component that displays a multiple line message. This is implemented by assembling a number of JLabels in a JPanel.

Parameters:

str - The string, with lines delimited by newline (\n) characters.

Since:

jEdit 4.1pre3

requestFocus

public static void requestFocus(java.awt.Window win,
                                java.awt.Component comp)

Focuses on the specified component as soon as the window becomes active.

Parameters:

win - The window

comp - The component

isPopupTrigger

public static boolean isPopupTrigger(java.awt.event.MouseEvent evt)

Returns if the specified event is the popup trigger event. This implements precisely defined behavior, as opposed to MouseEvent.isPopupTrigger().

Parameters:

evt - The event

Since:

jEdit 3.2pre8

isMiddleButton

public static boolean isMiddleButton(int modifiers)

Parameters:

modifiers - The modifiers flag from a mouse event

Since:

jEdit 4.1pre9

isRightButton

public static boolean isRightButton(int modifiers)

Parameters:

modifiers - The modifiers flag from a mouse event

Since:

jEdit 4.1pre9

showPopupMenu

public static void showPopupMenu(javax.swing.JPopupMenu popup,
                                 java.awt.Component comp,
                                 int x,
                                 int y)

Shows the specified popup menu, ensuring it is displayed within the bounds of the screen.

Parameters:

popup - The popup menu

comp - The component to show it for

x - The x co-ordinate

y - The y co-ordinate

Since:

jEdit 4.0pre1

showPopupMenu

public static void showPopupMenu(javax.swing.JPopupMenu popup,
                                 java.awt.Component comp,
                                 int x,
                                 int y,
                                 boolean point)

Shows the specified popup menu, ensuring it is displayed within the bounds of the screen.

Parameters:

popup - The popup menu

comp - The component to show it for

x - The x co-ordinate

y - The y co-ordinate

point - If true, then the popup originates from a single point; otherwise it will originate from the component itself. This affects positioning in the case where the popup does not fit onscreen.

Since:

jEdit 4.1pre1

isAncestorOf

public static boolean isAncestorOf(java.awt.Component comp1,
                                   java.awt.Component comp2)

Returns if the first component is an ancestor of the second by traversing up the component hierarchy.

Parameters:

comp1 - The ancestor

comp2 - The component to check

Since:

jEdit 4.1pre5

getParentDialog

public static javax.swing.JDialog getParentDialog(java.awt.Component c)

Traverses the given component's parent tree looking for an instance of JDialog, and return it. If not found, return null.

Parameters:

c - The component

getComponentParent

public static java.awt.Component getComponentParent(java.awt.Component comp,
                                                    java.lang.Class clazz)

Finds a parent of the specified component.

Parameters:

comp - The component

clazz - Looks for a parent with this class (exact match, not derived).

Since:

jEdit 4.2pre1

getView

public static View getView(java.awt.Component comp)

Finds the view parent of the specified component.

Since:

jEdit 4.0pre2