3261N/A * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 2362N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 2362N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2362N/A * or visit www.oracle.com if you need additional information or have any 0N/A * A collection of utility methods for Swing. 0N/A * <b>WARNING:</b> While this class is public, it should not be treated as 0N/A * public API and its API may change in incompatable ways between dot dot 0N/A * releases and even patch releases. You should not rely on this class even 0N/A * The <code>AppContext</code> key for our one <code>LAFState</code> 1637N/A // Maintain a cache of CACHE_SIZE fonts and the left side bearing 1637N/A // of the characters falling into the range MIN_CHAR_INDEX to 1637N/A // MAX_CHAR_INDEX. The values in fontCache are created as needed. 1637N/A // Windows defines 6 font desktop properties, we will therefore only 1637N/A // cache the metrics for 6 fonts. 1637N/A // nextIndex in fontCache to insert a font into. 1637N/A // LSBCacheEntry used to search in fontCache to see if we already 1637N/A // have an entry for a particular font 1637N/A // getLeftSideBearing will consult all characters that fall in the 1637N/A // range MIN_CHAR_INDEX to MAX_CHAR_INDEX. 0N/A * A JComponent client property is used to determine text aa settings. 0N/A * To avoid having this property persist between look and feels changes 0N/A * the value of the property is set to null in JComponent.setUI 2450N/A * Attribute key for the content elements. If it is set on an element, the 2450N/A * element is considered to be a line break. 0N/A * Used to tell a text component, being used as an editor for table 0N/A * or tree, how many clicks it took to start editing. 0N/A /* Presently this class assumes default fractional metrics. 0N/A * This may need to change to emulate future platform L&Fs. 0N/A /* These are rarely constructed objects, and only when a complete 0N/A * UI is being updated, so the cost of the tests here is minimal 0N/A * and saves tests elsewhere. 0N/A * Key used in client properties used to indicate that the 0N/A * <code>ComponentUI</code> of the JComponent instance should be returned. 0N/A /** Client Property key for the text maximal offsets for BasicMenuItemUI */ 0N/A "UNTRUSTED_CLIPBOARD_ACCESS_KEY";
0N/A //all access to charsBuffer is to be synchronized on charsBufferLock 1734N/A * Fill the character buffer cache. Return the buffer length. 0N/A * checks whether TextLayout is required to handle characters. 0N/A * @param text characters to be tested 0N/A * @param start start 0N/A * @param limit limit 0N/A * @return <tt>true</tt> if TextLayout is required 0N/A * <tt>false</tt> if TextLayout is not required 0N/A // WARNING WARNING WARNING WARNING WARNING WARNING 0N/A // Many of the following methods are invoked from older API. 0N/A // As this older API was not passed a Component, a null Component may 0N/A // now be passsed in. For example, SwingUtilities.computeStringWidth 0N/A // is implemented to call SwingUtilities2.stringWidth, the 0N/A // SwingUtilities variant does not take a JComponent, as such 0N/A // SwingUtilities2.stringWidth can be passed a null Component. 0N/A // In other words, if you add new functionality to these methods you 0N/A // need to gracefully handle null. 0N/A * Returns whether or not text should be drawn antialiased. 0N/A * @param c JComponent to test. 0N/A * @return Whether or not text should be drawn antialiased for the 0N/A * specified component. 0N/A /* a non-null property implies some form of AA requested */ 0N/A // No component, assume aa is off 0N/A * Returns the left side bearing of the first character of string. The 1637N/A * left side bearing is calculated from the passed in 1637N/A * FontMetrics. If the passed in String is less than one 1738N/A * character {@code 0} is returned. 0N/A * @param c JComponent that will display the string 0N/A * @param fm FontMetrics used to measure the String width 0N/A * @param string String to get the left side bearing for. 1738N/A * @throws NullPointerException if {@code string} is {@code null} 1738N/A * @return the left side bearing of the first character of string 1738N/A * or {@code 0} if the string is empty 1637N/A * Returns the left side bearing of the first character of string. The 0N/A * left side bearing is calculated from the passed in FontMetrics. 0N/A * @param c JComponent that will display the string 0N/A * @param fm FontMetrics used to measure the String width 0N/A * @param firstChar Character to get the left side bearing for. 1637N/A // See if we already have an entry for this pair 1637N/A // No entry for this pair, add it. 0N/A * Returns the FontMetrics for the current Font of the passed 0N/A * in Graphics. This method is used when a Graphics 0N/A * is available, typically when painting. If a Graphics is not 0N/A * available the JComponent method of the same name should be used. 0N/A * Callers should pass in a non-null JComponent, the exception 0N/A * to this is if a JComponent is not readily available at the time of 0N/A * This does not necessarily return the FontMetrics from the 0N/A * @param c JComponent requesting FontMetrics, may be null 0N/A * @param g Graphics Graphics 0N/A * Returns the FontMetrics for the specified Font. 0N/A * This method is used when a Graphics is available, typically when 0N/A * painting. If a Graphics is not available the JComponent method of 0N/A * the same name should be used. 0N/A * Callers should pass in a non-null JComonent, the exception 0N/A * to this is if a JComponent is not readily available at the time of 0N/A * This does not necessarily return the FontMetrics from the 0N/A * @param c JComponent requesting FontMetrics, may be null 0N/A * @param c Graphics Graphics 0N/A * @param font Font to get FontMetrics for 0N/A // Note: We assume that we're using the FontMetrics 0N/A // from the widget to layout out text, otherwise we can get 0N/A // mismatches when printing. 0N/A * Returns the width of the passed in String. 0N/A * If the passed String is <code>null</code>, returns zero. 0N/A * @param c JComponent that will display the string, may be null 0N/A * @param fm FontMetrics used to measure the String width 0N/A * @param string String to get the width of 0N/A * Clips the passed in String to the space provided. 0N/A * @param c JComponent that will display the string, may be null 0N/A * @param fm FontMetrics used to measure the String width 0N/A * @param string String to display 0N/A * @param availTextWidth Amount of space that the string can be drawn in 0N/A * @return Clipped string that can fit in the provided space. 0N/A * Clips the passed in String to the space provided. NOTE: this assumes 0N/A * the string does not fit in the available space. 0N/A * @param c JComponent that will display the string, may be null 0N/A * @param fm FontMetrics used to measure the String width 0N/A * @param string String to display 0N/A * @param availTextWidth Amount of space that the string can be drawn in 0N/A * @return Clipped string that can fit in the provided space. 0N/A // c may be null here. 2524N/A //can not fit any characters 0N/A * Draws the string at the specified location. 0N/A * @param c JComponent that will display the string, may be null 0N/A * @param g Graphics to draw the text to 0N/A * @param text String to display 0N/A * @param x X coordinate to draw the text at 0N/A * @param y Y coordinate to draw the text at 0N/A // All non-editable widgets that draw strings call into this 0N/A // methods. By non-editable that means widgets like JLabel, JButton 0N/A // but NOT JTextComponents. 0N/A /* The printed text must scale linearly with the UI. 0N/A * Calculate the width on screen, obtain a TextLayout with 0N/A * advances for the printer graphics FRC, and then justify 0N/A * it to fit in the screen width. This distributes the spacing 0N/A * more evenly than directly laying out to the screen advances. 0N/A /* Use alternate print color if specified */ 0N/A // If we get here we're not printing 0N/A * Draws the string at the specified location underlining the specified 0N/A * @param c JComponent that will display the string, may be null 0N/A * @param g Graphics to draw the text to 0N/A * @param text String to display 0N/A * @param underlinedIndex Index of a character in the string to underline 0N/A * @param x X coordinate to draw the text at 0N/A * @param y Y coordinate to draw the text at 0N/A * A variation of locationToIndex() which only returns an index if the 0N/A * Point is within the actual bounds of a list item (not just in the cell) 0N/A * and if the JList has the "List.isFileList" client property set. 0N/A * Otherwise, this method returns -1. 0N/A * This is used to make WindowsL&F JFileChooser act like native dialogs. 0N/A * Returns true if the given point is within the actual bounds of the 0N/A * JList item at index (not just inside the cell). 0N/A * Returns true if the given point is outside the preferredSize of the 0N/A * item at the given row of the table. (Column must be 0). 0N/A * Does not check the "Table.isFileList" property. That should be checked 0N/A * before calling this method. 0N/A * This is used to make WindowsL&F JFileChooser act like native dialogs. 0N/A // See if coords are inside 0N/A // ASSUME: mouse x,y will never be < cell's x,y 0N/A * Set the lead and anchor without affecting selection. 0N/A * Ignore mouse events if the component is null, not enabled, the event 0N/A * is not associated with the left mouse button, or the event has been 0N/A * Request focus on the given component if it doesn't already have it 0N/A * and <code>isRequestFocusEnabled()</code> returns true. 0N/A * The following draw functions have the same semantic as the 0N/A * Graphics methods with the same names. 0N/A * this is used for printing 0N/A if (
length <=
0 ) {
//no need to paint empty strings 0N/A /* Use alternate print color if specified */ 0N/A // Assume we're not printing if we get here, or that we are invoked 0N/A // via Swing text printing which is laid out for the printer. 0N/A * see documentation for drawChars 0N/A * returns the advance 0N/A /* Use alternate print color if specified */ 0N/A //matters it should not happen 0N/A * Checks if two given FontRenderContexts are compatible for printing. 0N/A * We can't just use equals as we want to exclude from the comparison : 0N/A * + whether AA is set as irrelevant for printing and shouldn't affect 0N/A * printed metrics anyway 0N/A * + any translation component in the transform of either FRC, as it 0N/A * does not affect metrics. 0N/A * Compatible means no special handling needed for text painting 0N/A private static boolean 0N/A /* If both are identity, return true */ 0N/A /* That's the end of the cheap tests, need to get and compare 0N/A * the transform matrices. We don't care about the translation 0N/A * components, so return true if they are otherwise identical. 0N/A * Tries it best to get Graphics2D out of the given Graphics 0N/A * returns null if can not derive it. 0N/A * Returns FontRenderContext associated with Component. 0N/A * FontRenderContext from Component.getFontMetrics is associated 0N/A * with the component. 0N/A * Uses Component.getFontMetrics to get the FontRenderContext from. 0N/A * A convenience method to get FontRenderContext. 0N/A * Returns the FontRenderContext for the passed in FontMetrics or 0N/A * for the passed in Component if FontMetrics is null 0N/A * This method is to be used only for JComponent.getFontMetrics. 0N/A * In all other places to get FontMetrics we need to use 0N/A * JComponent.getFontMetrics. 0N/A /* Get any FontRenderContext associated with a JComponent 0N/A * returns true if the Graphics is print Graphics 0N/A * Determines whether the SelectedTextColor should be used for painting text 0N/A * foreground for the specified highlight. 0N/A * Returns true only if the highlight painter for the specified highlight 0N/A * is the swing painter (whether inner class of javax.swing.text.DefaultHighlighter 0N/A * or com.sun.java.swing.plaf.windows.WindowsTextUI) and its background color 0N/A * is null or equals to the selection color of the text component. 0N/A * This is a hack for fixing both bugs 4761990 and 5003294 1637N/A * LSBCacheEntry is used to cache the left side bearing (lsb) for 1637N/A * a particular <code>Font</code> and <code>FontRenderContext</code>. 1637N/A * This only caches characters that fall in the range 1637N/A * <code>MIN_CHAR_INDEX</code> to <code>MAX_CHAR_INDEX</code>. 1637N/A // Used to indicate a particular entry in lsb has not been set. 1637N/A // Used in creating a GlyphVector to get the lsb 1637N/A * on the left used in colour fringe reduction. 1637N/A * Text rendering positions this correctly but here 1637N/A * we are using the glyph image to adjust that position 0N/A * here goes the fix for 4856343 [Problem with applet interaction 0N/A * with system selection clipboard] 0N/A * NOTE. In case isTrustedContext() no checking 0N/A * are to be performed 1637N/A * checks the security permissions for accessing system clipboard 1637N/A * for untrusted context (see isTrustedContext) checks the 1637N/A * permissions for the current event being handled 1637N/A * Returns true if EventQueue.getCurrentEvent() has the permissions to 0N/A * access the system clipboard 0N/A * Returns true if the given event has permissions to access the 0N/A * @param e AWTEvent to check 0N/A * returns canAccessSystemClipboard field from InputEvent 0N/A * @param ie InputEvent to get the field from 0N/A * Returns true if the given event is corrent gesture for 0N/A * accessing clipboard 0N/A * @param ie InputEvent to check 0N/A if (
ie instanceof KeyEvent) {
//we can validate only keyboard gestures 0N/A * Returns true if e has the permissions to 0N/A * access the system clipboard and if it is allowed gesture (if 0N/A * checkGesture is true) 0N/A * @param e AWTEvent to check 0N/A * @param checkGesture boolean 0N/A * Checking event permissions makes sense only for event 0N/A * Returns true if EventQueue.getCurrentEvent() has the permissions to 0N/A * access the system clipboard and if it is allowed gesture (if 0N/A * checkGesture true) 0N/A * @param checkGesture boolean 0N/A * see RFE 5012841 [Per AppContect security permissions] for the 0N/A * Utility method that creates a <code>UIDefaults.LazyValue</code> that 0N/A * creates an <code>ImageIcon</code> <code>UIResource</code> for the 0N/A * specified image file name. The image is loaded using 0N/A * <code>getResourceAsStream</code>, starting with a call to that method 0N/A * on the base class parameter. If it cannot be found, searching will 0N/A * continue through the base class' inheritance hierarchy, up to and 0N/A * including <code>rootClass</code>. 0N/A * @param baseClass the first class to use in searching for the resource 0N/A * @param rootClass an ancestor of <code>baseClass</code> to finish the 0N/A * @param imageFile the name of the file to be found 0N/A * @return a lazy value that creates the <code>ImageIcon</code> 0N/A * <code>UIResource</code> for the image, 0N/A * or null if it cannot be found 0N/A /* Copy resource into a byte array. This is 0N/A * necessary because several browsers consider 0N/A * Class.getResource a security risk because it 0N/A * can be used to load additional classes. 0N/A * Class.getResourceAsStream just returns raw 0N/A * bytes, which we can convert to an image. 0N/A /* Used to help decide if AA text rendering should be used, so 0N/A * this local display test should be additionally qualified 0N/A * against whether we have XRender support on both ends of the wire, 0N/A * as with that support remote performance may be good enough to turn 0N/A * on by default. An additional complication there is XRender does not 0N/A * appear capable of performing gamma correction needed for LCD text. 0N/A * Returns an integer from the defaults table. If <code>key</code> does 0N/A * not map to a valid <code>Integer</code>, or can not be convered from 0N/A * a <code>String</code> to an integer, the value 0 is returned. 0N/A * @param key an <code>Object</code> specifying the int. 0N/A * Returns an integer from the defaults table that is appropriate 0N/A * for the given locale. If <code>key</code> does not map to a valid 0N/A * <code>Integer</code>, or can not be convered from a <code>String</code> 0N/A * to an integer, the value 0 is returned. 0N/A * @param key an <code>Object</code> specifying the int. Returned value 0N/A * is 0 if <code>key</code> is not available, 0N/A * @param l the <code>Locale</code> for which the int is desired 0N/A * Returns an integer from the defaults table. If <code>key</code> does 0N/A * not map to a valid <code>Integer</code>, or can not be convered from 0N/A * a <code>String</code> to an integer, <code>default</code> is 0N/A * @param key an <code>Object</code> specifying the int. Returned value 0N/A * is 0 if <code>key</code> is not available, 0N/A * @param defaultValue Returned value if <code>key</code> is not available, 0N/A * or is not an Integer 0N/A * Returns an integer from the defaults table that is appropriate 0N/A * for the given locale. If <code>key</code> does not map to a valid 0N/A * <code>Integer</code>, or can not be convered from a <code>String</code> 0N/A * to an integer, <code>default</code> is returned. 0N/A * @param key an <code>Object</code> specifying the int. Returned value 0N/A * is 0 if <code>key</code> is not available, 0N/A * @param l the <code>Locale</code> for which the int is desired 0N/A * @param defaultValue Returned value if <code>key</code> is not available, 0N/A * or is not an Integer 0N/A // At this point we need this method here. But we assume that there 0N/A // will be a common method for this purpose in the future releases. 0N/A * Change focus to the visible component in {@code JTabbedPane}. 0N/A * This is not a general-purpose method and is here only to permit 0N/A * Submits a value-returning task for execution on the EDT and 0N/A * returns a Future representing the pending results of the task. 0N/A * @param task the task to submit 0N/A * @return a Future representing pending completion of the task 0N/A * @throws NullPointerException if the task is null 0N/A * Submits a Runnable task for execution on the EDT and returns a 0N/A * Future representing that task. 0N/A * @param task the task to submit 0N/A * @param result the result to return upon successful completion 0N/A * @return a Future representing pending completion of the task, 0N/A * and whose <tt>get()</tt> method will return the given 0N/A * result value upon completion 0N/A * @throws NullPointerException if the task is null 0N/A * Sends a Runnable to the EDT for the execution. 0N/A * Sets the {@code SKIP_CLICK_COUNT} client property on the component 0N/A * if it is an instance of {@code JTextComponent} with a 0N/A * {@code DefaultCaret}. This property, used for text components acting 0N/A * as editors in a table or tree, tells {@code DefaultCaret} how many 0N/A * clicks to skip before starting selection. 0N/A * Return the MouseEvent's click count, possibly reduced by the value of 0N/A * the component's {@code SKIP_CLICK_COUNT} client property. Clears 0N/A * the {@code SKIP_CLICK_COUNT} property if the mouse event's click count 0N/A * is 1. In order for clearing of the property to work correctly, there 0N/A * must be a mousePressed implementation on the caller with this 0N/A * call as the first line. 0N/A * Used by the {@code liesIn} method to return which section 0N/A * the point lies in. 0N/A /** The leading section */ 0N/A /** The middle section */ 0N/A /** The trailing section */ 0N/A * This method divides a rectangle into two or three sections along 0N/A * the specified axis and determines which section the given point 0N/A * lies in on that axis; used by drag and drop when calculating drop 0N/A * For two sections, the rectangle is divided equally and the method 0N/A * returns whether the point lies in {@code Section.LEADING} or 0N/A * {@code Section.TRAILING}. For horizontal divisions, the calculation 0N/A * respects component orientation. 0N/A * For three sections, if the rectangle is greater than or equal to 0N/A * 30 pixels in length along the axis, the calculation gives 10 pixels 0N/A * to each of the leading and trailing sections and the remainder to the 0N/A * middle. For smaller sizes, the rectangle is divided equally into three 0N/A * Note: This method assumes that the point is within the bounds of 0N/A * the given rectangle on the specified axis. However, in cases where 0N/A * it isn't, the results still have meaning: {@code Section.MIDDLE} 0N/A * remains the same, {@code Section.LEADING} indicates that the point 0N/A * is in or somewhere before the leading section, and 0N/A * {@code Section.TRAILING} indicates that the point is in or somewhere 0N/A * after the trailing section. 0N/A * @param rect the rectangle 0N/A * @param p the point the check 0N/A * @param horizontal {@code true} to use the horizontal axis, 0N/A * or {@code false} for the vertical axis 0N/A * @param ltr {@code true} for left to right orientation, 0N/A * or {@code false} for right to left orientation; 0N/A * only used for horizontal calculations 0N/A * @param three {@code true} for three sections, 0N/A * or {@code false} for two 0N/A * @return the {@code Section} where the point lies 0N/A * @throws NullPointerException if {@code rect} or {@code p} are 0N/A /* beginning of the rectangle on the axis */ 0N/A /* point on the axis we're interested in */ 0N/A /* length of the rectangle on the axis */ 0N/A /* value of ltr if horizontal, else true */ 0N/A * This method divides a rectangle into two or three sections along 0N/A * the horizontal axis and determines which section the given point 0N/A * lies in; used by drag and drop when calculating drop locations. 0N/A * See the documentation for {@link #liesIn} for more information 0N/A * on how the section is calculated. 0N/A * @param rect the rectangle 0N/A * @param p the point the check 0N/A * @param ltr {@code true} for left to right orientation, 0N/A * or {@code false} for right to left orientation 0N/A * @param three {@code true} for three sections, 0N/A * or {@code false} for two 0N/A * @return the {@code Section} where the point lies 0N/A * @throws NullPointerException if {@code rect} or {@code p} are 0N/A * This method divides a rectangle into two or three sections along 0N/A * the vertical axis and determines which section the given point 0N/A * lies in; used by drag and drop when calculating drop locations. 0N/A * See the documentation for {@link #liesIn} for more information 0N/A * on how the section is calculated. 0N/A * @param rect the rectangle 0N/A * @param p the point the check 0N/A * @param three {@code true} for three sections, 0N/A * or {@code false} for two 0N/A * @return the {@code Section} where the point lies 0N/A * @throws NullPointerException if {@code rect} or {@code p} are 2381N/A * Maps the index of the column in the view at 2381N/A * {@code viewColumnIndex} to the index of the column 2381N/A * in the table model. Returns the index of the corresponding 2381N/A * column in the model. If {@code viewColumnIndex} 2381N/A * is less than zero, returns {@code viewColumnIndex}. 2381N/A * @param cm the table model 2381N/A * @param viewColumnIndex the index of the column in the view 2381N/A * @return the index of the corresponding column in the model 2381N/A * @see JTable#convertColumnIndexToModel(int) 2381N/A * @see javax.swing.plaf.basic.BasicTableHeaderUI 2381N/A * Maps the index of the column in the {@code cm} at 2381N/A * {@code modelColumnIndex} to the index of the column 2381N/A * in the view. Returns the index of the 2381N/A * corresponding column in the view; returns {@code -1} if this column 2381N/A * is not being displayed. If {@code modelColumnIndex} is less than zero, 2381N/A * returns {@code modelColumnIndex}. 2381N/A * @param cm the table model 2381N/A * @param modelColumnIndex the index of the column in the model 2381N/A * @return the index of the corresponding column in the view 2381N/A * @see JTable#convertColumnIndexToView(int) 2381N/A * @see javax.swing.plaf.basic.BasicTableHeaderUI