com.alee.laf.tooltip

Class WebToolTip

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolTip

com.alee.laf.tooltip.WebToolTip

All Implemented Interfaces:

MarginSupport, PaddingSupport, ShapeProvider, Skinnable, Styleable, Paintable, FontMethods<WebToolTip>, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class WebToolTip
extends javax.swing.JToolTip
implements Styleable, Skinnable, Paintable, ShapeProvider, MarginSupport, PaddingSupport, FontMethods<WebToolTip>

This JToolTip extension class provides a direct access to WebToolTipUI methods.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JToolTip.AccessibleJToolTip

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.alee.managers.style.MarginSupport

EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport

EMPTY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
WebToolTip() Constructs empty tooltip.

Method Summary

Modifier and Type	Method and Description
void	addStyleListener(StyleListener listener) Adds style change listener.
WebToolTip	changeFontSize(int change) Changes font size of the specified component.
Painter	getCustomPainter() Returns custom base painter for this component.
Painter	getCustomPainter(java.lang.String id) Returns custom painter for this component.
java.util.Map<java.lang.String,Painter>	getCustomPainters() Returns all custom painters for this component.
java.lang.String	getFontName() Returns component font name.
int	getFontSize() Returns component font size.
java.awt.Insets	getMargin() Returns current margin.
java.awt.Insets	getPadding() Returns current padding.
Skin	getSkin() Returns skin currently applied to this component.
StyleId	getStyleId() Returns component style ID.
boolean	isBoldFont() Returns whether component font is bold or not.
boolean	isItalicFont() Returns whether component font is italic or not.
boolean	isPlainFont() Returns whether component font is plain or not.
java.awt.Shape	provideShape() Returns component shape.
void	removeStyleListener(StyleListener listener) Removes style change listener.
boolean	restoreDefaultPainters() Restores default painters for this component.
Skin	restoreSkin() Restores global skin for this component and all of its children linked via StyleId.
WebToolTip	setBoldFont() Sets bold font for the component.
WebToolTip	setBoldFont(boolean apply) Sets bold font for the component.
Painter	setCustomPainter(Painter painter) Sets custom base painter for this component.
Painter	setCustomPainter(java.lang.String id, Painter painter) Sets custom painter for this component under the specified painter ID.
WebToolTip	setFontName(java.lang.String fontName) Sets component font name.
WebToolTip	setFontSize(int fontSize) Sets component font size.
WebToolTip	setFontSizeAndStyle(int fontSize, boolean bold, boolean italic) Sets font size and style for the specified component.
WebToolTip	setFontSizeAndStyle(int fontSize, int style) Sets font size and style for the specified component.
WebToolTip	setFontStyle(boolean bold, boolean italic) Sets component font style.
WebToolTip	setFontStyle(int style) Sets component font style.
WebToolTip	setItalicFont() Sets italic or plain font for the component.
WebToolTip	setItalicFont(boolean apply) Sets italic or plain font for the component.
void	setMargin(java.awt.Insets margin) Sets new margin.
void	setMargin(int margin) Sets new margin.
void	setMargin(int top, int left, int bottom, int right) Sets new margin.
void	setPadding(java.awt.Insets padding) Sets new padding.
void	setPadding(int padding) Sets new padding.
void	setPadding(int top, int left, int bottom, int right) Sets new padding.
WebToolTip	setPlainFont() Sets plain font for the component.
WebToolTip	setPlainFont(boolean apply) Sets plain font for the component.
Skin	setSkin(Skin skin) Applies specified skin to the specified component and all of its children linked via StyleId.
Skin	setSkin(Skin skin, boolean recursively) Applies specified skin to the specified component and all of its children linked via StyleId.
StyleId	setStyleId(StyleId id) Sets new component style ID.
void	updateUI() Installs a Web-UI into this component.

Methods inherited from class javax.swing.JToolTip

getAccessibleContext, getComponent, getTipText, getUI, getUIClassID, paramString, setComponent, setTipText

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setToolTipText, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

WebToolTip

public WebToolTip()

Constructs empty tooltip.

Method Detail

getStyleId

public StyleId getStyleId()

Description copied from interface: Styleable

Returns component style ID.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public StyleId setStyleId(StyleId id)

Description copied from interface: Styleable

Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

Returns:

previously used style ID

getSkin

public Skin getSkin()

Description copied from interface: Skinnable

Returns skin currently applied to this component.

Specified by:

getSkin in interface Skinnable

Returns:

