CGUtil (CharGer4 Documentation)

Object
- charger.util.CGUtil

```
public class CGUtil
extends Object
```
Utility classes (all static!) that should be of fairly general use

Constructor Summary

Constructors
Constructor and Description

CGUtil()

Constructors
Constructor and Description
`CGUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Rectangle2D.Double`	`adjustForCartesian(double x1, double y1, double x2, double y2)` returns the AWT rectangle given any two opposite corners, correcting for signs.
`static Rectangle2D.Double`	`adjustForCartesian(Point2D.Double p1, Point2D.Double p2)` returns the AWT rectangle given its two opposite corners
`static GNode`	`closestObject(ArrayList<GNode> nodes, Point2D.Double point)` Finds the object in the list that is closest to the point given
`static int`	`fillChoiceList(JComboBox c, String[] choices, FontMetrics fm)` Loads choice list from the enumeration given.
`static Point2D.Double`	`getCenter(Rectangle2D.Double r)` Returns the center of the rectangle as a Point2D.Double
`static Point2D.Double`	`getCenterPoint(ArrayList<GNode> nodes)` Finds the center of the bounding rectangle that enclosed all the nodes
`static ArrayList<ArrayList<GNode>>`	`getConnectedComponents(Graph g)` Used in determining connected components.
`static Color`	`getDarkest(Color c1, Color c2)` Returns the darker of the two colors, using a very crude algorithm.
`static Point2D.Double`	`getStringLowerLeftFromCenter(FontMetrics fm, String s, Point2D.Double center)` Find the lower left point for displaying a string whose center point is known.
`static void`	`grow(Rectangle2D.Double r, double xinc, double yinc)` Mimics behavior of jawa.awt.Rectangle.grow which was oddly omitted from Rectangle2D
`private static void`	`labelConnectedNodes(HashMap<GNode,Integer> componentLabels, GNode startNode, int componentNum)` Start by labeling the start node and then recursively find all the others
`static void`	`loadSizedComboBox(JComboBox cb, String textLabel, FontMetrics fm)` Loads combo box, setting given string as the default, resizing the field if necessary.
`static void`	`loadSizedTextField(JTextField tf, String textLabel, FontMetrics fm)` Loads given text field with given string, resizing the field if necessary.
`static String`	`shortClassName(Object obj)` Returns the short (un-qualified) name string of the given object
`static void`	`showMessageDialog(Component parentComponent, Object message)`
`static void`	`showPoint(Graphics2D g, Point2D.Double p)` Displays a point's coordinates in text at its location.
`static ArrayList<GraphObject>`	`sortObjects(ArrayList<GraphObject> list)` Gather together all the selected nodes, edges and graphs into a list.
`static Dimension`	`stringDimensions(String s, FontMetrics fm)` Calculate height and width on a string using a given font metrics.
`static Rectangle2D.Double`	`unionDisplayRects(ArrayList nodeList)` Determines the union of a set of nodes' display rectangles.
`static boolean`	`verifyIntegrityOfGraph(Graph g)` Performs various "sanity checks" to make sure a graph is formed and/or constructed properly.

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

- Constructor Detail
  - CGUtil
```
public CGUtil()
```
- Method Detail
  - shortClassName
```
public static String shortClassName(Object obj)
```
    Returns the short (un-qualified) name string of the given object
    
    Parameters:
    
    obj - Any Java object
    
    Returns:
    
    unqualified name of the object's class
  - getStringLowerLeftFromCenter
```
public static Point2D.Double getStringLowerLeftFromCenter(FontMetrics fm,
                                                          String s,
                                                          Point2D.Double center)
```
    Find the lower left point for displaying a string whose center point is known. adapted from p 586, Naughton and Schildt, 1996
    
    Parameters:
    
    fm - any font metrics
    
    s - the string to be displayed
    
    center - position of the centerpoint (in pixels)
  - sortObjects
