com.alee.extended.image

Class WebImage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.alee.extended.image.WebImage

All Implemented Interfaces:

ToolTipMethods, EventMethods, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class WebImage
extends javax.swing.JComponent
implements EventMethods, ToolTipMethods, javax.swing.SwingConstants

This component allows you to display images in many different ways. This component uses less resources than a label and has a few optimization.

See Also:

Serialized Form

Nested Class Summary

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
WebImage() Constructs an empty image component.
WebImage(java.awt.image.BufferedImage image) Constructs component with a specified image.
WebImage(java.lang.Class nearClass, java.lang.String src) Constructs component with an image loaded from package near specified class.
WebImage(javax.swing.Icon icon) Constructs component with an image retrieved from the specified icon.
WebImage(java.awt.Image image) Constructs component with a specified image.
WebImage(javax.swing.ImageIcon icon) Constructs component with an image retrieved from the specified image icon.
WebImage(java.lang.String src) Constructs component with an image loaded from the specified path.
WebImage(java.net.URL url) Constructs component with an image loaded from the specified url.

Method Summary

Modifier and Type	Method and Description
WebCustomTooltip	addToolTip(javax.swing.Icon icon, java.lang.String tooltip) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(javax.swing.Icon icon, java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(javax.swing.Icon icon, java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay, int delay) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(javax.swing.JComponent tooltip) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(javax.swing.JComponent tooltip, int delay) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(javax.swing.JComponent tooltip, com.alee.managers.language.data.TooltipWay tooltipWay) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(javax.swing.JComponent tooltip, com.alee.managers.language.data.TooltipWay tooltipWay, int delay) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(java.lang.String tooltip) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay) Adds custom WebLaF tooltip to the component.
WebCustomTooltip	addToolTip(java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay, int delay) Adds custom WebLaF tooltip to the component.
protected void	calculateDisabledImage() Updates cached disabled image.
javax.swing.ImageIcon	geIcon() Returns icon representing current image.
protected int	getCenterX(java.awt.Insets insets) Returns image component center X coordinate.
protected int	getCenterY(java.awt.Insets insets) Returns image component center Y coordinate.
protected java.awt.image.BufferedImage	getCurrentImage() Returns currently displayed image.
DisplayType	getDisplayType() Returns image display type.
int	getHorizontalAlignment() Returns image horizontal alignment.
java.awt.image.BufferedImage	getImage() Returns current image.
int	getImageHeight() Returns image height or -1 if image was not set.
int	getImageWidth() Returns image width or -1 if image was not set.
java.awt.Insets	getMargin() Returns image margin.
float	getOpacity() Returns image opacity.
java.awt.Dimension	getPreferredSize() Returns preferred size of image component.
javax.swing.ImageIcon	getPreviewIcon() Returns icon representing last image preview.
java.awt.image.BufferedImage	getPreviewImage() Returns last image preview.
protected java.awt.image.BufferedImage	getPreviewImage(java.awt.Insets insets) Returns preview image for specified insets.
protected java.awt.Dimension	getRequiredSize() Returns component size required to fully show the image.
int	getVerticalAlignment() Returns image vertical alignment.
java.awt.event.MouseAdapter	onDoubleClick(MouseEventRunnable runnable) Shortcut method for double-click mouse event.
java.awt.event.FocusAdapter	onFocusGain(FocusEventRunnable runnable) Shortcut method for focus gain event.
java.awt.event.FocusAdapter	onFocusLoss(FocusEventRunnable runnable) Shortcut method for focus loss event.
java.awt.event.KeyAdapter	onKeyPress(HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key press event.
java.awt.event.KeyAdapter	onKeyPress(KeyEventRunnable runnable) Shortcut method for key press event.
java.awt.event.KeyAdapter	onKeyRelease(HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key release event.
java.awt.event.KeyAdapter	onKeyRelease(KeyEventRunnable runnable) Shortcut method for key release event.
java.awt.event.KeyAdapter	onKeyType(HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key type event.
java.awt.event.KeyAdapter	onKeyType(KeyEventRunnable runnable) Shortcut method for key type event.
java.awt.event.MouseAdapter	onMenuTrigger(MouseEventRunnable runnable) Shortcut method for mouse event triggering popup menu.
java.awt.event.MouseAdapter	onMouseClick(MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse click event.
java.awt.event.MouseAdapter	onMouseClick(MouseEventRunnable runnable) Shortcut method for mouse click event.
java.awt.event.MouseAdapter	onMouseDrag(MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse drag event.
java.awt.event.MouseAdapter	onMouseDrag(MouseEventRunnable runnable) Shortcut method for mouse drag event.
java.awt.event.MouseAdapter	onMouseEnter(MouseEventRunnable runnable) Shortcut method for mouse enter event.
java.awt.event.MouseAdapter	onMouseExit(MouseEventRunnable runnable) Shortcut method for mouse exit event.
java.awt.event.MouseAdapter	onMousePress(MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse press event.
java.awt.event.MouseAdapter	onMousePress(MouseEventRunnable runnable) Shortcut method for mouse press event.
protected void	paintComponent(java.awt.Graphics g) Paints image component.
void	removeToolTip(WebCustomTooltip tooltip) Removes specified custom WebLaF tooltip from the component.
void	removeToolTips() Removes all custom WebLaF tooltips from the component.
void	removeToolTips(java.util.List<WebCustomTooltip> tooltips) Removes specified custom WebLaF tooltips from the component.
void	removeToolTips(WebCustomTooltip... tooltips) Removes specified custom WebLaF tooltips from the component.
WebImage	setDisplayType(DisplayType displayType) Changes image display type.
WebImage	setHorizontalAlignment(int horizontalAlignment) Changes image horizontal alignment to the specified one.
WebImage	setIcon(javax.swing.Icon icon) Changes image to new one taken from specified icon.
WebImage	setIcon(javax.swing.ImageIcon icon) Changes image to new one taken from specified image icon.
WebImage	setImage(java.awt.image.BufferedImage image) Changes image to the specified one.
WebImage	setImage(java.awt.Image image) Changes image to the specified one.
WebImage	setMargin(java.awt.Insets margin) Changes image margin.
WebImage	setMargin(int spacing) Changes image margin.
WebImage	setMargin(int top, int left, int bottom, int right) Changes image margin.
WebImage	setOpacity(float opacity) Sets image opacity.
WebCustomTooltip	setToolTip(javax.swing.Icon icon, java.lang.String tooltip) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(javax.swing.Icon icon, java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(javax.swing.Icon icon, java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay, int delay) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(javax.swing.JComponent tooltip) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(javax.swing.JComponent tooltip, int delay) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(javax.swing.JComponent tooltip, com.alee.managers.language.data.TooltipWay tooltipWay) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(javax.swing.JComponent tooltip, com.alee.managers.language.data.TooltipWay tooltipWay, int delay) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(java.lang.String tooltip) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay) Sets single custom WebLaF tooltip into the component.
WebCustomTooltip	setToolTip(java.lang.String tooltip, com.alee.managers.language.data.TooltipWay tooltipWay, int delay) Sets single custom WebLaF tooltip into the component.
WebImage	setVerticalAlignment(int verticalAlignment) Changes image vertical alignment to the specified one.
protected void	updateBorder() Updates image component border.
protected void	updateView() Updates image component view.

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI

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, getAccessibleContext, 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

WebImage

public WebImage()

Constructs an empty image component.

WebImage

public WebImage(java.lang.String src)

Constructs component with an image loaded from the specified path.

Parameters:

src - path to image

WebImage

public WebImage(java.lang.Class nearClass,
                java.lang.String src)

Constructs component with an image loaded from package near specified class.

Parameters:

nearClass - class near which image is located

src - image file location

WebImage

public WebImage(java.net.URL url)

Constructs component with an image loaded from the specified url.

Parameters:

url - image url

WebImage

public WebImage(javax.swing.Icon icon)

Constructs component with an image retrieved from the specified icon.

Parameters:

icon - icon to process

WebImage

public WebImage(javax.swing.ImageIcon icon)

Constructs component with an image retrieved from the specified image icon.

Parameters:

icon - image icon to process

WebImage

public WebImage(java.awt.Image image)

Constructs component with a specified image.

Parameters:

image - image

WebImage

public WebImage(java.awt.image.BufferedImage image)

Constructs component with a specified image.

Parameters:

image - image

Method Detail

calculateDisabledImage

protected void calculateDisabledImage()

Updates cached disabled image.

getImageWidth

public int getImageWidth()

Returns image width or -1 if image was not set.

Returns:

image width or -1 if image was not set

getImageHeight

public int getImageHeight()

Returns image height or -1 if image was not set.

Returns:

image height or -1 if image was not set

getImage

public java.awt.image.BufferedImage getImage()

Returns current image.

Returns:

image

geIcon

public javax.swing.ImageIcon geIcon()

Returns icon representing current image.

Returns:

icon representing current image

getPreviewImage

public java.awt.image.BufferedImage getPreviewImage()

Returns last image preview. This image might be the modified version of original image set into this component.

Returns:

last image preview

getPreviewIcon

public javax.swing.ImageIcon getPreviewIcon()

Returns icon representing last image preview. This image icon might contain modified version of original image set into this component.

Returns:

icon representing last image preview

setIcon

public WebImage setIcon(javax.swing.Icon icon)

Changes image to new one taken from specified icon.

Parameters:

icon - icon to process

Returns:

this image component

setIcon

public WebImage setIcon(javax.swing.ImageIcon icon)

Changes image to new one taken from specified image icon.

Parameters:

icon - image icon to process

Returns:

this image component

setImage

public WebImage setImage(java.awt.Image image)

Changes image to the specified one.

Parameters:

image - new image

Returns:

this image component

setImage

public WebImage setImage(java.awt.image.BufferedImage image)

Changes image to the specified one.

Parameters:

image - new image

Returns:

this image component

getDisplayType

public DisplayType getDisplayType()

Returns image display type.

Returns:

image display type

setDisplayType

public WebImage setDisplayType(DisplayType displayType)

Changes image display type.

Parameters:

displayType - new image display type

Returns:

this image component

getHorizontalAlignment

public int getHorizontalAlignment()

Returns image horizontal alignment.

Returns:

image horizontal alignment

setHorizontalAlignment

public WebImage setHorizontalAlignment(int horizontalAlignment)

Changes image horizontal alignment to the specified one.

Parameters:

horizontalAlignment - new image horizontal alignment

Returns:

this image component

getVerticalAlignment

public int getVerticalAlignment()

Returns image vertical alignment.

Returns:

image vertical alignment

setVerticalAlignment

public WebImage setVerticalAlignment(int verticalAlignment)

Changes image vertical alignment to the specified one.

Parameters:

verticalAlignment - new image vertical alignment

Returns:

this image component

getOpacity

public float getOpacity()

Returns image opacity.

Returns:

image opacity

setOpacity

public WebImage setOpacity(float opacity)

Sets image opacity.

Parameters:

opacity - new image opacity

Returns:

this image component

updateView

protected void updateView()

Updates image component view.

getMargin

public java.awt.Insets getMargin()

Returns image margin.

Returns:

image margin

setMargin

public WebImage setMargin(java.awt.Insets margin)

Changes image margin.

Parameters:

margin - new image margin

Returns:

this image component

setMargin

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

Changes image margin.

Parameters:

top - top margin

left - left margin

bottom - bottom margin

right - right margin

Returns:

this image component

setMargin

public WebImage setMargin(int spacing)

Changes image margin.

Parameters:

spacing - side spacing

Returns:

this image component

updateBorder

protected void updateBorder()

Updates image component border.

paintComponent

protected void paintComponent(java.awt.Graphics g)

Paints image component.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - graphics

getCenterX

protected int getCenterX(java.awt.Insets insets)

Returns image component center X coordinate.

Parameters:

insets - image component insets

Returns:

image component center X coordinate

getCenterY

protected int getCenterY(java.awt.Insets insets)

Returns image component center Y coordinate.

Parameters:

insets - image component insets

Returns:

image component center Y coordinate

getPreviewImage

protected java.awt.image.BufferedImage getPreviewImage(java.awt.Insets insets)

Returns preview image for specified insets.

Parameters:

insets - image component insets

Returns:

preview image

getCurrentImage

protected java.awt.image.BufferedImage getCurrentImage()

Returns currently displayed image.

Returns:

currently displayed image

getPreferredSize

public java.awt.Dimension getPreferredSize()

Returns preferred size of image component.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

preferred size of image component

getRequiredSize

protected java.awt.Dimension getRequiredSize()

Returns component size required to fully show the image.

Returns:

component size required to fully show the image

onMousePress

public java.awt.event.MouseAdapter onMousePress(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse press event.

Specified by:

onMousePress in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMousePress

public java.awt.event.MouseAdapter onMousePress(MouseButton mouseButton,
                                                MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse press event.

Specified by:

onMousePress in interface EventMethods

Parameters:

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseEnter

public java.awt.event.MouseAdapter onMouseEnter(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse enter event.

Specified by:

onMouseEnter in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseExit

public java.awt.event.MouseAdapter onMouseExit(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse exit event.

Specified by:

onMouseExit in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseDrag

public java.awt.event.MouseAdapter onMouseDrag(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse drag event.

Specified by:

onMouseDrag in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseDrag

public java.awt.event.MouseAdapter onMouseDrag(MouseButton mouseButton,
                                               MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse drag event.

Specified by:

onMouseDrag in interface EventMethods

Parameters:

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseClick

public java.awt.event.MouseAdapter onMouseClick(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse click event.

Specified by:

onMouseClick in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseClick

public java.awt.event.MouseAdapter onMouseClick(MouseButton mouseButton,
                                                MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse click event.

Specified by:

onMouseClick in interface EventMethods

Parameters:

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onDoubleClick

public java.awt.event.MouseAdapter onDoubleClick(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for double-click mouse event.

Specified by:

onDoubleClick in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMenuTrigger

public java.awt.event.MouseAdapter onMenuTrigger(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse event triggering popup menu.

Specified by:

onMenuTrigger in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onKeyType

public java.awt.event.KeyAdapter onKeyType(KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key type event.

Specified by:

onKeyType in interface EventMethods

Parameters:

runnable - key event runnable

Returns:

used key adapter

onKeyType

public java.awt.event.KeyAdapter onKeyType(HotkeyData hotkey,
                                           KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key type event.

Specified by:

onKeyType in interface EventMethods

Parameters:

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onKeyPress

public java.awt.event.KeyAdapter onKeyPress(KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key press event.

Specified by:

onKeyPress in interface EventMethods

Parameters:

runnable - key event runnable

Returns:

used key adapter

onKeyPress

public java.awt.event.KeyAdapter onKeyPress(HotkeyData hotkey,
                                            KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key press event.

Specified by:

onKeyPress in interface EventMethods

Parameters:

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onKeyRelease

public java.awt.event.KeyAdapter onKeyRelease(KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key release event.

Specified by:

onKeyRelease in interface EventMethods

Parameters:

runnable - key event runnable

Returns:

used key adapter

onKeyRelease

public java.awt.event.KeyAdapter onKeyRelease(HotkeyData hotkey,
                                              KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key release event.

Specified by:

onKeyRelease in interface EventMethods

Parameters:

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onFocusGain

public java.awt.event.FocusAdapter onFocusGain(FocusEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for focus gain event.

Specified by:

onFocusGain in interface EventMethods

Parameters:

runnable - focus event runnable

Returns:

used focus adapter

onFocusLoss

public java.awt.event.FocusAdapter onFocusLoss(FocusEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for focus loss event.

Specified by:

onFocusLoss in interface EventMethods

Parameters:

runnable - focus event runnable

Returns:

used focus adapter

setToolTip

public WebCustomTooltip setToolTip(java.lang.String tooltip)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - tooltip text or language key

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.Icon icon,
                                   java.lang.String tooltip)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

icon - tooltip icon

tooltip - tooltip text or language key

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.Icon icon,
                                   java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

icon - tooltip icon

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay,
                                   int delay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.Icon icon,
                                   java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay,
                                   int delay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

icon - tooltip icon

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.JComponent tooltip)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.JComponent tooltip,
                                   int delay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.JComponent tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

tooltipWay - tooltip display direction

Returns:

created custom WebLaF tooltip

setToolTip

public WebCustomTooltip setToolTip(javax.swing.JComponent tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay,
                                   int delay)

Description copied from interface: ToolTipMethods

Sets single custom WebLaF tooltip into the component.

Specified by:

setToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

tooltipWay - tooltip display direction

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(java.lang.String tooltip)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - tooltip text or language key

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.Icon icon,
                                   java.lang.String tooltip)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

icon - tooltip icon

tooltip - tooltip text or language key

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.Icon icon,
                                   java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

icon - tooltip icon

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay,
                                   int delay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.Icon icon,
                                   java.lang.String tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay,
                                   int delay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

icon - tooltip icon

tooltip - tooltip text or language key

tooltipWay - tooltip display direction

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.JComponent tooltip)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.JComponent tooltip,
                                   int delay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.JComponent tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

tooltipWay - tooltip display direction

Returns:

created custom WebLaF tooltip

addToolTip

public WebCustomTooltip addToolTip(javax.swing.JComponent tooltip,
                                   com.alee.managers.language.data.TooltipWay tooltipWay,
                                   int delay)

Description copied from interface: ToolTipMethods

Adds custom WebLaF tooltip to the component.

Specified by:

addToolTip in interface ToolTipMethods

Parameters:

tooltip - custom tooltip component

tooltipWay - tooltip display direction

delay - tooltip display delay

Returns:

created custom WebLaF tooltip

removeToolTip

public void removeToolTip(WebCustomTooltip tooltip)

Description copied from interface: ToolTipMethods

Removes specified custom WebLaF tooltip from the component.

Specified by:

removeToolTip in interface ToolTipMethods

Parameters:

tooltip - custom WebLaF tooltip to remove

removeToolTips

public void removeToolTips()

Description copied from interface: ToolTipMethods

Removes all custom WebLaF tooltips from the component.

Specified by:

removeToolTips in interface ToolTipMethods

removeToolTips

public void removeToolTips(WebCustomTooltip... tooltips)

Description copied from interface: ToolTipMethods

Removes specified custom WebLaF tooltips from the component.

Specified by:

removeToolTips in interface ToolTipMethods

Parameters:

tooltips - custom WebLaF tooltips to remove

removeToolTips

public void removeToolTips(java.util.List<WebCustomTooltip> tooltips)

Description copied from interface: ToolTipMethods

Removes specified custom WebLaF tooltips from the component.

Specified by:

removeToolTips in interface ToolTipMethods

Parameters:

tooltips - custom WebLaF tooltips to remove