org.japura.gui
Class ToolTipButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.japura.gui.ToolTipButton

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ToolTipButton
extends javax.swing.JPanel

Button with a tooltip function.

The tooltip text is wrapped with a defined width.

Copyright (C) 2009-2012 Carlos Eduardo Leite de Andrade

This library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see www.gnu.org/licenses/

For more information, contact: www.japura.org

Author:

Carlos Eduardo Leite de Andrade

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ToolTipButton(javax.swing.Icon image)
Constructor

ToolTipButton(javax.swing.Icon image, javax.swing.Icon imageMouseOver, java.lang.String tooltip)
Constructor

ToolTipButton(javax.swing.Icon image, javax.swing.Icon imageMouseOver, java.lang.String tooltip, java.awt.Color toolTipBackground)
Constructor

ToolTipButton(javax.swing.Icon image, java.lang.String tooltip)
Constructor

Method Summary

java.lang.String	getText()
java.awt.Color	getToolTipBackground()
java.awt.Color	getTooltipBorderColor()
int	getTooltipBorderThickness() Get the border width.
int	getTooltipDelay()
java.awt.Insets	getTooltipMargin()
int	getToolTipWrapWidth() Get the tooltip text wrap width.
void	setText(java.lang.String text)
void	setToolTipBackground(java.awt.Color toolTipBackground)
void	setTooltipBorderColor(java.awt.Color borderColor)
void	setTooltipBorderThickness(int thickness) Set the border width.
void	setTooltipDelay(int delay)
void	setTooltipMargin(java.awt.Insets margin)
void	setToolTipText(java.lang.String text)
void	setToolTipWrapWidth(int toolTipWrapWidth) Set the tooltip text wrap width.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolTipButton

public ToolTipButton(javax.swing.Icon image)

Constructor

Parameters:

image - Icon - image for tooltip button

ToolTipButton

public ToolTipButton(javax.swing.Icon image,
                     java.lang.String tooltip)

Constructor

Parameters:

image - Icon - image for tooltip button

tooltip - String - tooltip text

ToolTipButton

public ToolTipButton(javax.swing.Icon image,
                     javax.swing.Icon imageMouseOver,
                     java.lang.String tooltip)

Constructor

Parameters:

image - Icon - image for tooltip button

imageMouseOver - Icon - image for mouse over tooltip button

tooltip - String - tooltip text

ToolTipButton

public ToolTipButton(javax.swing.Icon image,
                     javax.swing.Icon imageMouseOver,
                     java.lang.String tooltip,
                     java.awt.Color toolTipBackground)

Constructor

Parameters:

image - Icon - image for tooltip button

imageMouseOver - Icon - image for mouse over tooltip button

tooltip - String - tooltip text

toolTipBackground - Color - tooltip background

Method Detail

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

setToolTipText

public void setToolTipText(java.lang.String text)

Overrides:

setToolTipText in class javax.swing.JComponent

getTooltipDelay

public int getTooltipDelay()

setTooltipDelay

public void setTooltipDelay(int delay)

getTooltipMargin

public java.awt.Insets getTooltipMargin()

setTooltipMargin

public void setTooltipMargin(java.awt.Insets margin)

setTooltipBorderThickness

public void setTooltipBorderThickness(int thickness)

Set the border width.

Parameters:

thickness - an integer specifying the width in pixels

getTooltipBorderThickness

public int getTooltipBorderThickness()

Get the border width.

Returns:

an integer specifying the width in pixels

getTooltipBorderColor

public java.awt.Color getTooltipBorderColor()

setTooltipBorderColor

public void setTooltipBorderColor(java.awt.Color borderColor)

getToolTipBackground

public java.awt.Color getToolTipBackground()

setToolTipBackground

public void setToolTipBackground(java.awt.Color toolTipBackground)

getToolTipWrapWidth

public int getToolTipWrapWidth()

Get the tooltip text wrap width.

Returns:

int

setToolTipWrapWidth

public void setToolTipWrapWidth(int toolTipWrapWidth)

Set the tooltip text wrap width.

The minimal value is 200

Parameters:

toolTipWrapWidth - int