com.alee.extended.statusbar

Class WebStatusBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.alee.extended.statusbar.WebStatusBar

All Implemented Interfaces:

com.alee.managers.language.LanguageContainerMethods, MarginSupport, PaddingSupport, ShapeProvider, Skinnable, Styleable, Paintable, SizeMethods<WebStatusBar>, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class WebStatusBar
extends javax.swing.JComponent
implements Styleable, Skinnable, Paintable, ShapeProvider, MarginSupport, PaddingSupport, SizeMethods<WebStatusBar>, com.alee.managers.language.LanguageContainerMethods

Implementation of status bar panel. It is a container that is usually used at the bottom side of the application UI and contains some status information.

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 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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
WebStatusBar() Constructs new status bar.
WebStatusBar(StyleId id) Constructs new status bar.

Method Summary

Modifier and Type	Method and Description
void	addFill(java.awt.Component component) Adds component to the fill status bar area.
void	addSeparator() Adds separator to the start of the status bar.
void	addSeparator(java.lang.String constraints) Adds separator under the specified constaints.
void	addSeparatorToEnd() Adds separator to the end of the status bar.
void	addStyleListener(StyleListener listener) Adds style change listener.
void	addToEnd(java.awt.Component component) Adds component to the end of the status bar.
void	addToMiddle(java.awt.Component component) Adds component to the middle status bar area.
protected WebSeparator	createSeparator() Returns new status bar separator.
Painter	getCustomPainter() Returns custom base painter for this component.
Painter	getCustomPainter(java.lang.String id) Returns custom painter for this component.
java.util.Map<java.lang.String,Painter>	getCustomPainters() Returns all custom painters for this component.
java.lang.String	getLanguageContainerKey()
java.awt.Insets	getMargin() Returns current 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.
java.awt.Insets	getPadding() Returns current padding.
int	getPreferredHeight() Returns component preferred height.
int	getPreferredWidth() Returns component preferred width.
Skin	getSkin() Returns skin currently applied to this component.
StyleId	getStyleId() Returns component style ID.
StatusBarUI	getUI() Returns the look and feel (L&F) object that renders this component.
java.lang.String	getUIClassID()
WebStatusBarUI	getWebUI() Returns Web-UI applied to this class.
java.awt.Shape	provideShape() Returns component shape.
void	removeLanguageContainerKey()
void	removeStyleListener(StyleListener listener) Removes style change listener.
boolean	restoreDefaultPainters() Restores default painters for this component.
Skin	restoreSkin() Restores global skin for this component and all of its children linked via StyleId.
Painter	setCustomPainter(Painter painter) Sets custom base painter for this component.
Painter	setCustomPainter(java.lang.String id, Painter painter) Sets custom painter for this component under the specified painter ID.
void	setLanguageContainerKey(java.lang.String key)
void	setMargin(java.awt.Insets margin) Sets new margin.
void	setMargin(int margin) Sets new margin.
void	setMargin(int top, int left, int bottom, int right) Sets new margin.
WebStatusBar	setMaximumHeight(int maximumHeight) Sets component maximum height.
WebStatusBar	setMaximumWidth(int maximumWidth) Sets component maximum width.
WebStatusBar	setMinimumHeight(int minimumHeight) Sets component minimum height.
WebStatusBar	setMinimumWidth(int minimumWidth) Sets component minimum width.
void	setPadding(java.awt.Insets padding) Sets new padding.
void	setPadding(int padding) Sets new padding.
void	setPadding(int top, int left, int bottom, int right) Sets new padding.
WebStatusBar	setPreferredHeight(int preferredHeight) Sets component preferred height.
WebStatusBar	setPreferredSize(int width, int height) Sets component preferred size.
WebStatusBar	setPreferredWidth(int preferredWidth) Sets component preferred width.
Skin	setSkin(Skin skin) Applies specified skin to the specified component and all of its children linked via StyleId.
Skin	setSkin(Skin skin, boolean recursively) Applies specified skin to the specified component and all of its children linked via StyleId.
StyleId	setStyleId(StyleId id) Sets new component style ID.
void	updateUI()

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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

Methods inherited from interface com.alee.utils.swing.SizeMethods

getPreferredSize

Constructor Detail

WebStatusBar

public WebStatusBar()

Constructs new status bar.

WebStatusBar

public WebStatusBar(StyleId id)

Constructs new status bar.

Parameters:

id - style ID

Method Detail

addToMiddle

public void addToMiddle(java.awt.Component component)

Adds component to the middle status bar area.

Parameters:

component - component to add

addFill

public void addFill(java.awt.Component component)

Adds component to the fill status bar area.

Parameters:

component - component to add

addToEnd

public void addToEnd(java.awt.Component component)

Adds component to the end of the status bar.

