| java.lang.Object
 org.apache.harmony.x.swing.Utilities
| Utilities | | public class Utilities implements SwingConstants(Code) | | SwingUtilities extension. This class provides utility
methods which are widely used in Swing classes.
|
| Inner Class :public interface ListModelAccessor | |
| Method Summary | |
| final public static Dimension | addInsets(Dimension size, Insets insets)
Enlarges size by insets size. | | final public static Insets | addInsets(Insets recipient, Insets addition)
Adds values from second argument to the first one and returns first argument. | | public static MenuElement[] | addToPath(MenuElement[] path, MenuElement item)
Adds item to the corresponding place in the menu selection path. | | public static Point | adjustPopupLocation(Point location, Dimension size, Rectangle anchor, boolean horizontal, GraphicsConfiguration gc)
Determizes the 'optimal' popup location to provide the entire popup is shown. | | public static void | alignRect(Rectangle rect, Rectangle box, int horizontalAlign, int verticalAlign)
Aligns rectangle with the inner bounds of the box taking into account
alignments given. | | public static int | checkHorizontalKey(int key, String exceptionText)
Checks if given key is appropriate constant for horizontal alignment, throws IAE otherwise. | | public static int | checkVerticalKey(int key, String exceptionText)
Checks if given key is appropriate constant for vertical alignment, throws IAE otherwise. | | public static String | clipString(FontMetrics fm, String text, int width)
Clips string due to the width of an area available for painting the text. | | public static int | convertLeadTrail(int value, Component c)
Converts LEADING/TRAILING to LEFT/RIGHT regarding to component orientation. | | public static void | draw3DRect(Graphics g, int x, int y, int w, int h, Color shadow, Color highlight, boolean raised)
Draws part of 3D-like rectangle with given parameters. | | public static void | drawString(Graphics g, String str, int x, int y, FontMetrics fm, Color c, int underscoreIndex)
Draws string with given font and color. | | public static void | fillArrow(Graphics g, int x, int y, int direction, int width, boolean wide, Color color)
Draws filled triangle-like arrow (for scrollbars). | | public static String | getAcceleratorText(KeyStroke acc, String delimiter)
Generates accelarator displayed text. | | public static int | getClippedUnderscoreIndex(String original, String clipped, int underscoreIndex)
Returns given index if underscored part of the string isn't clipped,
-1 otherwise. | | public static Dimension | getCompoundLabelSize(JComponent c, String text, Icon icon, int verticalTextPosition, int horizontalTextPosition, int iconTextGap)
Calculates size for the label that consists of a text message and an icon. | | public static int | getDisplayedMnemonicIndex(String text, char mnemonicChar)
Calculates mnemonic index in the text for the given keyChar. | | public static Container | getDrawingRoot(JComponent c, Rectangle paintRect)
Calculates the Container from which paint process should be started. | | public static MenuElement | getFirstSelectableItem(MenuElement[] children)
Gets first visible and enabled item from the list of MenuElements. | | public static FontMetrics | getFontMetrics(JComponent c)
Gets component FontMetrics. | | public static MenuElement[] | getMenuElementPath(MenuElement element)
Returns menu path of given menuElement up to the JMenuBar. | | public static Point | getMousePointerScreenLocation()
Returns mouse pointer location in the screen coordinates. | | public static int | getNextMatch(ListModelAccessor model, String prefix, int startIndex, Position.Bias bias)
| | public static Container | getNotWindowParent(Component c)
Returns parent of c if c is not Window decsendant,
null otherwise. | | public static Point | getPopupLocation(Rectangle anchor, Dimension size, boolean leftToRight, boolean horizontal, GraphicsConfiguration gc)
Returns optimal location to display popup based on the anchor bounds
requested, popup size and location of popup related to anchor. | | public static Point | getPopupLocation(Rectangle anchor, Dimension size, boolean leftToRight, boolean horizontal)
Gets popup location basing on the invoker position. | | final public static Dimension | getRootPaneLayoutSize(Dimension contentPaneSize, Dimension menuBarSize, Dimension titlePaneSize, Insets insets)
This function implements evaluation of maximum/minimum/preferred sizes
of JRootPane. | | public static Dimension | getStringSize(String str, FontMetrics fm)
Returns string size due to the given font metrics. | | public static MenuElement[] | getSubElements(Container menu)
Returns components that implements MenuElement interface. | | public static int | getTextY(FontMetrics fm, Rectangle textR)
Calculates the baseline for text being rendered on compound label
based on the FontMetrics and bounding rectangle y coordinate. | | public static boolean | insideString(String clipped, int underscoreIndex)
Checks if underscoreIndex is inside clipped. | | public static void | installKeyboardActions(JComponent c, int condition, String inputMapKey, String rtlInputMapKey)
Installs UI input map to the given component
also installs RTL input map if available and needed. | | public static boolean | isEmptyArray(Object[] arr)
Checks whether an array is empty, null is considered to be empty array. | | public static boolean | isEmptyArray(int[] arr)
Checks whether an array is empty, null is considered to be empty array. | | public static boolean | isEmptyString(String str)
Checks whether a string is empty, null is considered to be empty string. | | final public static boolean | isMaximumFrame(Window window)
Returns true if the parameter is a maximized frame. | | public static boolean | isMenuSubElement(MenuElement container, MenuElement element)
Returns if element is the subElement of container. | | final public static boolean | isResizableWindow(Window window)
If the window is Frame or Dialog, the function
returns true the window is resizable. | | public static boolean | isUIResource(Object obj)
Checks if object is installed by UI or null.
Parameters:
obj - Object to be checked if it is an instance of UIResource or not. | | public static boolean | isValidFirstPathElement(MenuElement item)
Checks if the given item is the valid menu path root. | | public static int | keyCharToKeyCode(char keyChar)
Converts mnemonic keyChar to keyCode. | | public static char | keyCodeToKeyChar(int keyCode)
Converts keyCode to mnemonic keyChar if possible. | | public static boolean | lookAndFeelSupportsWindowDecorations()
Checks if the currently installed Look and feel supports window
decorations. | | public static void | paintArrow(Graphics g, int x, int y, int direction, int width, boolean wide, Color color)
Draws triangle-like arrow (for scrollbars). | | public static int | range(int x, int min, int max)
Returns value that lies between given bounds. | | public static MenuElement[] | removeFromPath(MenuElement[] path, MenuElement item)
Removes element from menu selection path. | | public static int | safeIntSum(int item1, int item2)
Returns sum of two integers. | | final public static Rectangle | subtractInsets(Rectangle rect, Insets insets)
Reduces width and height of rect by insets
and moves its origin. | | final public static void | uninstallColorsAndFont(JComponent comp)
Removes colors and font installed by LookAndFeel. | | public static void | uninstallKeyboardActions(JComponent c, int condition)
Uninstalls UI InputMap from the component. |
| addInsets | | final public static Dimension addInsets(Dimension size, Insets insets)(Code) | | Enlarges size by insets size. size fields
are changed.
Parameters:
size - initial dimension
Parameters:
insets - insets to add Enlarged dimension |
| addInsets | | final public static Insets addInsets(Insets recipient, Insets addition)(Code) | | Adds values from second argument to the first one and returns first argument.
Parameters:
recipient - Insets to be enlarged
Parameters:
addition - Instes to be added to the recipient Recipient |
| addToPath | | public static MenuElement[] addToPath(MenuElement[] path, MenuElement item)(Code) | | Adds item to the corresponding place in the menu selection path.
Trims path if necessary.
Parameters:
path - old path
Parameters:
item - element being added new path including new element |
| adjustPopupLocation | | public static Point adjustPopupLocation(Point location, Dimension size, Rectangle anchor, boolean horizontal, GraphicsConfiguration gc)(Code) | | Determizes the 'optimal' popup location to provide the entire popup is shown.
Parameters:
location - Point of the proposed location
Parameters:
size - Dimension of the popup size
Parameters:
anchor - Rectangle which specified the bounds of the popup invoker
Parameters:
horizontal - boolean value representing ComponentOrientation.isHorizontal() state
Parameters:
gc - GraphicsConfiguration of the parent Window Optimal popup location |
| alignRect | | public static void alignRect(Rectangle rect, Rectangle box, int horizontalAlign, int verticalAlign)(Code) | | Aligns rectangle with the inner bounds of the box taking into account
alignments given.
Parameters:
rect - rectangle to align
Parameters:
box - box to align with
Parameters:
horizontalAlign - one of LEFT/RIGHT/CENTER
Parameters:
verticalAlign - one of TOP/BOTTOM/CENTER |
| checkHorizontalKey | | public static int checkHorizontalKey(int key, String exceptionText)(Code) | | Checks if given key is appropriate constant for horizontal alignment, throws IAE otherwise.
Parameters:
key - value to check
Parameters:
exceptionText - text of exception message given key
throws:
IllegalArgumentException - with the specified exceptionText if the key is not valid |
| checkVerticalKey | | public static int checkVerticalKey(int key, String exceptionText)(Code) | | Checks if given key is appropriate constant for vertical alignment, throws IAE otherwise.
Parameters:
key - value to check
Parameters:
exceptionText - text of exception message given key
throws:
IllegalArgumentException - with the specified exceptionText if the key is not valid |
| clipString | | public static String clipString(FontMetrics fm, String text, int width)(Code) | | Clips string due to the width of an area available for painting the text.
Parameters:
fm - FontMetrics for the text font
Parameters:
text - original (not clipped) text
Parameters:
width - width of the area available for painting the text clipped string (ending with "...") or the original string if it fits the available width |
| convertLeadTrail | | public static int convertLeadTrail(int value, Component c)(Code) | | Converts LEADING/TRAILING to LEFT/RIGHT regarding to component orientation.
Passes by any other values.
Parameters:
value - to convert
Parameters:
c - component where value is to be applied converted value |
| draw3DRect | | public static void draw3DRect(Graphics g, int x, int y, int w, int h, Color shadow, Color highlight, boolean raised)(Code) | | Draws part of 3D-like rectangle with given parameters.
See Also: java.awt.Graphics2D.draw3DRect(intintintintboolean)
Parameters:
shadow - color for dark parts of the rectangle
Parameters:
highlight - color for light parts of the rectangle
Parameters:
raised - if true left and top sides of rectangle will be drawn light |
| drawString | | public static void drawString(Graphics g, String str, int x, int y, FontMetrics fm, Color c, int underscoreIndex)(Code) | | Draws string with given font and color.
Parameters:
g - Graphics to draw on
Parameters:
str - String to draw
Parameters:
x - int representing text x-coordinate
Parameters:
y - int representing text y-coordinate
Parameters:
fm - FontMetrics of the text to draw
Parameters:
c - Color to draw with
Parameters:
underscoreIndex - int value representing underscore index to be underlined or -1 ifno underlining is required |
| fillArrow | | public static void fillArrow(Graphics g, int x, int y, int direction, int width, boolean wide, Color color)(Code) | | Draws filled triangle-like arrow (for scrollbars).
Parameters:
g - Grpahics to draw on
Parameters:
x - x-coordinate of the bounding rectangle
Parameters:
y - y-coordinate of the bounding rectangle
Parameters:
direction - of the NORTH, SOUTH, WEST, EAST
Parameters:
width - int representing size of the bounding rectangle
Parameters:
wide - boolean determining if the arrow basis should be wide
Parameters:
color - Color to fill the arrow with |
| getAcceleratorText | | public static String getAcceleratorText(KeyStroke acc, String delimiter)(Code) | | Generates accelarator displayed text.
Parameters:
acc - KeyStroke of the accelerator
Parameters:
delimiter - String representation the delimiter of the key in a key sequence Accelerator displayed text |
| getClippedUnderscoreIndex | | public static int getClippedUnderscoreIndex(String original, String clipped, int underscoreIndex)(Code) | | Returns given index if underscored part of the string isn't clipped,
-1 otherwise.
Parameters:
original - original text
Parameters:
clipped - clipped text
Parameters:
underscoreIndex - index of the character in text to beunderscored underscoreIndex or -1 if the position is clipped |
| getDisplayedMnemonicIndex | | public static int getDisplayedMnemonicIndex(String text, char mnemonicChar)(Code) | | Calculates mnemonic index in the text for the given keyChar.
Parameters:
text - text in which mnemonic index should be found
Parameters:
mnemonicChar - mnemonic char index in the text or -1 if there is no index for the specified mnemonic |
| getDrawingRoot | | public static Container getDrawingRoot(JComponent c, Rectangle paintRect)(Code) | | Calculates the Container from which paint process should be started. The result
can differ from the specified component in case component hierarchy contains
JComponents with non-optimized drawing (#see javax.swing.JComponent.isOptimizedDrawingEnabled())
and specified component is not on the top child hierarchy. Durign the calculation
paintRect should be considered to decide if its overlapped with the potentially
overlapping hierarchy or not. Is not curretnly used due to performance reasons.
Parameters:
c - JComponent to be painted
Parameters:
paintRect - region of JComponent to painted. Currently is not used due tothe performance reasons Container from which actual painting to be started |
| getFirstSelectableItem | | public static MenuElement getFirstSelectableItem(MenuElement[] children)(Code) | | Gets first visible and enabled item from the list of MenuElements.
Parameters:
children - the list of elements to select from visible and enabled element if any, null otherwise |
| getFontMetrics | | public static FontMetrics getFontMetrics(JComponent c)(Code) | | Gets component FontMetrics.
Parameters:
c - Component which FontMetrics requested Component FontMetrics correspondent to current components font |
| getMenuElementPath | | public static MenuElement[] getMenuElementPath(MenuElement element)(Code) | | Returns menu path of given menuElement up to the JMenuBar.
Parameters:
element - MenuElement which path is requested MenuElement[] representing menu path for the specified element |
| getMousePointerScreenLocation | | public static Point getMousePointerScreenLocation()(Code) | | Returns mouse pointer location in the screen coordinates.
If GraphicsEnvironment.isHeadless() returns
true or there is no mouse, null is returned.
This function should be used to determine mouse displacement
when JFrame is dragged or resized with mouse.
Point of the current mouse pointer location in the screen coordinates
See Also: java.awt.MouseInfo.getPointerInfo |
| getNextMatch | | public static int getNextMatch(ListModelAccessor model, String prefix, int startIndex, Position.Bias bias)(Code) | | Returns the index of the next element of the list according to specified
prefix, start index and bias
Parameters:
model - of the list
Parameters:
prefix - of the list element
Parameters:
startIndex - index to start search from
Parameters:
bias - index of the next element |
| getNotWindowParent | | public static Container getNotWindowParent(Component c)(Code) | | Returns parent of c if c is not Window decsendant,
null otherwise.
Parameters:
c - Component which parent is requested Container where c is located or null if specified component is Window |
| getPopupLocation | | public static Point getPopupLocation(Rectangle anchor, Dimension size, boolean leftToRight, boolean horizontal, GraphicsConfiguration gc)(Code) | | Returns optimal location to display popup based on the anchor bounds
requested, popup size and location of popup related to anchor. The optimal
location fulfills the condition popup fits on screen, not overlaps with
anchor and is verticaly or horizontaly positioned relative to anchor. If
position is vertical the popup left or right bound is aligned with
anchor bound depending on leftToRight.
Parameters:
anchor - anchor bounds relative to
Parameters:
size - requested popup size
Parameters:
leftToRight - horizontal alignment
Parameters:
horizontal - placement relative to anchor optimal popup location |
| getPopupLocation | | public static Point getPopupLocation(Rectangle anchor, Dimension size, boolean leftToRight, boolean horizontal)(Code) | | Gets popup location basing on the invoker position.
Parameters:
anchor - Rectangle which specified the bounds of the popup invoker
Parameters:
size - Dimension of the popup size
Parameters:
leftToRight - boolean value representing ComponentOrientation.isLeftToRight() state
Parameters:
horizontal - boolean value representing ComponentOrientation.isHorizontal() state Popup location |
| getRootPaneLayoutSize | | final public static Dimension getRootPaneLayoutSize(Dimension contentPaneSize, Dimension menuBarSize, Dimension titlePaneSize, Insets insets)(Code) | | This function implements evaluation of maximum/minimum/preferred sizes
of JRootPane. Depending on the size to be evaluated,
the parameters are maximum/minimum/preferred sizes of subcomponents.
Parameters:
contentPaneSize - the maximum/minimum/preferred size ofcontentPane
Parameters:
menuBarSize - the maximum/minimum/preferred size ofmenuBar; may be null
Parameters:
titlePaneSize - the maximum/minimum/preferred size oftitlePane; may be null
Parameters:
insets - the insets of JRootPane the maximum/minimum/preferred size of JRootPane |
| getStringSize | | public static Dimension getStringSize(String str, FontMetrics fm)(Code) | | Returns string size due to the given font metrics.
Parameters:
str - String which size should be calculated
Parameters:
fm - FontMetrics of the measuring String String size |
| getSubElements | | public static MenuElement[] getSubElements(Container menu)(Code) | | Returns components that implements MenuElement interface.
Parameters:
menu - container among whose components MenuElements will be looked for MenuElements array |
| getTextY | | public static int getTextY(FontMetrics fm, Rectangle textR)(Code) | | Calculates the baseline for text being rendered on compound label
based on the FontMetrics and bounding rectangle y coordinate.
Parameters:
fm - FontMetrics of the text
Parameters:
textR - Rectangle representing text bounds Y-coordinate to draw text from |
| insideString | | public static boolean insideString(String clipped, int underscoreIndex)(Code) | | Checks if underscoreIndex is inside clipped.
Parameters:
clipped - String which may be clipped (partially replaced with "...")
Parameters:
underscoreIndex - the index to check true if underscoreIndex is insideclipped.
See Also: Utilities.clipString(FontMetricsStringint) |
| installKeyboardActions | | public static void installKeyboardActions(JComponent c, int condition, String inputMapKey, String rtlInputMapKey)(Code) | | Installs UI input map to the given component
also installs RTL input map if available and needed.
Parameters:
c - component input map should be installed to
Parameters:
condition - condition for the input map
Parameters:
inputMapKey - key of the input map record in the defaults table.
Parameters:
rtlInputMapKey - key of the right-to-left input map record in the defaults table. |
| isEmptyArray | | public static boolean isEmptyArray(Object[] arr)(Code) | | Checks whether an array is empty, null is considered to be empty array.
Parameters:
arr - array to check true, if array is nullor contains 0 elements. |
| isEmptyArray | | public static boolean isEmptyArray(int[] arr)(Code) | | Checks whether an array is empty, null is considered to be empty array.
Parameters:
arr - array to check true, if array is nullor contains 0 elements. |
| isEmptyString | | public static boolean isEmptyString(String str)(Code) | | Checks whether a string is empty, null is considered to be empty string.
Parameters:
str - string to check true, if str is nullor is empty. |
| isMaximumFrame | | final public static boolean isMaximumFrame(Window window)(Code) | | Returns true if the parameter is a maximized frame.
This function can be used when implementing L&F for
JRootPane.
Parameters:
window - the window to determine if it is maximized true if the window is Frameand it is maximized |
| isMenuSubElement | | public static boolean isMenuSubElement(MenuElement container, MenuElement element)(Code) | | Returns if element is the subElement of container.
Parameters:
container - menu to look for sub element at
Parameters:
element - element to check true if element is the subElement of container,false otherwise |
| isResizableWindow | | final public static boolean isResizableWindow(Window window)(Code) | | If the window is Frame or Dialog, the function
returns true the window is resizable. Otherwise
false is returned. This function can be used
when implementing L&F for JRootPane.
Parameters:
window - the window to determine if it is resizable true if the window is Frame orDialog and is resizable, otherwisefalse is returned |
| isUIResource | | public static boolean isUIResource(Object obj)(Code) | | Checks if object is installed by UI or null.
Parameters:
obj - Object to be checked if it is an instance of UIResource or not. true if the obj instance of UIResource or null, false otherwise |
| isValidFirstPathElement | | public static boolean isValidFirstPathElement(MenuElement item)(Code) | | Checks if the given item is the valid menu path root.
Parameters:
item - MenuItem to be checked true if the specified item is valid menu path root, false otherwise |
| keyCharToKeyCode | | public static int keyCharToKeyCode(char keyChar)(Code) | | Converts mnemonic keyChar to keyCode.
Parameters:
keyChar - char to be converted to keyCode converted keyCode or the int value of keyChar. |
| keyCodeToKeyChar | | public static char keyCodeToKeyChar(int keyCode)(Code) | | Converts keyCode to mnemonic keyChar if possible. Note there is no 1 to 1 conversion.
Parameters:
keyCode - KeyCode to be converted to a char char or java.awt.event.KeyEvent.VK_UNDEFINED if conversion could not be done. |
| lookAndFeelSupportsWindowDecorations | | public static boolean lookAndFeelSupportsWindowDecorations()(Code) | | Checks if the currently installed Look and feel supports window
decorations.
true if the currently installed Look and feelis not null and supports window decorations. |
| paintArrow | | public static void paintArrow(Graphics g, int x, int y, int direction, int width, boolean wide, Color color)(Code) | | Draws triangle-like arrow (for scrollbars).
Parameters:
g - Grpahics to draw on
Parameters:
x - x-coordinate of the bounding rectangle
Parameters:
y - y-coordinate of the bounding rectangle
Parameters:
direction - of the NORTH, SOUTH, WEST, EAST
Parameters:
width - int representing size of the bounding rectangle
Parameters:
wide - boolean determining if the arrow basis should be wide
Parameters:
color - Color to draw the arrow with |
| range | | public static int range(int x, int min, int max)(Code) | | Returns value that lies between given bounds.
Parameters:
x - given value
Parameters:
min - bottom bound for x
Parameters:
max - top bound for x min if x less than min, max if x larger than max, x otherwise |
| removeFromPath | | public static MenuElement[] removeFromPath(MenuElement[] path, MenuElement item)(Code) | | Removes element from menu selection path.
Trims path if necessary.
Parameters:
path - old path
Parameters:
item - element being removed updated path |
| safeIntSum | | public static int safeIntSum(int item1, int item2)(Code) | | Returns sum of two integers. This function prevents overflow, and
if the result were greater than Integer.MAX_VALUE, the maximum
integer would be returned.
Note: this does not prevent underflow.
Parameters:
item1 - the first number
Parameters:
item2 - the second number the sum |
| subtractInsets | | final public static Rectangle subtractInsets(Rectangle rect, Insets insets)(Code) | | Reduces width and height of rect by insets
and moves its origin. The fields of insets
are not changed.
Parameters:
rect - initial rectangle, its fields will be modified
Parameters:
insets - insets to subract Area inside the insets |
| uninstallKeyboardActions | | public static void uninstallKeyboardActions(JComponent c, int condition)(Code) | | Uninstalls UI InputMap from the component.
Parameters:
c - component from which UI input map to be removed
Parameters:
condition - condition for which input map should be removed. |
|
|