com.alee.laf.label
Class WebLabel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JLabel
                  extended by com.alee.laf.label.WebLabel
All Implemented Interfaces:
LanguageMethods, ToolTipMethods, Styleable, EventMethods, FontMethods<WebLabel>, SizeMethods<WebLabel>, SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants
Direct Known Subclasses:
HotkeyTipLabel, LanguageExample.MyLabel, WebBreadcrumbLabel, WebClock, WebComboBoxElement, WebHotkeyLabel, WebLinkLabel, WebListElement, WebMemoryBar, WebRootPaneUI.TitleLabel, WebStatusLabel, WebStepLabel, WebTableCellRenderer, WebTableHeaderCellRenderer, WebTreeElement, WebVerticalLabel

public class WebLabel
extends javax.swing.JLabel
implements Styleable, EventMethods, ToolTipMethods, LanguageMethods, FontMethods<WebLabel>, SizeMethods<WebLabel>

This JLabel extension class provides a direct access to WebLabelUI methods. It also provides a few additional constructors nad methods to setup the label.

This component should never be used with a non-Web UIs as it might cause an unexpected behavior. You could still use that component even if WebLaF is not your application L&F as this component will use Web-UI in any case.

Author:
Mikle Garin
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JLabel
javax.swing.JLabel.AccessibleJLabel
 
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.JLabel
labelFor
 
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 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
WebLabel()
          Constructs empty label.
WebLabel(javax.swing.Icon icon)
          Constructs label with the specified preferences.
WebLabel(javax.swing.Icon icon, java.awt.Insets margin)
          Constructs label with the specified preferences.
WebLabel(javax.swing.Icon icon, int horizontalAlignment)
          Constructs label with the specified preferences.
WebLabel(javax.swing.Icon icon, int horizontalAlignment, java.awt.Insets margin)
          Constructs label with the specified preferences.
WebLabel(java.awt.Insets margin)
          Constructs label with the specified preferences.
WebLabel(int horizontalAlignment)
          Constructs label with the specified preferences.
WebLabel(int horizontalAlignment, java.awt.Insets margin)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, javax.swing.Icon icon)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, javax.swing.Icon icon, java.awt.Insets margin, java.lang.Object... data)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, javax.swing.Icon icon, int horizontalAlignment, java.awt.Insets margin, java.lang.Object... data)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, javax.swing.Icon icon, int horizontalAlignment, java.lang.Object... data)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, java.awt.Insets margin, java.lang.Object... data)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, int horizontalAlignment, java.awt.Insets margin, java.lang.Object... data)
          Constructs label with the specified preferences.
WebLabel(java.lang.String text, int horizontalAlignment, java.lang.Object... data)
          Constructs label with the specified preferences.
 
