bibliothek.gui.dock.util.swing

Class OrientedLabel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

bibliothek.gui.dock.util.BackgroundPanel

bibliothek.gui.dock.util.ConfiguredBackgroundPanel

bibliothek.gui.dock.util.swing.OrientedLabel

All Implemented Interfaces:

PaintableComponent, ImageObserver, MenuContainer, Serializable, Accessible

public class OrientedLabel
extends ConfiguredBackgroundPanel

A label which draws some text, and can change the layout of the text between horizontal and vertical.

Author:

Benjamin Sigg

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, 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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
OrientedLabel() Creates a new label with no text

Method Summary

Modifier and Type	Method and Description
Color	getBackground()
FontModifier	getFontModifier() Gets the font modifier of this label.
Color	getForeground()
Icon	getIcon() Gets the icon of this label
int	getIconOffset() Gets the distance between icon and the tree adjacent borders.
int	getIconTextDistance() Gets the distance between icon and text.
DLabel	getLabel() Gets direct access to the label that is used by this OrientedLabel to paint its content.
Dimension	getMinimumSize()
Dimension	getPreferredSize()
String	getText() Gets the text of this label
boolean	isHorizontal() Tells whether the content of this label is painted horizontally.
boolean	isIconHidden() Tells whether the icon is not painted.
boolean	isPaintDisabledIcon() Whether a special disabled version of getIcon() is painted if this label is disabled.
boolean	isVertical() Tells whether the content of this label is painted vertically.
void	paint(Graphics g)
void	paintForeground(Graphics g) Invokes the standard algorithm that paints the foreground of the component.
void	setBackground(Color bg)
void	setBounds(int x, int y, int w, int h)
void	setEnabled(boolean enabled)
void	setFont(Font font)
void	setFontModifier(FontModifier modifier) Sets the modifier for the current font.
void	setForeground(Color fg)
void	setHorizontal(boolean horizontal) Sets the orientation.
void	setIcon(Icon icon) Sets the icon which will be painted on the left or on the top side.
void	setIconHidden(boolean hideIcon) Tells whether the icon is hidden.
void	setIconOffset(int iconOffset) Sets the distance between icon and the three adjacent borders.
void	setIconTextDistance(int iconTextDistance) Sets the distance between icon and text.
void	setPaintDisabledIcon(boolean paintDisabledIcon) Whether to build and paint a special disabled version of getIcon() if this label is disabled.
void	setRotation(Rotation rotation) Sets the orientation of this label.
void	setText(String text) Sets the text of this label
void	update(Graphics g)
protected void	updateFonts() Called by updateUI() if the fonts need to be updated, the default implementation does nothing
void	updateUI()

Methods inherited from class bibliothek.gui.dock.util.ConfiguredBackgroundPanel

configure, setupRenderingHints

Methods inherited from class bibliothek.gui.dock.util.BackgroundPanel

getBackgroundAlgorithm, getComponent, getTransparency, paintBackground, paintBorder, paintChildren, paintComponent, paintOverlay, setBackground, setTransparency

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, 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, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction

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, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, 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, 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

OrientedLabel

public OrientedLabel()

Creates a new label with no text

Method Detail

setIcon

public void setIcon(Icon icon)

Sets the icon which will be painted on the left or on the top side.

Parameters:

icon - the icon, can be null

getIcon

public Icon getIcon()

Gets the icon of this label

Returns:

the icon, can be null

setPaintDisabledIcon

public void setPaintDisabledIcon(boolean paintDisabledIcon)

Whether to build and paint a special disabled version of getIcon() if this label is disabled.

Parameters:

paintDisabledIcon - whether to paint the special icon

isPaintDisabledIcon

public boolean isPaintDisabledIcon()

Whether a special disabled version of getIcon() is painted if this label is disabled.

Returns:

true if an artificial icon is created

setIconOffset

public void setIconOffset(int iconOffset)

Sets the distance between icon and the three adjacent borders.

Parameters:

iconOffset - the distance

getIconOffset

public int getIconOffset()

Gets the distance between icon and the tree adjacent borders.

Returns:

the distance

setIconTextDistance

public void setIconTextDistance(int iconTextDistance)

Sets the distance between icon and text.

Parameters:

iconTextDistance - the gap

getIconTextDistance

public int getIconTextDistance()

Gets the distance between icon and text.

Returns:

the gap

setRotation

public void setRotation(Rotation rotation)

Sets the orientation of this label.

Parameters:

rotation - the orientation, not null

setHorizontal

public void setHorizontal(boolean horizontal)

Sets the orientation. If horizontal, then the rotation is set to 0 degrees, otherwise the rotation is set to 90 degrees.

Parameters:

horizontal - whether the label is painted horizontal

isHorizontal

public boolean isHorizontal()

Tells whether the content of this label is painted horizontally.

Returns:

whether the label is horizontal

isVertical

public boolean isVertical()

Tells whether the content of this label is painted vertically.

Returns:

whether the label is vertical

setText

public void setText(String text)

Sets the text of this label

Parameters:

text - the text, null is allowed

getText

public String getText()

Gets the text of this label

Returns:

the text, may be null

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class JComponent

getForeground

public Color getForeground()

Overrides:

getForeground in class Component

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

getBackground

public Color getBackground()

Overrides:

getBackground in class Component

isIconHidden

public boolean isIconHidden()

Tells whether the icon is not painted.

Returns:

whether the icon is hidden

See Also:

setIconHidden(boolean)

setIconHidden

public void setIconHidden(boolean hideIcon)

Tells whether the icon is hidden. If the icon is hidden, it is not painted and does not take any space. It is however treated normally when serving calls to getPreferredSize().

Parameters:

hideIcon - whether to hide the icon

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

updateFonts

protected void updateFonts()

Called by updateUI() if the fonts need to be updated, the default implementation does nothing

setFont

public void setFont(Font font)

Overrides:

setFont in class JComponent

setFontModifier

public void setFontModifier(FontModifier modifier)

Sets the modifier for the current font.

Parameters:

modifier - the modifier

See Also:

DLabel.setFontModifier(FontModifier)

getFontModifier

public FontModifier getFontModifier()

Gets the font modifier of this label.

Returns:

the modifier

getLabel

public DLabel getLabel()

Gets direct access to the label that is used by this OrientedLabel to paint its content. This method should be treated with care, modifications to the underlying label may have unexpected side effects.

Returns:

the label that paints the content

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

paint

public void paint(Graphics g)

Overrides:

paint in class BackgroundPanel

paintForeground

public void paintForeground(Graphics g)

Description copied from interface: PaintableComponent

Invokes the standard algorithm that paints the foreground of the component. This method should be called at most once.

Specified by:

paintForeground in interface PaintableComponent

Overrides:

paintForeground in class BackgroundPanel

Parameters:

g - the graphics context to use, null to just inform this component that the foreground should not be painted automatically

update

public void update(Graphics g)

Overrides:

update in class JComponent

setBounds

public void setBounds(int x,
                      int y,
                      int w,
                      int h)

Overrides:

setBounds in class Component