skin currently applied to this component

setSkin

public Skin setSkin(Skin skin)

Description copied from interface: Skinnable

Applies specified skin to the specified component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Specified by:

setSkin in interface Skinnable

Parameters:

skin - skin to be applied

Returns:

previously applied skin

setSkin

public Skin setSkin(Skin skin,
                    boolean recursively)

Description copied from interface: Skinnable

Applies specified skin to the specified component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Specified by:

setSkin in interface Skinnable

Parameters:

skin - skin to be applied

recursively - whether or not should apply skin to child components

Returns:

previously applied skin

restoreSkin

public Skin restoreSkin()

Description copied from interface: Skinnable

Restores global skin for this component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Restoring component skin will also include it back into the skin update cycle in case global skin will be changed.

Specified by:

restoreSkin in interface Skinnable

Returns:

skin applied to this component after restoration

addStyleListener

public void addStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Adds style change listener.

Specified by:

addStyleListener in interface Skinnable

Parameters:

listener - style change listener to add

removeStyleListener

public void removeStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Removes style change listener.

Specified by:

removeStyleListener in interface Skinnable

Parameters:

listener - style change listener to remove

getCustomPainters

public java.util.Map<java.lang.String,Painter> getCustomPainters()

Description copied from interface: Paintable

Returns all custom painters for this component.

Specified by:

getCustomPainters in interface Paintable

Returns:

all custom painters for this component

getCustomPainter

public Painter getCustomPainter()

Description copied from interface: Paintable

Returns custom base painter for this component.

Specified by:

getCustomPainter in interface Paintable

Returns:

custom base painter for this component

getCustomPainter

public Painter getCustomPainter(java.lang.String id)

Description copied from interface: Paintable

Returns custom painter for this component.

Specified by:

getCustomPainter in interface Paintable

Parameters:

id - painter ID

Returns:

custom painter for this component

setCustomPainter

public Painter setCustomPainter(Painter painter)

Description copied from interface: Paintable

Sets custom base painter for this component.

Specified by:

setCustomPainter in interface Paintable

Parameters:

painter - custom base painter

Returns:

previously set custom base painter

setCustomPainter

public Painter setCustomPainter(java.lang.String id,
                                Painter painter)

Description copied from interface: Paintable

Sets custom painter for this component under the specified painter ID.

Specified by:

setCustomPainter in interface Paintable

Parameters:

id - painter ID

painter - painter

Returns:

old custom painter

restoreDefaultPainters

public boolean restoreDefaultPainters()

Description copied from interface: Paintable

Restores default painters for this component.

Specified by:

restoreDefaultPainters in interface Paintable

Returns:

true if default painters were restored, false otherwise

provideShape

public java.awt.Shape provideShape()

Description copied from interface: ShapeProvider

Returns component shape.

Specified by:

provideShape in interface ShapeProvider

Returns:

component shape

getMargin

public java.awt.Insets getMargin()

Description copied from interface: MarginSupport

Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.

Specified by:

getMargin in interface MarginSupport

Returns:

current margin

setMargin

public void setMargin(int margin)

Sets new margin.

Parameters:

margin - new margin

setMargin

public void setMargin(int top,
                      int left,
                      int bottom,
                      int right)

Sets new margin.

Parameters:

top - new top margin

left - new left margin

bottom - new bottom margin

right - new right margin

setMargin

public void setMargin(java.awt.Insets margin)

Description copied from interface: MarginSupport

Sets new margin. null can be provided to set an empty [0,0,0,0] margin.

Specified by:

setMargin in interface MarginSupport

Parameters:

margin - new margin

getPadding

public java.awt.Insets getPadding()

Description copied from interface: PaddingSupport

Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.

Specified by:

getPadding in interface PaddingSupport

Returns:

current padding

setPadding

public void setPadding(int padding)

Sets new padding.

Parameters:

padding - new padding

setPadding

public void setPadding(int top,
                       int left,
                       int bottom,
                       int right)

Sets new padding.

Parameters:

top - new top padding

left - new left padding

bottom - new bottom padding

right - new right padding

setPadding

public void setPadding(java.awt.Insets padding)

Description copied from interface: PaddingSupport

Sets new padding. null can be provided to set an empty [0,0,0,0] padding.

Specified by:

setPadding in interface PaddingSupport

Parameters:

padding - new padding

updateUI

public void updateUI()

Installs a Web-UI into this component.

Overrides:

updateUI in class javax.swing.JToolTip

setPlainFont