Method Summary
 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, TooltipWay tooltipWay)
          Adds custom WebLaF tooltip to the component.
 WebCustomTooltip addToolTip(javax.swing.Icon icon, java.lang.String tooltip, 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, TooltipWay tooltipWay)
          Adds custom WebLaF tooltip to the component.
 WebCustomTooltip addToolTip(javax.swing.JComponent tooltip, 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, TooltipWay tooltipWay)
          Adds custom WebLaF tooltip to the component.
 WebCustomTooltip addToolTip(java.lang.String tooltip, TooltipWay tooltipWay, int delay)
          Adds custom WebLaF tooltip to the component.
 WebLabel changeFontSize(int change)
          Changes font size of the specified component.
 java.lang.String getFontName()
          Returns component font name.
 int getFontSize()
          Returns component font size.
 java.awt.Insets getMargin()
          Returns label margin.
 int getMaximumHeight()
          Returns component maximum height.
 int getMaximumWidth()
          Returns component maximum width.
 int getMinimumHeight()
          Returns component minimum height.
 int getMinimumWidth()
          Returns component minimum width.
 Painter getPainter()
          Returns label painter.
 int getPreferredHeight()
          Returns component preferred height.
 java.awt.Dimension getPreferredSize()
          Returns component preferred size.
 int getPreferredWidth()
          Returns component preferred width.
 java.awt.Color getShadeColor()
          Returns text shade color.
 java.lang.String getStyleId()
          Returns component style ID.
 java.lang.Float getTransparency()
          Returns label transparency.
 WebLabelUI getWebUI()
          Returns Web-UI applied to this class.
 boolean isBoldFont()
          Returns whether component font is bold or not.
 boolean isDrawShade()
          Returns whether text shade is displayed or not.
 boolean isItalicFont()
          Returns whether component font is italic or not.
 boolean isLanguageSet()
          Returns whether this component registered in LanguageManager or not.
 boolean isPlainFont()
          Returns whether component font is plain or not.
 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.
 void removeLanguage()
          Unregisters component from LanguageManager.
 void removeLanguageUpdater()
          Unregisters any custom language updater set for this 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.
 WebLabel setBoldFont()
          Sets bold font for the component.
 WebLabel setBoldFont(boolean apply)
          Sets bold font for the component.
 WebLabel setDrawShade(boolean drawShade)
          Sets whether text shade should be displayed or not.
 WebLabel setFontName(java.lang.String fontName)
          Sets component font name.
 WebLabel setFontSize(int fontSize)
          Sets component font size.
 WebLabel setFontSizeAndStyle(int fontSize, boolean bold, boolean italic)
          Sets font size and style for the specified component.
 WebLabel setFontSizeAndStyle(int fontSize, int style)
          Sets font size and style for the specified component.
 WebLabel setFontStyle(boolean bold, boolean italic)
          Sets component font style.
 WebLabel setFontStyle(int style)
          Sets component font style.
 WebLabel setItalicFont()
          Sets italic or plain font for the component.
 WebLabel setItalicFont(boolean apply)
          Sets italic or plain font for the component.
 void setLanguage(java.lang.String key, java.lang.Object... data)
          Registers component in LanguageManager under specified key and with specified formatting data.
 void setLanguageUpdater(LanguageUpdater updater)
          Registers custom language updater for this component.
 WebLabel setMargin(java.awt.Insets margin)
          Sets label margin.
 WebLabel setMargin(int spacing)
          Sets label margin.
 WebLabel setMargin(int top, int left, int bottom, int right)
          Sets label margin.
 WebLabel setMaximumHeight(int maximumHeight)
          Sets component maximum height.
 WebLabel setMaximumWidth(int maximumWidth)
          Sets component maximum width.
 WebLabel setMinimumHeight(int minimumHeight)
          Sets component minimum height.
 WebLabel setMinimumWidth(int minimumWidth)
          Sets component minimum width.
 WebLabel setPainter(Painter painter)
          Sets label painter.
 WebLabel setPlainFont()
          Sets plain font for the component.
 WebLabel setPlainFont(boolean apply)
          Sets plain font for the component.
 WebLabel setPreferredHeight(int preferredHeight)
          Sets component preferred height.
 WebLabel setPreferredSize(int width, int height)
          Sets component preferred size.
 WebLabel setPreferredWidth(int preferredWidth)
          Sets component preferred width.
 WebLabel setShadeColor(java.awt.Color shadeColor)
          Sets text shade color.
 void setStyleId(java.lang.String id)
          Sets custom component style ID.
 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, TooltipWay tooltipWay)
          Sets single custom WebLaF tooltip into the component.
 WebCustomTooltip setToolTip(javax.swing.Icon icon, java.lang.String tooltip, 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, TooltipWay tooltipWay)
          Sets single custom WebLaF tooltip into the component.
 WebCustomTooltip setToolTip(javax.swing.JComponent tooltip, 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, TooltipWay tooltipWay)
          Sets single custom WebLaF tooltip into the component.
 WebCustomTooltip setToolTip(java.lang.String tooltip, TooltipWay tooltipWay, int delay)
          Sets single custom WebLaF tooltip into the component.
 WebLabel setTransparency(java.lang.Float transparency)
          Sets label transparency.
 void updateLanguage(java.lang.Object... data)
          Updates component language and formatting data.
 void updateLanguage(java.lang.String key, java.lang.Object... data)
          Changes component language key and updates its language and formatting data.
 void updateUI()
          Installs a Web-UI into this component.
 
