ca.bc.webarts.widgets
Class ColouredLabel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JLabel
                  extended byca.bc.webarts.widgets.ColouredLabel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class ColouredLabel
extends javax.swing.JLabel

A class to extend JLabel with some added easily settable colour and Font settings.

It allows easily setting the text colour and the background colour of the label.

Now you don't have to override paint.

Author:
unknown
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JLabel
javax.swing.JLabel.AccessibleJLabel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  java.awt.Color backColour_
          Description of the Field
protected  java.lang.String boldOff_
          Description of the Field
protected  java.lang.String boldOn_
          Description of the Field
private static java.lang.String DEFAULT_FONT_FACE
           
protected  int fontMidpoint_
          Description of the Field
protected  java.lang.String fontName_
          Description of the Field
protected  java.lang.String fontSize_
          Description of the Field
protected  java.lang.String[] fontSizes_
          Description of the Field
protected  java.lang.String italicOff_
          Description of the Field
protected  java.lang.String italicOn_
          Description of the Field
protected  java.lang.String labelText_
          Description of the Field
protected  java.awt.Color textColour_
          Description of the Field
protected  boolean wrapText_
          Description of the Field
 
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.Container
 
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
ColouredLabel(java.awt.Color backColour, java.awt.Color textColour, java.awt.Font newFont, java.lang.String labelText)
          Constructor to set up the Label with the specified colours.
ColouredLabel(java.awt.Color backColour, java.awt.Color textColour, java.lang.String labelText)
          Constructor to set up the Label with the specified colours.
ColouredLabel(java.awt.Color textColour, java.lang.String labelText)
          Constructor to set up the Label with the specified colour.
ColouredLabel(java.lang.String labelText)
          Basic constructor to set up the Label with the specified colour.
 
Method Summary
private  void coloursChanged()
          Refreshes the text string with some new colour values.
 java.awt.Color getBackColour()
          Get method for the current Background Colour being used in this label.
private  java.lang.String getBackColourHtmlString()
          Get the HTML string representing the Current Background Colour.
 java.awt.Color getTextColour()
          Get method for the current Text Colour being used in this label.
private  java.lang.String getTextColourHtmlString()
          Get the HTML string representing the Current Text Colour.
static java.lang.String getTextColourHtmlString(java.awt.Color c)
          Get the HTML string representing the specified Color.
 void setBackColour(java.awt.Color backColour)
          Sets the current background Text Colour being used in this label.
 void setFont(java.awt.Font newFont)
          Allows setting of the Font to use in this label.
 void setFontName(java.lang.String fontName)
          A convienience method to directly set the Font using the face name instead of sending a Font object.
 void setText(java.lang.String newText)
          Overrides the JLabel setText to add the extra stuff to get the extra colours and font stuff.
 void setTextColour(java.awt.Color textColour)
          Sets the current Text Colour being used in this label.
 void setWrapText(boolean wrapText)
          Forces the display of the label text to the specified wrapping.
 
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, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Field Detail

DEFAULT_FONT_FACE

private static final java.lang.String DEFAULT_FONT_FACE
See Also:
Constant Field Values

textColour_

protected java.awt.Color textColour_
Description of the Field


backColour_

protected java.awt.Color backColour_
Description of the Field


labelText_

protected java.lang.String labelText_
Description of the Field


fontName_

protected java.lang.String fontName_
Description of the Field


fontSizes_

protected java.lang.String[] fontSizes_
Description of the Field


fontSize_

protected java.lang.String fontSize_
Description of the Field


fontMidpoint_

protected int fontMidpoint_
Description of the Field


boldOn_

protected java.lang.String boldOn_
Description of the Field


boldOff_

protected java.lang.String boldOff_
Description of the Field


italicOn_

protected java.lang.String italicOn_
Description of the Field


italicOff_

protected java.lang.String italicOff_
Description of the Field


wrapText_

protected boolean wrapText_
Description of the Field

Constructor Detail

ColouredLabel

public ColouredLabel(java.lang.String labelText)
Basic constructor to set up the Label with the specified colour.

Parameters:
labelText - the text in the label

ColouredLabel

public ColouredLabel(java.awt.Color textColour,
                     java.lang.String labelText)
Constructor to set up the Label with the specified colour.

Parameters:
textColour - is the Color to use in the text in the label
labelText - the text in the label

ColouredLabel

public ColouredLabel(java.awt.Color backColour,
                     java.awt.Color textColour,
                     java.lang.String labelText)
Constructor to set up the Label with the specified colours.

Parameters:
backColour - is the Color to use in the back of the label
textColour - is the Color to use in the text in the label
labelText - the text in the label

ColouredLabel

public ColouredLabel(java.awt.Color backColour,
                     java.awt.Color textColour,
                     java.awt.Font newFont,
                     java.lang.String labelText)
Constructor to set up the Label with the specified colours.

Parameters:
backColour - is the Color to use in the back of the label
textColour - is the Color to use in the text in the label
newFont - is the Font to use in the text in the label
labelText - the text in the label
Method Detail

setWrapText

public void setWrapText(boolean wrapText)
Forces the display of the label text to the specified wrapping.

Parameters:
wrapText - flags if the text in the label will wrap or not

setText

public void setText(java.lang.String newText)
Overrides the JLabel setText to add the extra stuff to get the extra colours and font stuff.

Parameters:
newText - the text to go in the label.

setFont

public void setFont(java.awt.Font newFont)
Allows setting of the Font to use in this label. It parses the Face, Italic and Bold attributes.

Parameters:
newFont - the new font to use for this ColouredLabel.

setFontName

public void setFontName(java.lang.String fontName)
A convienience method to directly set the Font using the face name instead of sending a Font object.

Parameters:
fontName - The new fontName value

setTextColour

public void setTextColour(java.awt.Color textColour)
Sets the current Text Colour being used in this label.

Parameters:
textColour - the current Text Colour to use in this label.

setBackColour

public void setBackColour(java.awt.Color backColour)
Sets the current background Text Colour being used in this label.

Parameters:
backColour - the current background Colour to use in this label.

getTextColour

public java.awt.Color getTextColour()
Get method for the current Text Colour being used in this label.

Returns:
the current Text Colour being used in this label.

getBackColour

public java.awt.Color getBackColour()
Get method for the current Background Colour being used in this label.

Returns:
the current Background Colour being used in this label.

getTextColourHtmlString

private java.lang.String getTextColourHtmlString()
Get the HTML string representing the Current Text Colour.

Returns:
The textColourHtmlString value

getBackColourHtmlString

private java.lang.String getBackColourHtmlString()
Get the HTML string representing the Current Background Colour.

Returns:
The backColourHtmlString value

getTextColourHtmlString

public static java.lang.String getTextColourHtmlString(java.awt.Color c)
Get the HTML string representing the specified Color.

Parameters:
c - is the Color to retrieve the html string for.
Returns:
The textColourHtmlString value

coloursChanged

private void coloursChanged()
Refreshes the text string with some new colour values.