com.alee.extended.breadcrumb

Class WebBreadcrumbLabel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

com.alee.laf.label.WebLabel

com.alee.extended.breadcrumb.WebBreadcrumbLabel

All Implemented Interfaces:

BreadcrumbElement, com.alee.managers.language.LanguageMethods, MarginSupport, PaddingSupport, ShapeProvider, Skinnable, Styleable, ToolTipMethods, Paintable, EventMethods, FontMethods<WebLabel>, SizeMethods<WebLabel>, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

public class WebBreadcrumbLabel
extends WebLabel
implements BreadcrumbElement

Custom label that can be used as WebBreadcrumb element. It has its own unique styling and progress display.

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

Modifier and Type	Field and Description
protected float	progress
protected boolean	showProgress

Fields inherited from class javax.swing.JLabel

labelFor

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 com.alee.utils.swing.SizeMethods

UNDEFINED

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
WebBreadcrumbLabel()
WebBreadcrumbLabel(javax.swing.Icon icon)
WebBreadcrumbLabel(javax.swing.Icon icon, int horizontalAlignment)
WebBreadcrumbLabel(int horizontalAlignment)
WebBreadcrumbLabel(java.lang.String text)
WebBreadcrumbLabel(java.lang.String text, javax.swing.Icon icon)
WebBreadcrumbLabel(java.lang.String text, javax.swing.Icon icon, int horizontalAlignment, java.lang.Object... data)
WebBreadcrumbLabel(java.lang.String text, int horizontalAlignment, java.lang.Object... data)
WebBreadcrumbLabel(StyleId id)
WebBreadcrumbLabel(StyleId id, javax.swing.Icon icon)
WebBreadcrumbLabel(StyleId id, javax.swing.Icon icon, int horizontalAlignment)
WebBreadcrumbLabel(StyleId id, int horizontalAlignment)
WebBreadcrumbLabel(StyleId id, java.lang.String text)
WebBreadcrumbLabel(StyleId id, java.lang.String text, javax.swing.Icon icon)
WebBreadcrumbLabel(StyleId id, java.lang.String text, javax.swing.Icon icon, int horizontalAlignment, java.lang.Object... data)
WebBreadcrumbLabel(StyleId id, java.lang.String text, int horizontalAlignment, java.lang.Object... data)

Method Summary

Modifier and Type	Method and Description
boolean	contains(int x, int y)
float	getProgress() Returns element progress value.
boolean	isShowProgress() Returns whether element progress should be displayed or not.
void	setProgress(float progress) Sets element progress value.
void	setShowProgress(boolean showProgress) Sets whether element progress should be displayed or not.

Methods inherited from class com.alee.laf.label.WebLabel

addStyleListener, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, changeFontSize, getCustomPainter, getCustomPainter, getCustomPainters, getFontName, getFontSize, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getPadding, getPreferredHeight, getPreferredSize, getPreferredWidth, getSkin, getStyleId, isBoldFont, isItalicFont, isLanguageSet, isPlainFont, onDoubleClick, onFocusGain, onFocusLoss, onKeyPress, onKeyPress, onKeyRelease, onKeyRelease, onKeyType, onKeyType, onMenuTrigger, onMouseClick, onMouseClick, onMouseDrag, onMouseDrag, onMouseEnter, onMouseExit, onMousePress, onMousePress, provideShape, removeLanguage, removeLanguageUpdater, removeStyleListener, removeToolTip, removeToolTips, removeToolTips, removeToolTips, restoreDefaultPainters, restoreSkin, setBoldFont, setBoldFont, setCustomPainter, setCustomPainter, setFontName, setFontSize, setFontSizeAndStyle, setFontSizeAndStyle, setFontStyle, setFontStyle, setItalicFont, setItalicFont, setLanguage, setLanguageUpdater, setMargin, setMargin, setMargin, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumWidth, setPadding, setPadding, setPadding, setPlainFont, setPlainFont, setPreferredHeight, setPreferredSize, setPreferredWidth, setSkin, setSkin, setStyleId, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, updateLanguage, updateLanguage, updateUI

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

Field Detail

showProgress

protected boolean showProgress

progress

protected float progress

Constructor Detail

WebBreadcrumbLabel

public WebBreadcrumbLabel()

WebBreadcrumbLabel

public WebBreadcrumbLabel(javax.swing.Icon icon)

WebBreadcrumbLabel

public WebBreadcrumbLabel(int horizontalAlignment)

WebBreadcrumbLabel

public WebBreadcrumbLabel(javax.swing.Icon icon,
                          int horizontalAlignment)

WebBreadcrumbLabel

public WebBreadcrumbLabel(java.lang.String text)

WebBreadcrumbLabel

public WebBreadcrumbLabel(java.lang.String text,
                          int horizontalAlignment,
                          java.lang.Object... data)

WebBreadcrumbLabel

public WebBreadcrumbLabel(java.lang.String text,
                          javax.swing.Icon icon)

WebBreadcrumbLabel

public WebBreadcrumbLabel(java.lang.String text,
                          javax.swing.Icon icon,
                          int horizontalAlignment,
                          java.lang.Object... data)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          javax.swing.Icon icon)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          int horizontalAlignment)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          javax.swing.Icon icon,
                          int horizontalAlignment)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          java.lang.String text)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          java.lang.String text,
                          int horizontalAlignment,
                          java.lang.Object... data)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          java.lang.String text,
                          javax.swing.Icon icon)

WebBreadcrumbLabel

public WebBreadcrumbLabel(StyleId id,
                          java.lang.String text,
                          javax.swing.Icon icon,
                          int horizontalAlignment,
                          java.lang.Object... data)

Method Detail

setShowProgress

public void setShowProgress(boolean showProgress)

Description copied from interface: BreadcrumbElement

Sets whether element progress should be displayed or not.

Specified by:

setShowProgress in interface BreadcrumbElement

Parameters:

showProgress - whether element progress should be displayed or not

isShowProgress

public boolean isShowProgress()

Description copied from interface: BreadcrumbElement

Returns whether element progress should be displayed or not.

Specified by:

isShowProgress in interface BreadcrumbElement

Returns:

true if element progress should be displayed, false otherwise

setProgress

public void setProgress(float progress)

Description copied from interface: BreadcrumbElement

Sets element progress value. This value should be between 0f and 1f.

Specified by:

setProgress in interface BreadcrumbElement

Parameters:

progress - new element progress value

getProgress

public float getProgress()

Description copied from interface: BreadcrumbElement

Returns element progress value. This value is between 0f and 1f.

Specified by:

getProgress in interface BreadcrumbElement

Returns:

element progress value

contains

public boolean contains(int x,
                        int y)

Overrides:

contains in class javax.swing.JComponent