Methods inherited from class javax.swing.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition
 
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, 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, 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, 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, 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

WebLabel

public WebLabel()
Constructs empty label.


WebLabel

public WebLabel(java.awt.Insets margin)
Constructs label with the specified preferences.

Parameters:
margin - label margin

WebLabel

public WebLabel(javax.swing.Icon icon)
Constructs label with the specified preferences.

Parameters:
icon - icon

WebLabel

public WebLabel(javax.swing.Icon icon,
                java.awt.Insets margin)
Constructs label with the specified preferences.

Parameters:
icon - label icon
margin - label margin

WebLabel

public WebLabel(int horizontalAlignment)
Constructs label with the specified preferences.

Parameters:
horizontalAlignment - horizontal alignment

WebLabel

public WebLabel(int horizontalAlignment,
                java.awt.Insets margin)
Constructs label with the specified preferences.

Parameters:
horizontalAlignment - horizontal alignment
margin - label margin

WebLabel

public WebLabel(javax.swing.Icon icon,
                int horizontalAlignment)
Constructs label with the specified preferences.

Parameters:
icon - label icon
horizontalAlignment - horizontal alignment

WebLabel

public WebLabel(javax.swing.Icon icon,
                int horizontalAlignment,
                java.awt.Insets margin)
Constructs label with the specified preferences.

Parameters:
icon - label icon
horizontalAlignment - horizontal alignment
margin - label margin

WebLabel

public WebLabel(java.lang.String text)
Constructs label with the specified preferences.

Parameters:
text - text or translation key

WebLabel

public WebLabel(java.lang.String text,
                java.awt.Insets margin,
                java.lang.Object... data)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
margin - label margin
data - language data, may not be passed

WebLabel

public WebLabel(java.lang.String text,
                int horizontalAlignment,
                java.lang.Object... data)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
horizontalAlignment - horizontal alignment
data - language data, may not be passed

WebLabel

public WebLabel(java.lang.String text,
                int horizontalAlignment,
                java.awt.Insets margin,
                java.lang.Object... data)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
horizontalAlignment - horizontal alignment
margin - label margin
data - language data, may not be passed

WebLabel

public WebLabel(java.lang.String text,
                javax.swing.Icon icon)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
icon - label icon

WebLabel

public WebLabel(java.lang.String text,
                javax.swing.Icon icon,
                java.awt.Insets margin,
                java.lang.Object... data)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
icon - label icon
margin - label margin
data - language data, may not be passed

WebLabel

public WebLabel(java.lang.String text,
                javax.swing.Icon icon,
                int horizontalAlignment,
                java.lang.Object... data)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
icon - label icon
horizontalAlignment - horizontal alignment
data - language data, may not be passed

WebLabel

public WebLabel(java.lang.String text,
                javax.swing.Icon icon,
                int horizontalAlignment,
                java.awt.Insets margin,
                java.lang.Object... data)
Constructs label with the specified preferences.

Parameters:
text - text or translation key
icon - label icon
horizontalAlignment - horizontal alignment
margin - label margin
data - language data, may not be passed
Method Detail

getMargin

public java.awt.Insets getMargin()
Returns label margin.

Returns:
label margin

setMargin

public WebLabel setMargin(java.awt.Insets margin)
Sets label margin.

Parameters:
margin - new label margin
Returns:
this label

setMargin

public WebLabel setMargin(int top,
                          int left,
                          int bottom,
                          int right)
Sets label margin.

Parameters:
top - top label margin
left - left label margin
bottom - bottom label margin
right - right label margin
Returns:
this label

setMargin

public WebLabel setMargin(int spacing)
Sets label margin.

Parameters:
spacing - label margin
Returns:
this label

getPainter

