javax.swing.plaf.metal

Class MetalToolTipUI


public class MetalToolTipUI
extends BasicToolTipUI

A UI delegate for the JToolTip component.

Field Summary

static int
padSpaceBetweenStrings
The amount of space between the tool tip text and the accelerator description (if visible).

Constructor Summary

MetalToolTipUI()
Constructs a new instance of MetalToolTipUI.

Method Summary

static ComponentUI
createUI(JComponent component)
Returns a shared instance of the MetalToolTipUI class.
String
getAcceleratorString()
Returns a string representing the accelerator key (if there is one) for the component that the tool tip belongs to.
Dimension
getPreferredSize(JComponent c)
Returns the preferred size for the JToolTip component.
void
installUI(JComponent c)
Installs the UI for the specified component (a JToolTip).
protected boolean
isAcceleratorHidden()
Returns true if the accelerator string is hidden, and false otherwise.
void
paint(Graphics g, JComponent c)
Paints the tool tip.
void
uninstallUI(JComponent c)
Clears the defaults set in installUI(JComponent).

Methods inherited from class javax.swing.plaf.basic.BasicToolTipUI

createUI, getMaximumSize, getMinimumSize, getPreferredSize, installDefaults, installListeners, installUI, paint, uninstallDefaults, uninstallListeners, uninstallUI

Methods inherited from class javax.swing.plaf.ComponentUI

contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

padSpaceBetweenStrings

public static final int padSpaceBetweenStrings
The amount of space between the tool tip text and the accelerator description (if visible).
Field Value:
12

Constructor Details

MetalToolTipUI

public MetalToolTipUI()
Constructs a new instance of MetalToolTipUI.

Method Details

createUI

public static ComponentUI createUI(JComponent component)
Returns a shared instance of the MetalToolTipUI class. Although this UI delegate does maintain state information, there is never more than one tool tip visible, so it is OK to use a shared instance.
Overrides:
createUI in interface BasicToolTipUI
Parameters:
component - the component (a JToolTip).
Returns:
A shared instance of the MetalToolTipUI class.

getAcceleratorString

public String getAcceleratorString()
Returns a string representing the accelerator key (if there is one) for the component that the tool tip belongs to.
Returns:
A string representing the accelerator key.

getPreferredSize

public Dimension getPreferredSize(JComponent c)
Returns the preferred size for the JToolTip component.
Overrides:
getPreferredSize in interface BasicToolTipUI
Parameters:
c - the component (a JToolTip).
Returns:
The preferred size.

installUI

public void installUI(JComponent c)
Installs the UI for the specified component (a JToolTip).
Overrides:
installUI in interface BasicToolTipUI
Parameters:
c - the JToolTip component.

isAcceleratorHidden

protected boolean isAcceleratorHidden()
Returns true if the accelerator string is hidden, and false otherwise. This setting is controlled by the ToolTip.hideAccelerator entry in the UI defaults table.
Returns:
A boolean.

paint

public void paint(Graphics g,
                  JComponent c)
Paints the tool tip.
Overrides:
paint in interface BasicToolTipUI
Parameters:
g - the graphics context.
c - the JToolTip component.

uninstallUI

public void uninstallUI(JComponent c)
Clears the defaults set in installUI(JComponent).
Overrides:
uninstallUI in interface BasicToolTipUI
Parameters:
c - the component.

MetalToolTipUI.java Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.