public WebToolTip setPlainFont()

Description copied from interface: FontMethods

Sets plain font for the component.

Specified by:

setPlainFont in interface FontMethods<WebToolTip>

Returns:

modified component

isPlainFont

public boolean isPlainFont()

Description copied from interface: FontMethods

Returns whether component font is plain or not.

Specified by:

isPlainFont in interface FontMethods<WebToolTip>

Returns:

true if component font is plain, false otherwise

setPlainFont

public WebToolTip setPlainFont(boolean apply)

Description copied from interface: FontMethods

Sets plain font for the component.

Specified by:

setPlainFont in interface FontMethods<WebToolTip>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

setBoldFont

public WebToolTip setBoldFont()

Description copied from interface: FontMethods

Sets bold font for the component.

Specified by:

setBoldFont in interface FontMethods<WebToolTip>

Returns:

modified component

isBoldFont

public boolean isBoldFont()

Description copied from interface: FontMethods

Returns whether component font is bold or not.

Specified by:

isBoldFont in interface FontMethods<WebToolTip>

Returns:

true if component font is bold, false otherwise

setBoldFont

public WebToolTip setBoldFont(boolean apply)

Description copied from interface: FontMethods

Sets bold font for the component.

Specified by:

setBoldFont in interface FontMethods<WebToolTip>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

setItalicFont

public WebToolTip setItalicFont()

Description copied from interface: FontMethods

Sets italic or plain font for the component.

Specified by:

setItalicFont in interface FontMethods<WebToolTip>

Returns:

modified component

isItalicFont

public boolean isItalicFont()

Description copied from interface: FontMethods

Returns whether component font is italic or not.

Specified by:

isItalicFont in interface FontMethods<WebToolTip>

Returns:

true if component font is italic, false otherwise

setItalicFont

public WebToolTip setItalicFont(boolean apply)

Description copied from interface: FontMethods

Sets italic or plain font for the component.

Specified by:

setItalicFont in interface FontMethods<WebToolTip>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

setFontStyle

public WebToolTip setFontStyle(boolean bold,
                               boolean italic)

Description copied from interface: FontMethods

Sets component font style.

Specified by:

setFontStyle in interface FontMethods<WebToolTip>

Parameters:

bold - whether should set bold font or not

italic - whether should set italic font or not

Returns:

modified component

setFontStyle

public WebToolTip setFontStyle(int style)

Description copied from interface: FontMethods

Sets component font style.

Specified by:

setFontStyle in interface FontMethods<WebToolTip>

Parameters:

style - new style

Returns:

modified component

changeFontSize

public WebToolTip changeFontSize(int change)

Description copied from interface: FontMethods

Changes font size of the specified component.

Specified by:

changeFontSize in interface FontMethods<WebToolTip>

Parameters:

change - font size change amount

Returns:

modified component

getFontSize

public int getFontSize()

Description copied from interface: FontMethods

Returns component font size.

Specified by:

getFontSize in interface FontMethods<WebToolTip>

Returns:

component font size

setFontSize

public WebToolTip setFontSize(int fontSize)

Description copied from interface: FontMethods

Sets component font size.

Specified by:

setFontSize in interface FontMethods<WebToolTip>

Parameters:

fontSize - font size

Returns:

modified component

setFontSizeAndStyle

public WebToolTip setFontSizeAndStyle(int fontSize,
                                      boolean bold,
                                      boolean italic)

Description copied from interface: FontMethods

Sets font size and style for the specified component.

Specified by:

setFontSizeAndStyle in interface FontMethods<WebToolTip>

Parameters:

fontSize - new font size

bold - whether should set bold font or not

italic - whether should set italic font or not

Returns:

modified component

setFontSizeAndStyle

public WebToolTip setFontSizeAndStyle(int fontSize,
                                      int style)

Description copied from interface: FontMethods

Sets font size and style for the specified component.

Specified by:

setFontSizeAndStyle in interface FontMethods<WebToolTip>

Parameters:

fontSize - new font size

style - new style

Returns:

modified component

getFontName

public java.lang.String getFontName()

Description copied from interface: FontMethods

Returns component font name.

Specified by:

getFontName in interface FontMethods<WebToolTip>

Returns:

component font name

setFontName

public WebToolTip setFontName(java.lang.String fontName)

Description copied from interface: FontMethods

Sets component font name.

Specified by:

setFontName in interface FontMethods<WebToolTip>

Parameters:

fontName - new font name

Returns:

modified component