public Painter getPainter()
Returns label painter.

Returns:
label painter

setPainter

public WebLabel setPainter(Painter painter)
Sets label painter. Pass null to remove label painter.

Parameters:
painter - new label painter
Returns:
this label

isDrawShade

public boolean isDrawShade()
Returns whether text shade is displayed or not.

Returns:
true if text shade is displayed, false otherwise

setDrawShade

public WebLabel setDrawShade(boolean drawShade)
Sets whether text shade should be displayed or not.

Parameters:
drawShade - whether text shade should be displayed or not

getShadeColor

public java.awt.Color getShadeColor()
Returns text shade color.

Returns:
text shade color

setShadeColor

public WebLabel setShadeColor(java.awt.Color shadeColor)
Sets text shade color.

Parameters:
shadeColor - text shade color

getTransparency

public java.lang.Float getTransparency()
Returns label transparency.

Returns:
label transparency

setTransparency

public WebLabel setTransparency(java.lang.Float transparency)
Sets label transparency.

Parameters:
transparency - label transparency

getStyleId

public java.lang.String getStyleId()
Returns component style ID. Custom ID can be specified to override default component style using "setStyleId" method. If style for such custom ID is not found in skin descriptor then default style for that component is used.

Specified by:
getStyleId in interface Styleable
Returns:
component style ID

setStyleId

public void setStyleId(java.lang.String id)
Sets custom component style ID. If style for such custom ID is not found in skin descriptor default style will be used for that component. This method forces component to instantly use component style with the specified ID.

Specified by:
setStyleId in interface Styleable
Parameters:
id - custom component style ID

getWebUI

public WebLabelUI getWebUI()
Returns Web-UI applied to this class.

Returns:
Web-UI applied to this class

updateUI

public void updateUI()
Installs a Web-UI into this component.

Overrides:
updateUI in class javax.swing.JLabel

onMousePress

public java.awt.event.MouseAdapter onMousePress(MouseEventRunnable runnable)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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,
                                   TooltipWay tooltipWay)
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,
                                   TooltipWay tooltipWay)
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,
                                   TooltipWay tooltipWay,
                                   int delay)
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,
                                   TooltipWay tooltipWay,
                                   int delay)
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)
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)
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,
                                   TooltipWay tooltipWay)
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,
                                   TooltipWay tooltipWay,
                                   int delay)
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)
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)
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,
                                   TooltipWay tooltipWay)
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,
                                   TooltipWay tooltipWay)
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,
                                   TooltipWay tooltipWay,
                                   int delay)
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,
                                   TooltipWay tooltipWay,
                                   int delay)
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)
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)
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,
                                   TooltipWay tooltipWay)
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,
                                   TooltipWay tooltipWay,
                                   int delay)
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)
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()
Removes all custom WebLaF tooltips from the component.

Specified by:
removeToolTips in interface ToolTipMethods

removeToolTips

public void removeToolTips(WebCustomTooltip... tooltips)
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)
Removes specified custom WebLaF tooltips from the component.

Specified by:
removeToolTips in interface ToolTipMethods
Parameters:
tooltips - custom WebLaF tooltips to remove

setLanguage

public void setLanguage(java.lang.String key,
                        java.lang.Object... data)
Registers component in LanguageManager under specified key and with specified formatting data.

Specified by:
setLanguage in interface LanguageMethods
Parameters:
key - language record key
data - formatting data

updateLanguage

public void updateLanguage(java.lang.Object... data)
Updates component language and formatting data.

Specified by:
updateLanguage in interface LanguageMethods
Parameters:
data - new formatting data

updateLanguage

public void updateLanguage(java.lang.String key,
                           java.lang.Object... data)
Changes component language key and updates its language and formatting data.

Specified by:
updateLanguage in interface LanguageMethods
Parameters:
key - new language key
data - new formatting data

removeLanguage

public void removeLanguage()
Unregisters component from LanguageManager.

Specified by:
removeLanguage in interface LanguageMethods

isLanguageSet