Parameters:

component - component to add

addSeparator

public void addSeparator()

Adds separator to the start of the status bar.

addSeparatorToEnd

public void addSeparatorToEnd()

Adds separator to the end of the status bar.

addSeparator

public void addSeparator(java.lang.String constraints)

Adds separator under the specified constaints.

Parameters:

constraints - layout constraints

createSeparator

protected WebSeparator createSeparator()

Returns new status bar separator.

Returns:

new status bar separator

getStyleId

public StyleId getStyleId()

Description copied from interface: Styleable

Returns component style ID.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public StyleId setStyleId(StyleId id)

Description copied from interface: Styleable

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

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

Returns:

previously used style ID

getSkin

public Skin getSkin()

Description copied from interface: Skinnable

Returns skin currently applied to this component.

Specified by:

getSkin in interface Skinnable

Returns:

skin currently applied to this component

setSkin

public Skin setSkin(Skin skin)

Description copied from interface: Skinnable

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

Specified by:

setSkin in interface Skinnable

Parameters:

skin - skin to be applied

Returns:

previously applied skin

setSkin

public Skin setSkin(Skin skin,
                    boolean recursively)

Description copied from interface: Skinnable

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

Specified by:

setSkin in interface Skinnable

Parameters:

skin - skin to be applied

recursively - whether or not should apply skin to child components

Returns:

previously applied skin

restoreSkin

public Skin restoreSkin()

Description copied from interface: Skinnable

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

Specified by:

restoreSkin in interface Skinnable

Returns:

skin applied to this component after restoration

addStyleListener

public void addStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Adds style change listener.

Specified by:

addStyleListener in interface Skinnable

Parameters:

listener - style change listener to add

removeStyleListener

public void removeStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Removes style change listener.

Specified by:

removeStyleListener in interface Skinnable

Parameters:

listener - style change listener to remove

getCustomPainters

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

Description copied from interface: Paintable

Returns all custom painters for this component.

Specified by:

getCustomPainters in interface Paintable

Returns:

all custom painters for this component

getCustomPainter

public Painter getCustomPainter()

Description copied from interface: Paintable

Returns custom base painter for this component.

Specified by:

getCustomPainter in interface Paintable

Returns:

custom base painter for this component

getCustomPainter

public Painter getCustomPainter(java.lang.String id)

Description copied from interface: Paintable

Returns custom painter for this component.

Specified by:

getCustomPainter in interface Paintable

Parameters:

id - painter ID

Returns:

custom painter for this component

setCustomPainter

public Painter setCustomPainter(Painter painter)

Description copied from interface: Paintable

Sets custom base painter for this component.

Specified by:

setCustomPainter in interface Paintable

Parameters:

painter - custom base painter

Returns:

previously set custom base painter

setCustomPainter

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

Description copied from interface: Paintable

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

Specified by:

setCustomPainter in interface Paintable

Parameters:

id - painter ID

painter - painter

Returns:

old custom painter

restoreDefaultPainters

public boolean restoreDefaultPainters()

Description copied from interface: Paintable

Restores default painters for this component.

Specified by:

restoreDefaultPainters in interface Paintable

Returns:

true if default painters were restored, false otherwise

provideShape

public java.awt.Shape provideShape()

Description copied from interface: ShapeProvider

Returns component shape.

Specified by:

provideShape in interface ShapeProvider

Returns:

component shape

getMargin

public java.awt.Insets getMargin()

Description copied from interface: MarginSupport

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

Specified by:

getMargin in interface MarginSupport

Returns:

current margin

setMargin

public void setMargin(int margin)

Sets new margin.

Parameters:

margin - new margin

setMargin

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

Sets new margin.

Parameters:

top - new top margin

left - new left margin

bottom - new bottom margin

right - new right margin

setMargin

public void setMargin(java.awt.Insets margin)

Description copied from interface: MarginSupport

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

Specified by:

setMargin in interface MarginSupport

Parameters:

margin - new margin

getPadding

public java.awt.Insets getPadding()

Description copied from interface: PaddingSupport

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

Specified by:

getPadding in interface PaddingSupport

Returns:

current padding

setPadding

public void setPadding(int padding)

Sets new padding.

Parameters:

padding - new padding

setPadding

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

Sets new padding.

Parameters:

top - new top padding

left - new left padding

bottom - new bottom padding

right - new right padding

setPadding

public void setPadding(java.awt.Insets padding)

Description copied from interface: PaddingSupport

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

Specified by:

setPadding in interface PaddingSupport

Parameters:

padding - new padding

getWebUI

public WebStatusBarUI getWebUI()

Returns Web-UI applied to this class.

Returns:

Web-UI applied to this class

getUI

public StatusBarUI getUI()

Returns the look and feel (L&F) object that renders this component.