```
public static ArrayList<GraphObject> sortObjects(ArrayList<GraphObject> list)
```
    Gather together all the selected nodes, edges and graphs into a list. The list is sorted: graphs first, then nodes then edges. Responsible for making sure that no object is included more than once (e.g., if it is enclosed in a graph that's in the list as well as appearing by itself.) If an edge is in the list, but either of its linked nodes is NOT in the list, then the edge is not included. If any two selected nodes are linked by an edge, then that edge should be included whether it was originally selected or not.
    
    Returns:
    
    collection of selected objects
  - adjustForCartesian
```
public static Rectangle2D.Double adjustForCartesian(double x1,
                                                    double y1,
                                                    double x2,
                                                    double y2)
```
    returns the AWT rectangle given any two opposite corners, correcting for signs. Corners may either be a combination of upper left and lower right or else upper right and lower left.
    
    Parameters:
    
    x1 - are the x,y's for points 1 and 2 representing opposite corners of a rectangle
    
    y1 -
    
    x2 -
    
    y2 -
  - adjustForCartesian
```
public static Rectangle2D.Double adjustForCartesian(Point2D.Double p1,
                                                    Point2D.Double p2)
```
    returns the AWT rectangle given its two opposite corners
    
    Parameters:
    
    p1 - and p2 are the two points representing opposite corners of a rectangle
    
    p2 -
  - stringDimensions
```
public static Dimension stringDimensions(String s,
                                         FontMetrics fm)
```
    Calculate height and width on a string using a given font metrics.
    
    Parameters:
    
    s - String whose dimensions are desired.
    
    fm - Font metrics under which the string is to be rendered.
    
    Returns:
    
    Dimensions of the string.
  - fillChoiceList
```
public static int fillChoiceList(JComboBox c,
                                 String[] choices,
                                 FontMetrics fm)
```
    Loads choice list from the enumeration given. Makes no assumptions about whether choice is visible, listened-to, etc.
    
    Parameters:
    
    c - The (already allocated) Choice to be loaded
    
    choices - The list of choice strings to be put into the list.
    
    fm - The currently applicable font metrics, used for determining size of box
  - loadSizedTextField
```
public static void loadSizedTextField(JTextField tf,
                                      String textLabel,
                                      FontMetrics fm)
```
    Loads given text field with given string, resizing the field if necessary. Makes no assumptions about whether field is visible, listened-to, etc.
    
    Parameters:
    
    tf - The (already allocated) TextField to be loaded
    
    textLabel - The string to load into tf
    
    fm - font metrics from the context for which the combo box will be sized
  - loadSizedComboBox
```
public static void loadSizedComboBox(JComboBox cb,
                                     String textLabel,
                                     FontMetrics fm)
```
    Loads combo box, setting given string as the default, resizing the field if necessary. Assumes combo box is initialized and if popup is used, popup is already filled.
    
    Parameters:
    
    cb - The (already allocated) JComboBox to be loaded
    
    textLabel - The string to load into tf
    
    fm - font metrics from the context for which the combo box will be sized
  - unionDisplayRects
```
public static Rectangle2D.Double unionDisplayRects(ArrayList nodeList)
```
    Determines the union of a set of nodes' display rectangles. For a context node, treats its entire extent as its rectangle.
    
    Parameters:
    
    nodeList - Set of Graph objects.
    
    Returns:
    
    union of nodeList's display rectangles
  - showPoint
```
public static void showPoint(Graphics2D g,
                             Point2D.Double p)
```
    Displays a point's coordinates in text at its location.
    
    Parameters:
    
    g - context in which to draw
    
    p - point being displayed.
  - getDarkest
```
public static Color getDarkest(Color c1,
                               Color c2)
```
    Returns the darker of the two colors, using a very crude algorithm.
  - grow
```
public static void grow(Rectangle2D.Double r,
                        double xinc,
                        double yinc)
```
    Mimics behavior of jawa.awt.Rectangle.grow which was oddly omitted from Rectangle2D
  - getCenter
```
public static Point2D.Double getCenter(Rectangle2D.Double r)
```
    Returns the center of the rectangle as a Point2D.Double
  - getConnectedComponents
```
public static ArrayList<ArrayList<GNode>> getConnectedComponents(Graph g)
```
    Used in determining connected components.
  - labelConnectedNodes
```
private static void labelConnectedNodes(HashMap<GNode,Integer> componentLabels,
                                        GNode startNode,
                                        int componentNum)
```
    Start by labeling the start node and then recursively find all the others
    
    Parameters:
    
    startNode -
  - getCenterPoint
```
public static Point2D.Double getCenterPoint(ArrayList<GNode> nodes)
```
    Finds the center of the bounding rectangle that enclosed all the nodes
    
    Parameters:
    
    nodes -
    
    Returns:
    
    the center point of the rectangle that bounds all of the nodes in the list.
  - closestObject
```
public static GNode closestObject(ArrayList<GNode> nodes,
                                  Point2D.Double point)
```
    Finds the object in the list that is closest to the point given
  - verifyIntegrityOfGraph
```
public static boolean verifyIntegrityOfGraph(Graph g)
```
    Performs various "sanity checks" to make sure a graph is formed and/or constructed properly. Checks to make sure each edge is owned by at least one of the graphs that own its endpoints. Checks to make sure all objects are owned by the graph in which they are nested.
    
    Returns:
    
    true if all checks pass without problems; false otherwise (errors are written to the console
    
    See Also:
    
    General.error(java.lang.String)
  - showMessageDialog
```
public static void showMessageDialog(Component parentComponent,
                                     Object message)
```

Class CGUtil

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

CGUtil

Method Detail

shortClassName

getStringLowerLeftFromCenter

sortObjects

adjustForCartesian

adjustForCartesian

stringDimensions

fillChoiceList

loadSizedTextField

loadSizedComboBox

unionDisplayRects

showPoint

getDarkest

grow

getCenter

getConnectedComponents

labelConnectedNodes

getCenterPoint

closestObject

verifyIntegrityOfGraph

showMessageDialog