Class UIUtils


  • public class UIUtils
    extends java.lang.Object
    A utility class for UI related needs.
    • Constructor Summary

      Constructors 
      Constructor Description
      UIUtils()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void dragImage​(java.awt.Image anImage, java.lang.String aString, java.lang.Object aSource, java.util.List events)
      Initiates Drag and Drop for the given image with the list of mouse events.
      static void dragString​(java.lang.String aString, java.util.List events)
      Drags a String from any component, given a MouseEvent and the string.
      static java.lang.String format​(float value)
      Returns the given float value as a simple formatted string.
      static java.lang.String getString​(java.awt.datatransfer.Transferable aTrans)
      Returns a string from given transferable.
      static void openFile​(java.lang.String aName)
      Tries to open the given file name with the platform reader.
      static void openURL​(java.lang.String aName)
      Tries to open the given URL with the platform reader.
      static java.lang.String showChooser​(boolean save, java.awt.Component aComp, java.lang.String aDesc, java.lang.Object oneOrMoreExtensions)
      Runs a file chooser that remembers last open file and size.
      static java.lang.String showChooser​(boolean save, java.awt.Component aComp, java.lang.String aDesc, java.lang.Object oneOrMoreExtensions, java.lang.Class chooserClass)
      Runs a file chooser that remembers last open file and size.
      static void showPopupMenu​(javax.swing.JPopupMenu aMenu, java.awt.Component anOwner, int targetX, int targetY)
      Show a popup menu at the given coords, adjusting if necessary to ensure that full menu appears within screen bounds.
      static void translateRectToDropDestination​(RMRect dragShapeBounds, RMPoint overShapePt)
      Set the origin of the rect to match the image being dragged around.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • UIUtils

        public UIUtils()
    • Method Detail

      • format

        public static java.lang.String format​(float value)
        Returns the given float value as a simple formatted string.
      • openFile

        public static void openFile​(java.lang.String aName)
        Tries to open the given file name with the platform reader.
      • openURL

        public static void openURL​(java.lang.String aName)
        Tries to open the given URL with the platform reader.
      • showChooser

        public static java.lang.String showChooser​(boolean save,
                                                   java.awt.Component aComp,
                                                   java.lang.String aDesc,
                                                   java.lang.Object oneOrMoreExtensions)
        Runs a file chooser that remembers last open file and size.
      • showChooser

        public static java.lang.String showChooser​(boolean save,
                                                   java.awt.Component aComp,
                                                   java.lang.String aDesc,
                                                   java.lang.Object oneOrMoreExtensions,
                                                   java.lang.Class chooserClass)
        Runs a file chooser that remembers last open file and size.
        Parameters:
        save - true if you intend to store into the resulting file, false otherwise
        aComp - a swing component that will go modal
        aDesc - a description of the file(s) you are filtering for
        oneOrMoreExtensions - a String or array of string with acceptable file extension(s)
        chooserClass - an optional subclass of JFileChooser (you can pass null for JFileChooser)
        Returns:
        the selected path if the user chose a valid file (null otherwise)
      • showPopupMenu

        public static void showPopupMenu​(javax.swing.JPopupMenu aMenu,
                                         java.awt.Component anOwner,
                                         int targetX,
                                         int targetY)
        Show a popup menu at the given coords, adjusting if necessary to ensure that full menu appears within screen bounds.
      • getString

        public static java.lang.String getString​(java.awt.datatransfer.Transferable aTrans)
        Returns a string from given transferable.
      • dragString

        public static void dragString​(java.lang.String aString,
                                      java.util.List events)
        Drags a String from any component, given a MouseEvent and the string.
      • dragImage

        public static void dragImage​(java.awt.Image anImage,
                                     java.lang.String aString,
                                     java.lang.Object aSource,
                                     java.util.List events)
        Initiates Drag and Drop for the given image with the list of mouse events.
      • translateRectToDropDestination

        public static void translateRectToDropDestination​(RMRect dragShapeBounds,
                                                          RMPoint overShapePt)
        Set the origin of the rect to match the image being dragged around.

        Right now this is used to handle the fact that the position of the drag image in relationship to the cursor is different depending on whether the image dragging is being done by the system or by us. It can also be used at some point if we want to make the image dragged from where it was clicked on initially, instead of in the middle (in the system drag case).