org.gradle.gradleplugin.userinterface.swing.generic

Class Utility

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.generic.Utility

public class Utility
extends Object

Just some utility functions.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
Utility()

Method Summary

Methods

Modifier and Type	Method and Description
static Component	addLeftJustifiedComponent(Component component)
static Component	addRightJustifiedComponent(Component component)
static JButton	createButton(Class resourceClass, String imageResourceName, String tooltip, Action action) This creates a button with the specified action, image, and tooltip text.
static JDialog	createDialog(Window parent, String title, boolean isModal) This creates a dialog.
static JMenuItem	createMenuItem(Class resourceClass, String name, String imageResourceName, Action action)
static JToggleButton	createToggleButton(Class resourceClass, String imageResourceName, String tooltip, Action action)
static ImageIcon	getImageIcon(Class resourceClass, String imageResourceName)
static boolean	isCTRLDown(int eventModifiersEx) this determines if the CTRL key is down based on the modifiers from an event.
static void	scrollToText(JTextComponent textComponent, int startingIndex, int endingIndex) Scrolls the specified text component so the text between the starting and ending index are visible.
static void	setTabComponent15Compatible(JTabbedPane tabbedPane, int index, Component component) This uses reflection to set the tab component if we're running under 1.6.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utility

public Utility()

Method Detail

addLeftJustifiedComponent

public static Component addLeftJustifiedComponent(Component component)

addRightJustifiedComponent

public static Component addRightJustifiedComponent(Component component)

createDialog

public static JDialog createDialog(Window parent,
                   String title,
                   boolean isModal)

This creates a dialog. I only created this because I was using JDK 1.6, then realized I needed to use 1.5 and one of the most useful features of 1.6 is dialogs taking Windows as parents. This abstracts that so I don't have to make major changes to the code by passing around JFrames and JDialogs explicitly.

Parameters:

parent - the parent window

isModal - true if its modal, false if not.

Returns:

a dialog

setTabComponent15Compatible

public static void setTabComponent15Compatible(JTabbedPane tabbedPane,
                               int index,
                               Component component)

This uses reflection to set the tab component if we're running under 1.6. It does nothing if you're running under 1.5. This is so you can run this on java 1.6 and get this benefit, but its not required to compile. This is the same as calling JTabbedPane.setTabComponentAt(). It just does so using reflection.

createButton

public static JButton createButton(Class resourceClass,
                   String imageResourceName,
                   String tooltip,
                   Action action)

This creates a button with the specified action, image, and tooltip text. The main issue here is that it doesn't crash if the image is missing (which is just something that happens in real life from time to time). You probably should specify a name on the action just in case.

Parameters:

resourceClass - the calling class. Useful when multiple classloaders are used.

imageResourceName - the image resource

tooltip - the tooltip to display

action - the action to perform

Returns:

the button that was created.

createToggleButton

public static JToggleButton createToggleButton(Class resourceClass,
                               String imageResourceName,
                               String tooltip,
                               Action action)

createMenuItem

public static JMenuItem createMenuItem(Class resourceClass,
                       String name,
                       String imageResourceName,
                       Action action)

isCTRLDown

public static boolean isCTRLDown(int eventModifiersEx)

this determines if the CTRL key is down based on the modifiers from an event. This actualy needs to be checking for different things. CTRL doesn't meant the same thing on each platform.

getImageIcon

public static ImageIcon getImageIcon(Class resourceClass,
                     String imageResourceName)

scrollToText

public static void scrollToText(JTextComponent textComponent,
                int startingIndex,
                int endingIndex)

Scrolls the specified text component so the text between the starting and ending index are visible.