Returns:

the StatusBarUI object that renders this component

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JComponent

getUIClassID

public java.lang.String getUIClassID()

Overrides:

getUIClassID in class javax.swing.JComponent

getPreferredWidth

public int getPreferredWidth()

Description copied from interface: SizeMethods

Returns component preferred width.

Specified by:

getPreferredWidth in interface SizeMethods<WebStatusBar>

Returns:

component preferred width

setPreferredWidth

public WebStatusBar setPreferredWidth(int preferredWidth)

Description copied from interface: SizeMethods

Sets component preferred width. Pass SizeMethods.UNDEFINED to let component choose preferred width on its own.

Specified by:

setPreferredWidth in interface SizeMethods<WebStatusBar>

Parameters:

preferredWidth - new component preferred width

Returns:

modified component

getPreferredHeight

public int getPreferredHeight()

Description copied from interface: SizeMethods

Returns component preferred height.

Specified by:

getPreferredHeight in interface SizeMethods<WebStatusBar>

Returns:

component preferred height

setPreferredHeight

public WebStatusBar setPreferredHeight(int preferredHeight)

Description copied from interface: SizeMethods

Sets component preferred height. Pass SizeMethods.UNDEFINED to let component choose preferred height on its own.

Specified by:

setPreferredHeight in interface SizeMethods<WebStatusBar>

Parameters:

preferredHeight - new component preferred height

Returns:

modified component

getMinimumWidth

public int getMinimumWidth()

Description copied from interface: SizeMethods

Returns component minimum width.

Specified by:

getMinimumWidth in interface SizeMethods<WebStatusBar>

Returns:

component minimum width

setMinimumWidth

public WebStatusBar setMinimumWidth(int minimumWidth)

Description copied from interface: SizeMethods

Sets component minimum width. Pass SizeMethods.UNDEFINED to let component choose minimum width on its own.

Specified by:

setMinimumWidth in interface SizeMethods<WebStatusBar>

Parameters:

minimumWidth - new component minimum width

Returns:

modified component

getMinimumHeight

public int getMinimumHeight()

Description copied from interface: SizeMethods

Returns component minimum height.

Specified by:

getMinimumHeight in interface SizeMethods<WebStatusBar>

Returns:

component minimum height

setMinimumHeight

public WebStatusBar setMinimumHeight(int minimumHeight)

Description copied from interface: SizeMethods

Sets component minimum height. Pass SizeMethods.UNDEFINED to let component choose minimum height on its own.

Specified by:

setMinimumHeight in interface SizeMethods<WebStatusBar>

Parameters:

minimumHeight - new component minimum height

Returns:

modified component

getMaximumWidth

public int getMaximumWidth()

Description copied from interface: SizeMethods

Returns component maximum width.

Specified by:

getMaximumWidth in interface SizeMethods<WebStatusBar>

Returns:

component maximum width

setMaximumWidth

public WebStatusBar setMaximumWidth(int maximumWidth)

Description copied from interface: SizeMethods

Sets component maximum width. Pass SizeMethods.UNDEFINED to let component choose maximum width on its own.

Specified by:

setMaximumWidth in interface SizeMethods<WebStatusBar>

Parameters:

maximumWidth - new component maximum width

Returns:

modified component

getMaximumHeight

public int getMaximumHeight()

Description copied from interface: SizeMethods

Returns component maximum height.

Specified by:

getMaximumHeight in interface SizeMethods<WebStatusBar>

Returns:

component maximum height

setMaximumHeight

public WebStatusBar setMaximumHeight(int maximumHeight)

Description copied from interface: SizeMethods

Sets component maximum height. Pass SizeMethods.UNDEFINED to let component choose maximum height on its own.

Specified by:

setMaximumHeight in interface SizeMethods<WebStatusBar>

Parameters:

maximumHeight - new component maximum height

Returns:

modified component

setPreferredSize

public WebStatusBar setPreferredSize(int width,
                                     int height)

Description copied from interface: SizeMethods

Sets component preferred size. This method is a simple bridge for JComponent#setPreferredSize method.

Specified by:

setPreferredSize in interface SizeMethods<WebStatusBar>

Parameters:

width - component preferred width

height - component preferred height

Returns:

modified component

setLanguageContainerKey

public void setLanguageContainerKey(java.lang.String key)

Specified by:

setLanguageContainerKey in interface com.alee.managers.language.LanguageContainerMethods

removeLanguageContainerKey

public void removeLanguageContainerKey()

Specified by:

removeLanguageContainerKey in interface com.alee.managers.language.LanguageContainerMethods

getLanguageContainerKey

public java.lang.String getLanguageContainerKey()

Specified by:

getLanguageContainerKey in interface com.alee.managers.language.LanguageContainerMethods