public boolean isLanguageSet()
Returns whether this component registered in LanguageManager or not.

Specified by:
isLanguageSet in interface LanguageMethods
Returns:
true if component is registered in LanguageManager, false otherwise

setLanguageUpdater

public void setLanguageUpdater(LanguageUpdater updater)
Registers custom language updater for this component.

Specified by:
setLanguageUpdater in interface LanguageMethods
Parameters:
updater - component language updater

removeLanguageUpdater

public void removeLanguageUpdater()
Unregisters any custom language updater set for this component.

Specified by:
removeLanguageUpdater in interface LanguageMethods

setPlainFont

public WebLabel setPlainFont()
Sets plain font for the component.

Specified by:
setPlainFont in interface FontMethods<WebLabel>
Returns:
modified component

setPlainFont

public WebLabel setPlainFont(boolean apply)
Sets plain font for the component.

Specified by:
setPlainFont in interface FontMethods<WebLabel>
Parameters:
apply - whether to apply font changes or not
Returns:
modified component

isPlainFont

public boolean isPlainFont()
Returns whether component font is plain or not.

Specified by:
isPlainFont in interface FontMethods<WebLabel>
Returns:
true if component font is plain, false otherwise

setBoldFont

public WebLabel setBoldFont()
Sets bold font for the component.

Specified by:
setBoldFont in interface FontMethods<WebLabel>
Returns:
modified component

setBoldFont

public WebLabel setBoldFont(boolean apply)
Sets bold font for the component.

Specified by:
setBoldFont in interface FontMethods<WebLabel>
Parameters:
apply - whether to apply font changes or not
Returns:
modified component

isBoldFont

public boolean isBoldFont()
Returns whether component font is bold or not.

Specified by:
isBoldFont in interface FontMethods<WebLabel>
Returns:
true if component font is bold, false otherwise

setItalicFont

public WebLabel setItalicFont()
Sets italic or plain font for the component.

Specified by:
setItalicFont in interface FontMethods<WebLabel>
Returns:
modified component

setItalicFont

public WebLabel setItalicFont(boolean apply)
Sets italic or plain font for the component.

Specified by:
setItalicFont in interface FontMethods<WebLabel>
Parameters:
apply - whether to apply font changes or not
Returns:
modified component

isItalicFont

public boolean isItalicFont()
Returns whether component font is italic or not.

Specified by:
isItalicFont in interface FontMethods<WebLabel>
Returns:
true if component font is italic, false otherwise

setFontStyle

public WebLabel setFontStyle(boolean bold,
                             boolean italic)
Sets component font style.

Specified by:
setFontStyle in interface FontMethods<WebLabel>
Parameters:
bold - whether should set bold font or not
italic - whether should set italic font or not
Returns:
modified component

setFontStyle

public WebLabel setFontStyle(int style)
Sets component font style.

Specified by:
setFontStyle in interface FontMethods<WebLabel>
Parameters:
style - new style
Returns:
modified component

setFontSize

public WebLabel setFontSize(int fontSize)
Sets component font size.

Specified by:
setFontSize in interface FontMethods<WebLabel>
Parameters:
fontSize - font size
Returns:
modified component

changeFontSize

public WebLabel changeFontSize(int change)
Changes font size of the specified component.

Specified by:
changeFontSize in interface FontMethods<WebLabel>
Parameters:
change - font size change amount
Returns:
modified component

getFontSize

public int getFontSize()
Returns component font size.

Specified by:
getFontSize in interface FontMethods<WebLabel>
Returns:
component font size

setFontSizeAndStyle

public WebLabel setFontSizeAndStyle(int fontSize,
                                    boolean bold,
                                    boolean italic)
Sets font size and style for the specified component.

Specified by:
setFontSizeAndStyle in interface FontMethods<WebLabel>
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 WebLabel setFontSizeAndStyle(int fontSize,
                                    int style)
Sets font size and style for the specified component.

