GUIUtils.java
| Index Score | ||
|---|---|---|
 |
 |
com.limegroup.gnutella.gui |
 |
|
FrostWire |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| DECL_COMMENTS | Comments in declarations | |
| EXITS | Procedure exits | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PARAMS | Number of formal parameter declarations | |
| FUNCTIONS | Number of function declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| DOC_COMMENT | Number of javadoc comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| LINES | Number of lines in the source file | |
| COMMENTS | Comment lines | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| COMPARISONS | Number of comparison operators | |
| JAVA0007 | JAVA0007 Should not declare public field | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0035 | JAVA0035 Missing braces in for statement | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
package com.limegroup.gnutella.gui;
import java.awt.Color;
import java.awt.Component;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Graphics;
import java.awt.Toolkit;
import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.WindowEvent;
import java.io.File;
import java.lang.reflect.Field;
import java.net.URL;
import java.text.DateFormat;
import java.text.NumberFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.ActionMap;
import javax.swing.Icon;
import javax.swing.InputMap;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.KeyStroke;
import javax.swing.SwingUtilities;
import javax.swing.event.HyperlinkEvent;
import javax.swing.event.HyperlinkListener;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.limewire.util.FileUtils;
import org.limewire.util.OSUtils;
import com.limegroup.gnutella.SpeedConstants;
import com.limegroup.gnutella.gui.mp3.PlayListItem;
import com.limegroup.gnutella.gui.playlist.PlaylistMediator;
import com.limegroup.gnutella.gui.themes.ThemeSettings;
import com.limegroup.gnutella.gui.util.BackgroundExecutorService;
//2345678|012345678|012345678|012345678|012345678|012345678|012345678|012345678|
/**
* This class serves as a holder for any static gui convenience
* methods.
*/
public final class GUIUtils {
private static final Log LOG = LogFactory.getLog(GUIUtils.class);
/**
* Make sure the constructor is never called.
*/
private GUIUtils() {}
/**
* Localizable Number Format constant for the current default locale
* set at init time.
*/
private static NumberFormat NUMBER_FORMAT0; // localized "#,##0"
private static NumberFormat NUMBER_FORMAT1; // localized "#,##0.0"
/**
* Localizable Date Format constant for the current default locale
* set at init time.
*/
private static DateFormat DATETIME_FORMAT;
/** A full datetime format. */
private static DateFormat FULL_DATETIME_FORMAT;
/**
* Localizable constants
*/
public static String GENERAL_UNIT_KILOBYTES;
public static String GENERAL_UNIT_MEGABYTES;
public static String GENERAL_UNIT_GIGABYTES;
public static String GENERAL_UNIT_TERABYTES;
/* ambiguous name: means kilobytes/second, not kilobits/second! */
public static String GENERAL_UNIT_KBPSEC;
public static final HyperlinkListener HYPER_LISTENER;
/**
* An action that disposes the parent window.
* Constructed lazily.
*/
public static Action ACTION_DISPOSE;
static {
HYPER_LISTENER = new HyperlinkListener() {
public void hyperlinkUpdate(HyperlinkEvent he) {
if(he.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
URL url = he.getURL();
if(url != null)
GUIMediator.openURL(url.toExternalForm());
}
}
};
resetLocale();
}
static void resetLocale() {
NUMBER_FORMAT0 = NumberFormat.getNumberInstance(GUIMediator.getLocale());
NUMBER_FORMAT0.setMaximumFractionDigits(0);
NUMBER_FORMAT0.setMinimumFractionDigits(0);
NUMBER_FORMAT0.setGroupingUsed(true);
NUMBER_FORMAT1 = NumberFormat.getNumberInstance(GUIMediator.getLocale());
NUMBER_FORMAT1.setMaximumFractionDigits(1);
NUMBER_FORMAT1.setMinimumFractionDigits(1);
NUMBER_FORMAT1.setGroupingUsed(true);
DATETIME_FORMAT = DateFormat.getDateTimeInstance(DateFormat.DEFAULT,
DateFormat.DEFAULT, GUIMediator.getLocale());
FULL_DATETIME_FORMAT =
new SimpleDateFormat("EEE, MMM. d, yyyy h:mm a", GUIMediator.getLocale());
GENERAL_UNIT_KILOBYTES =
I18n.tr("KB");
GENERAL_UNIT_MEGABYTES =
I18n.tr("MB");
GENERAL_UNIT_GIGABYTES =
I18n.tr("GB");
GENERAL_UNIT_TERABYTES =
I18n.tr("TB");
GENERAL_UNIT_KBPSEC =
I18n.tr("KB/s");
}
/**
* This static method converts the passed in number
* into a localizable representation of an integer, with
* digit grouping using locale dependant separators.
*
* @param value the number to convert to a numeric String.
*
* @return a localized String representing the integer value
*/
public static String toLocalizedInteger(long value) {
return NUMBER_FORMAT0.format(value);
}
/**
* This static method converts the passed in number of bytes into a
* kilobyte string grouping digits with locale-dependant thousand separator
* and with "KB" locale-dependant unit at the end.
*
* @param bytes the number of bytes to convert to a kilobyte String.
*
* @return a String representing the number of kilobytes that the
* <code>bytes</code> argument evaluates to, with "KB" appended
* at the end. If the input value is negative, the string
* returned will be "? KB".
*/
public static String toKilobytes(long bytes) {
if (bytes < 0)
return "? " + GENERAL_UNIT_KILOBYTES;
long kbytes = bytes / 1024;
// round to nearest multiple, or round up if size below 1024
if ((bytes & 512) != 0 || (bytes > 0 && bytes < 1024)) kbytes++;
// result formating, according to the current locale
return NUMBER_FORMAT0.format(kbytes) + GENERAL_UNIT_KILOBYTES;
}
/**
* Converts the passed in number of bytes into a byte-size string.
* Group digits with locale-dependant thousand separator if needed, but
* with "KB", or "MB" or "GB" or "TB" locale-dependant unit at the end,
* and a limited precision of 4 significant digits.
*
* @param bytes the number of bytes to convert to a size String.
* @return a String representing the number of kilobytes that the
* <code>bytes</code> argument evaluates to, with
* "KB"/"MB"/"GB"/TB" appended at the end. If the input value is
* negative, the string returned will be "? KB".
*/
public static String toUnitbytes(long bytes) {
if (bytes < 0) {
return "? " + GENERAL_UNIT_KILOBYTES;
}
long unitValue; // the multiple associated with the unit
String unitName; // one of localizable units
if (bytes < 0xA00000) { // below 10MB, use KB
unitValue = 0x400;
unitName = GENERAL_UNIT_KILOBYTES;
} else if (bytes < 0x280000000L) { // below 10GB, use MB
unitValue = 0x100000;
unitName = GENERAL_UNIT_MEGABYTES;
} else if (bytes < 0xA0000000000L) { // below 10TB, use GB
unitValue = 0x40000000;
unitName = GENERAL_UNIT_GIGABYTES;
} else { // at least 10TB, use TB
unitValue = 0x10000000000L;
unitName = GENERAL_UNIT_TERABYTES;
}
NumberFormat numberFormat; // one of localizable formats
if ((double)bytes * 100 / unitValue < 99995)
// return a minimum "100.0xB", and maximum "999.9xB"
numberFormat = NUMBER_FORMAT1; // localized "#,##0.0"
else
// return a minimum "1,000xB"
numberFormat = NUMBER_FORMAT0; // localized "#,##0"
try {
return numberFormat.format((double)bytes / unitValue) + " " + unitName;
} catch(ArithmeticException ae) {
return "0 " + unitName;
// internal java error, just return 0.
}
}
/**
* Returns a label with multiple lines that is sized according to
* the string parameter.
*
* @param msg the string that will be contained in the label.
*
* @return a MultiLineLabel sized according to the passed
* in string.
*/
public static MultiLineLabel getSizedLabel(String msg) {
Dimension dim = new Dimension();
MultiLineLabel label = new MultiLineLabel(msg);
FontMetrics fm = label.getFontMetrics(label.getFont());
int width = fm.stringWidth(msg);
dim.setSize(Integer.MAX_VALUE, width / 9); //what's this magic?
label.setPreferredSize(dim);
return label;
}
/**
* Converts the following bandwidth value, in kbytes/second, to
* a human readable.
*/
public static String speed2name(int rate) {
if (rate <= SpeedConstants.MODEM_SPEED_INT)
return GUIConstants.MODEM_SPEED;
else if (rate <= SpeedConstants.CABLE_SPEED_INT)
return GUIConstants.CABLE_SPEED;
else if (rate <= SpeedConstants.T1_SPEED_INT)
return GUIConstants.T1_SPEED;
else if (rate == SpeedConstants.THIRD_PARTY_SPEED_INT)
return GUIConstants.THIRD_PARTY_RESULTS_SPEED;
else if (rate < Integer.MAX_VALUE - 1)
return GUIConstants.T3_SPEED;
else
return GUIConstants.MULTICAST_SPEED;
}
/**
* Converts an rate into a human readable and localized KB/s speed.
*/
public static String rate2speed(double rate) {
return NUMBER_FORMAT0.format(rate) + " " + GENERAL_UNIT_KBPSEC;
}
/**
* Converts number of milliseconds since way back when to
* a local-formatted date String
*/
public static String msec2DateTime(long milliseconds) {
Date d = new Date(milliseconds);
return DATETIME_FORMAT.format(d);
}
/** Gets the full datetime formatter. */
public static DateFormat getFullDateTimeFormat() {
return FULL_DATETIME_FORMAT;
}
/**
* Sets the child components of a component to all be either
* opaque or not opaque.
*/
public static void setOpaque(boolean op, JComponent c) {
c.setOpaque(op);
Component[] cs = c.getComponents();
for(int i = 0; i < cs.length; i++) {
if(cs[i] instanceof JComponent &&
!(cs[i] instanceof JTextField) &&
(ThemeSettings.isNativeOSXTheme() ||
!(cs[i] instanceof JButton))
) {
((JComponent)cs[i]).setOpaque(op);
setOpaque(op, (JComponent)cs[i]);
}
}
}
/**
* Centers the given component.
*/
public static JPanel center(JComponent c) {
JPanel p = new JPanel(new FlowLayout(FlowLayout.CENTER, 0, 0));
p.add(c);
return p;
}
/**
* Left flushes the given component.
*/
public static JPanel left(JComponent c) {
JPanel p = new JPanel(new FlowLayout(FlowLayout.LEFT, 0, 0));
p.add(c);
return p;
}
/**
* Gets the width of a given label.
*/
public static int width(JLabel c) {
FontMetrics fm = c.getFontMetrics(c.getFont());
return fm.stringWidth(c.getText()) + 3;
}
/**
* Determines if a font can display up to a point in the string.
*
* Returns -1 if it can display the whole string.
*/
public static boolean canDisplay(Font f, String s) {
int upTo = f.canDisplayUpTo(s);
if(upTo >= s.length() || upTo == -1)
return true;
else
return false;
}
/**
* Adds a hide action to a JDialog.
*/
public static void addHideAction(JDialog jd) {
addHideAction((JComponent)jd.getContentPane());
}
/**
* Adds an action to hide a window / dialog.
*
* On OSX, this is done by typing 'Command-W'.
* On all other platforms, this is done by hitting 'ESC'.
*/
public static void addHideAction(JComponent jc) {
InputMap map = jc.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
map.put(getHideKeystroke(), "limewire.hideWindow");
jc.getActionMap().put("limewire.hideWindow", getDisposeAction());
}
/**
* Gets the keystroke for hiding a window according to the platform.
*/
public static KeyStroke getHideKeystroke() {
if(OSUtils.isMacOSX())
return KeyStroke.getKeyStroke(KeyEvent.VK_W,
Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
else
return KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
}
/**
* Binds a key stroke to the given action for the component. The action is
* triggered when the key is pressed and the keyboard focus is withing the
* specifiedd scope.
*
* @param c component for which the keybinding is installed
* @param key the key that triggers the action
* @param a the action
* @param focusScope one of {@link JComponent.WHEN_FOCUSED},
* {@link JComponent.WHEN_IN_FOCUSED_WINDOW},
* {@link JComponent.WHEN_ANCESTOR_OF_FOCUSED_WINDOW}
*/
public static void bindKeyToAction(JComponent c, KeyStroke key, Action a,
int focusScope) {
InputMap inputMap = c.getInputMap(focusScope);
ActionMap actionMap = c.getActionMap();
if (inputMap != null && actionMap != null) {
inputMap.put(key, a);
actionMap.put(a, a);
}
}
/**
* Convenience wrapper for {@link #bindKeyToAction(JComponent, KeyStroke,
* Action, int) bindKeyToAction(c, key, a, JComponentn.WHEN_FOCUSED)}.
*/
public static void bindKeyToAction(JComponent c, KeyStroke key, Action a) {
bindKeyToAction(c, key, a, JComponent.WHEN_FOCUSED);
}
/**
* Returns (possibly constructing) the ESC action.
*/
public static Action getDisposeAction() {
if(ACTION_DISPOSE == null) {
ACTION_DISPOSE = new AbstractAction() {
public void actionPerformed(ActionEvent ae) {
Window parent;
if(ae.getSource() instanceof Window)
parent = (Window)ae.getSource();
else
parent = SwingUtilities.getWindowAncestor((Component)ae.getSource());
if(parent != null)
parent.dispatchEvent(new WindowEvent(parent, WindowEvent.WINDOW_CLOSING));
}
};
}
return ACTION_DISPOSE;
}
/**
* Fixes the InputMap to have the correct KeyStrokes registered for
* actions on various OS's.
*
* Currently, this fixes OSX to use the 'meta' key instead of hard-coding
* it to use the 'control' key for actions such as 'select all', etc..
*/
public static void fixInputMap(JComponent jc) {
InputMap map =
jc.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
if(OSUtils.isMacOSX()) {
replaceAction(map, 'A'); // select all
replaceAction(map, 'C'); // copy
replaceAction(map, 'V'); // paste
replaceAction(map, 'X'); // cut
}
}
/**
* Moves the action for the specified character from the 'ctrl' mask
* to the 'meta' mask.
*/
private static void replaceAction(InputMap map, char c) {
KeyStroke ctrl = KeyStroke.getKeyStroke("control pressed " + c);
KeyStroke meta = KeyStroke.getKeyStroke("meta pressed " + c);
if(ctrl == null || meta == null)
return;
Object action = map.get(ctrl);
if(action != null) {
map.remove(ctrl);
map.put(meta, action);
}
}
/**
* Returns the sole hyperlink listener.
*/
public static HyperlinkListener getHyperlinkListener() {
return HYPER_LISTENER;
}
/**
* Returns a <code>MouseListener</code> that changes the cursor and
* notifies <code>actionListener</code> on click.
*/
public static MouseListener getURLInputListener(final ActionListener actionListener) {
return new MouseAdapter() {
public void mouseEntered(MouseEvent e) {
JComponent comp = (JComponent)e.getComponent();
comp.getTopLevelAncestor().setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
}
public void mouseExited(MouseEvent e) {
JComponent comp = (JComponent)e.getComponent();
comp.getTopLevelAncestor().setCursor(Cursor.getDefaultCursor());
}
public void mouseClicked(MouseEvent e) {
actionListener.actionPerformed(new ActionEvent(e.getComponent(), 0, null));
}
};
}
/**
* Returns a <code>MouseListener</code> that changes the cursor and opens
* <code>url</code> on click.
*/
public static MouseListener getURLInputListener(final String url) {
return getURLInputListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
GUIMediator.openURL(url);
}
});
}
/**
* Determines if the Start On Startup option is availble.
*/
public static boolean shouldShowStartOnStartupWindow() {
return (OSUtils.isMacOSX() &&
OSUtils.isCocoaFoundationAvailable()) ||
(WindowsUtils.isLoginStatusAvailable());
}
/**
* Converts all spaces in the string to non-breaking spaces.
*
* Adds 'preSpaces' number of non-breaking spaces prior to the string.
*/
public static String convertToNonBreakingSpaces(int preSpaces, String s) {
StringBuilder b = new StringBuilder(preSpaces + s.length());
for(int i = 0; i < preSpaces; i++)
b.append('\u00a0');
b.append(s.replace(' ', '\u00a0'));
return b.toString();
}
/**
* Convert a color object to a hex string
**/
public static String colorToHex(Color colorCode){
int r = colorCode.getRed();
int g = colorCode.getGreen();
int b = colorCode.getBlue();
return toHex(r) + toHex(g) + toHex(b);
}
/**
* Returns the int as a hex string.
**/
private static String toHex(int i) {
String hex = Integer.toHexString(i).toUpperCase();
if (hex.length() == 1)
return "0" + hex;
else
return hex;
}
/**
* Convert a hex string to a color object
**/
public static Color hexToColor(String hexString){
int decimalColor;
decimalColor = Integer.parseInt(hexString, 16);
return new Color(decimalColor);
}
/**
* Launches file or enqueues it.
* If <code>audioLaunched</code> is true and the playlist is visible the
* file is enqueued instead of played.
* @param file
* @param audioLaunched
* @return if audio has been launched in limewire's player
*/
public static boolean launchOrEnqueueFile(final File file, boolean audioLaunched) {
return launchFile(file, false, audioLaunched);
}
/**
* Launches a file to be played once and only once. If the playlist is currently playing and/or
* set to continous this will preemept the current song and stop the player after completion
*/
public static boolean launchOneTimeFile(final File file) {
return launchFile(file, true, false);
}
/**
* Internal launch of a song to play.
* @param file - song to play
* @param playOneTime - if true, begin playing song immediately even if other songs are currently playing
* after completing the song stops the player regardless of the continous setting
* @param isPlaying - if true and playOneTime != true, will enqueue the song to the playlist rather
* than immediately playing it, otherwise will play immediately
*/
private static boolean launchFile(final File file, boolean playOneTime, boolean isPlaying ) {
String extension = FileUtils.getFileExtension(file);
if(extension != null && extension.equals("torrent")) {
GUIMediator.instance().openTorrent(file);
return false;
}
if (GUIMediator.isPlaylistVisible()) {
if (PlaylistMediator.getInstance().openIfPlaylist(file))
return false;
if(PlaylistMediator.isPlayableFile(file)) {
if( playOneTime ) {
BackgroundExecutorService.schedule(new Runnable() {
public void run(){
final PlayListItem item = new PlayListItem(file);
GUIMediator.safeInvokeAndWait(new Runnable() {
public void run() {
GUIMediator.instance().launchAudio(item, false);
}
});
}
});
}
else if (!isPlaying) {
BackgroundExecutorService.schedule(new Runnable() {
public void run(){
final PlayListItem item = new PlayListItem(file);
GUIMediator.safeInvokeAndWait(new Runnable() {
public void run() {
GUIMediator.instance().launchAudio(item);
}
});
}
});
}
else {
PlaylistMediator.getInstance().addFileToPlaylist(file);
}
return true;
}
}
GUIMediator.launchFile(file);
return false;
}
/**
* Launches an audio file.
* If the FrostWire media player is enabled it will enqueue the song on the
* playlist. It won't take into consideration if the song is complete or not.
* If the frostwire player isn't enabled it will just use whatever is configured
* as an external player to launch the file.
*
* Note, this wont take in consideration if the song is being played or not.
* It will launch it no matter what (maybe this causes problems)
*
* @param file
* @param audioLaunched
* @return True if the song was launched with frostplayer
*/
public static boolean launchAndEnqueueFile(File file, boolean audioLaunched) {
if (PlaylistMediator.isPlayableFile(file) && GUIMediator.isPlaylistVisible()) {
GUIMediator.instance().attemptStopAudio();
final PlayListItem item = new PlayListItem(file);
GUIMediator.instance().launchAudio(item);
PlaylistMediator.getInstance().addFileToPlaylist(file);
return true;
}
else {
//use external player to launch file
return launchFile(file, false, audioLaunched);
}
//return false;
}
/**
* Sets the location of <tt>dialog</tt> so it appears centered regarding
* the main application or centered on the screen if the main application is
* not visible.
*/
public static void centerOnScreen(JDialog dialog) {
if (GUIMediator.isAppVisible()) {
dialog.setLocationRelativeTo(GUIMediator.getAppFrame());
} else {
dialog.setLocation(GUIMediator.getScreenCenterPoint(dialog));
}
}
/**
* Returns <code>text</code> wrapped by an HTML table tag that is set to a
* fixed width.
* <p>
* Note: It seems to be a possible to trigger a NullPointerException in
* Swing when this is used in a JLabel: GUI-239.
*/
public static String restrictWidth(String text, int width) {
return "<html><table width=\"" + width + "\"><tr><td>" + text
+ "</td></tr></table></html>";
}
/**
* Restricts the size of a component by setting its minimum size and
* maximum size to the value of its preferred size.
*
*/
public static void restrictSize(JComponent component, SizePolicy sizePolicy) {
restrictSize(component, sizePolicy, false);
}
public static void restrictSize(JComponent component, SizePolicy sizePolicy, boolean addClientProperty) {
switch (sizePolicy) {
case RESTRICT_HEIGHT:
int height = component.getPreferredSize().height;
int width = component.getPreferredSize().width;
component.setMinimumSize(new Dimension(width, height));
//component.setPreferredSize(new Dimension(width, height));
component.setMaximumSize(new Dimension(Integer.MAX_VALUE, height));
break;
case RESTRICT_BOTH:
height = component.getPreferredSize().height;
width = component.getPreferredSize().width;
component.setMinimumSize(new Dimension(width, height));
//component.setPreferredSize(STANDARD_DIMENSION);
component.setMaximumSize(new Dimension(width, height));
break;
case RESTRICT_NONE:
component.setMinimumSize(null);
component.setMaximumSize(null);
}
if (addClientProperty) {
component.putClientProperty(SizePolicy.class, sizePolicy);
}
}
public static class EmptyIcon implements Icon {
private final String name;
private final int width;
private final int height;
public EmptyIcon(String name, int width, int height) {
this.name = name;
this.width = width;
this.height = height;
}
public void paintIcon(Component c, Graphics g, int x, int y) {}
public int getIconWidth() { return width; }
public int getIconHeight() { return height; }
public String toString() { return name; }
}
public enum SizePolicy { RESTRICT_NONE, RESTRICT_HEIGHT, RESTRICT_BOTH }
/**
* Using a little reflection here for a lack of any better way
* to access locale-specific char codes for menu mnemonics.
* We could at least defer this in the future.
*
* @param str the key for the locale-specific char resource to
* look up -- the key as it appears in the locale-specific
* properties file
* @return the code for the passed-in key as defined in
* <tt>java.awt.event.KeyEvent</tt>, or -1 if no key code
* could be found
*/
public static int getCodeForCharKey(String str) {
int charCode = -1;
String charStr = str.toUpperCase(Locale.US);
if(charStr.length()>1) return -1;
try {
Field charField = KeyEvent.class.getField("VK_"+charStr);
charCode = charField.getInt(KeyEvent.class);
} catch (NoSuchFieldException e) {
LOG.error("can't get key for: " + charStr, e);
} catch (SecurityException e) {
LOG.error("can't get key for: " + charStr, e);
} catch (IllegalAccessException e) {
LOG.error("can't get key for: " + charStr, e);
}
return charCode;
}
private static int getAmpersandPosition(String text) {
int index = -1;
while ((index = text.indexOf('&', index + 1)) != -1) {
if (index < text.length() - 1 && Character.isLetterOrDigit(text.charAt(index + 1))) {
break;
}
}
return index;
}
public static String stripAmpersand(String text) {
int index = getAmpersandPosition(text);
if (index >= 0) {
return text.substring(0, index) + text.substring(index + 1);
}
return text;
}
public static int getMnemonicKeyCode(String text) {
// parse out mnemonic key
int index = getAmpersandPosition(text);
if (index >= 0) {
return GUIUtils.getCodeForCharKey(text.substring(index + 1, index + 2));
}
return -1;
}
}
The table below shows all metrics for GUIUtils.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 92.00 | Number of blocks | |
| BLOCK_COMMENT | 1.00 | Number of block comment lines | |
| COMMENTS | 240.00 | Comment lines | |
| COMMENT_DENSITY | 0.60 | Comment density | |
| COMPARISONS | 59.00 | Number of comparison operators | |
| CYCLOMATIC | 118.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 46.00 | Comments in declarations | |
| DOC_COMMENT | 228.00 | Number of javadoc comment lines | |
| ELOC | 397.00 | Effective lines of code | |
| EXEC_COMMENTS | 10.00 | Comments in executable code | |
| EXITS | 106.00 | Procedure exits | |
| FUNCTIONS | 58.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 77.37 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 147.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 6.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 1.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 23.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 1.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 2.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 1.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 31.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 21.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 5.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 4.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 184.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 5.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 791.00 | Number of lines in the source file | |
| LINE_COMMENT | 11.00 | Number of line comments | |
| LOC | 479.00 | Lines of code | |
| LOGICAL_LINES | 258.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1189.00 | Number of operands | |
| OPERATORS | 2156.00 | Number of operators | |
| PARAMS | 66.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3345.00 | Halstead program length | |
| PROGRAM_VOCAB | 495.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 81.00 | Number of return points from functions | |
| SIZE | 28123.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 438.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 72.00 | Number of whitespace lines | |