Specified by:
setFontSizeAndStyle in interface FontMethods<WebLabel>
Parameters:
fontSize - new font size
style - new style
Returns:
modified component

setFontName

public WebLabel setFontName(java.lang.String fontName)
Sets component font name.

Specified by:
setFontName in interface FontMethods<WebLabel>
Parameters:
fontName - new font name
Returns:
modified component

getFontName

public java.lang.String getFontName()
Returns component font name.

Specified by:
getFontName in interface FontMethods<WebLabel>
Returns:
component font name

getPreferredWidth

public int getPreferredWidth()
Returns component preferred width.

Specified by:
getPreferredWidth in interface SizeMethods<WebLabel>
Returns:
component preferred width

setPreferredWidth

public WebLabel setPreferredWidth(int preferredWidth)
Sets component preferred width. Pass -1 to let component choose preferred width on its own.

Specified by:
setPreferredWidth in interface SizeMethods<WebLabel>
Parameters:
preferredWidth - new component preferred width
Returns:
modified component

getPreferredHeight

public int getPreferredHeight()
Returns component preferred height.

Specified by:
getPreferredHeight in interface SizeMethods<WebLabel>
Returns:
component preferred height

setPreferredHeight

public WebLabel setPreferredHeight(int preferredHeight)
Sets component preferred height. Pass -1 to let component choose preferred height on its own.

Specified by:
setPreferredHeight in interface SizeMethods<WebLabel>
Parameters:
preferredHeight - new component preferred height
Returns:
modified component

getMinimumWidth

public int getMinimumWidth()
Returns component minimum width.

Specified by:
getMinimumWidth in interface SizeMethods<WebLabel>
Returns:
component minimum width

setMinimumWidth

public WebLabel setMinimumWidth(int minimumWidth)
Sets component minimum width. Pass -1 to let component choose minimum width on its own.

Specified by:
setMinimumWidth in interface SizeMethods<WebLabel>
Parameters:
minimumWidth - new component minimum width
Returns:
modified component

getMinimumHeight

public int getMinimumHeight()
Returns component minimum height.

Specified by:
getMinimumHeight in interface SizeMethods<WebLabel>
Returns:
component minimum height

setMinimumHeight

public WebLabel setMinimumHeight(int minimumHeight)
Sets component minimum height. Pass -1 to let component choose minimum height on its own.

Specified by:
setMinimumHeight in interface SizeMethods<WebLabel>
Parameters:
minimumHeight - new component minimum height
Returns:
modified component

getMaximumWidth

public int getMaximumWidth()
Returns component maximum width.

Specified by:
getMaximumWidth in interface SizeMethods<WebLabel>
Returns:
component maximum width

setMaximumWidth

public WebLabel setMaximumWidth(int maximumWidth)
Sets component maximum width. Pass -1 to let component choose maximum width on its own.

Specified by:
setMaximumWidth in interface SizeMethods<WebLabel>
Parameters:
maximumWidth - new component maximum width
Returns:
modified component

getMaximumHeight

public int getMaximumHeight()
Returns component maximum height.

Specified by:
getMaximumHeight in interface SizeMethods<WebLabel>
Returns:
component maximum height

setMaximumHeight

public WebLabel setMaximumHeight(int maximumHeight)
Sets component maximum height. Pass -1 to let component choose maximum height on its own.

Specified by:
setMaximumHeight in interface SizeMethods<WebLabel>
Parameters:
maximumHeight - new component maximum height
Returns:
modified component

getPreferredSize

public java.awt.Dimension getPreferredSize()
Returns component preferred size.

Specified by:
getPreferredSize in interface SizeMethods<WebLabel>
Overrides:
getPreferredSize in class javax.swing.JComponent
Returns:
component preferred size

setPreferredSize

public WebLabel setPreferredSize(int width,
                                 int height)
Sets component preferred size. This method is a simple bridge for JComponent#setPreferredSize method.

Specified by:
setPreferredSize in interface SizeMethods<WebLabel>
Parameters:
width - component preferred width
height - component preferred height
Returns:
modified component