com.klg.jclass.util.legend
Class JCLegend

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.klg.jclass.util.legend.JCLegend

All Implemented Interfaces:

Changeable, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

JCChart3dLegend, JCGridLegend

public abstract class JCLegend

extends JComponent

implements Changeable, Serializable

JCLegend manages and renders a legend for a component. It is an abstract class that requires a subclass to provide a specific layout. It requires a JCLegendPopulator instance to populate it with legend items and a JCLegendRenderer instance to help in rendering the items. Each legend item is represented by a JCLegendItem instance. JCLegend is a Swing-based component and should behave accordingly. It is not visible by default. It is also transparent by default, meaning that the Opaque property must be set to true if any background color is to be drawn.

See Also:

JCGridLegend, JCMultiColLegend, JCLegendPopulator, JCLegendRenderer, JCLegendItem, Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected int	anchor
protected int	ascent
static int	BOX
static int	BOX_PLAIN
protected Font	cachedFont
protected boolean	cachedVertical
protected CellRendererPane	cellRendererPane CellRendererPane object used in rendering HTML text.
protected boolean	changed Boolean representing the value of the Changed property.
protected int	changedFlag A flag to record what has changed
static int	CUSTOM_ALL
static int	CUSTOM_SYMBOL
protected int	descent
static int	EAST
static int	EASTWEST_MASK
static int	HORIZONTAL
static int	IMAGE
static int	IMAGE_OUTLINED
protected com.klg.jclass.util.ImageMapInfo	imageMapInfo The image map information for the JCLegend.
protected List	legendItems
protected com.klg.jclass.util.legend.JCLegendPopulator	legendPopulator JCLegendPopulator instance used to populate the legend.
protected com.klg.jclass.util.legend.JCLegendRenderer	legendRenderer JCLegendRenderer instance used to help draw the legend.
static int	LINE
protected Locale	locale The locale field used for localization.
static int	NONE
static int	NORTH
static int	NORTHEAST
static int	NORTHSOUTH_MASK
static int	NORTHWEST
protected int	orientation
protected Dimension	preferredSize The preferred size of the legend.
protected Dimension	ps
static int	SOUTH
static int	SOUTHEAST
static int	SOUTHWEST
protected int	symbolSize
protected com.klg.jclass.util.swing.TextRenderer	textRend
protected boolean	updateParent Used to turn off updates to the parent in certain cases.
static int	VERTICAL
static int	WEST

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 com.klg.jclass.util.Changeable

BASIC_CHANGE_MASK, LAYOUT, NO_CHANGE, NOTIFY_PARENT_LAYOUT, RECALC, REDRAW

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JCLegend()
Internal constructor for legend.

Method Summary

protected void	checkAnchor(int a)
void	drawLegendItem(Graphics gc, Font useFont, com.klg.jclass.util.legend.JCLegendItem thisItem) Draws one legend item based on the size and position given in its JCLegendItem instance.
int	getAnchor() Gets the Anchor property, which determines the position of the legend relative to the parent components primary draw area.
CellRendererPane	getCellRendererPane() Gets the cell renderer pane used by this component.
boolean	getChanged() Gets the value of the Changed property.
boolean	getChanged(int mask) Checks the value of the ChangedFlag property for the specified mask (see Changeable for a list of valid masks).
Rectangle	getDrawingArea() Gets the bounding rectangle of the component's drawing area, (its area minus the shadows and insets).
void	getDrawingArea(Rectangle rect) Gets the bounding rectangle of the component's drawing area, (its area minus the insets).
Graphics	getGraphics() Overrides parent getGraphics().
com.klg.jclass.util.ImageMapInfo	getImageMapInfo() Retrieve the image map information for this JCLegend.
List	getLegendItems() Returns the list of legend items being used by this legend.
com.klg.jclass.util.legend.JCLegendPopulator	getLegendPopulator() Gets the JCLegendPopulator instance used to populate this legend.
com.klg.jclass.util.legend.JCLegendRenderer	getLegendRenderer() Gets the legend renderer class which is used to help draw the legend.
int	getOrientation() Gets the Orientation property, which determines how the legend information is laid out.
Dimension	getPreferredSize() Calculates and returns the preferred size for the legend, or the manually set preferred size if it has been manually set.
int	getSymbolSize() Gets the default symbol size being used for legend item.
com.klg.jclass.util.swing.TextRenderer	getTextRenderer() Gets the TextRenderer class used to draw HTML text.
boolean	isBatched() This method is not used by this implementation of Changeable, so it always returns false.
boolean	isChanged() Gets the value of the Changed property.
boolean	isChanged(int mask) Checks the value of the ChangedFlag property for the specified mask (see Changeable for a list of valid masks).
boolean	isTitleItem(com.klg.jclass.util.legend.JCLegendItem item) Defers the decision on whether an item is a title item or not to the populator class.
abstract Dimension	layoutLegend(List itemList, boolean vertical, Font useFont) To be overridden by a legend implementation.
void	paintComponent(Graphics gc) Paint method for the legend.
com.klg.jclass.util.legend.JCLegendItem	pick(Point p) Internal pick method.
void	recalc() Recalculates extents of the legend.
void	setAnchor(int a) Sets the Anchor property, which determines the position of the legend relative to the parent component's primary draw area.
void	setChanged(boolean c, int cf) Sets the value of the Changed property and updates the parent object.
void	setChanged(boolean n, int cf, boolean updateParent) Sets the value of the Changed property.
void	setGraphics(Graphics g) Provides a way for the legend to draw to a custom Graphics object.
void	setImageMapInfo(com.klg.jclass.util.ImageMapInfo imageMapInfo) Set the image map information for this JCLegend.
void	setLegendPopulator(com.klg.jclass.util.legend.JCLegendPopulator legPop) Sets the legend populator class which will populate the legend.
void	setLegendRenderer(com.klg.jclass.util.legend.JCLegendRenderer legRend) Sets the legend renderer class which will help draw the legend.
void	setLocale(Locale locale) Sets the locale for legend.
void	setOrientation(int orient) Sets the Orientation property, which determines how the legend information is laid out.
void	setPreferredSize(Dimension dim) Sets the preferred size manually.
protected void	setUpLegendVariables() Set up and store variables used by the legend, including the font, font metrics and the list of legend items.
void	updateParent(int cf)

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, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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

NORTH

public static final int NORTH

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

See Also:

Constant Field Values

EAST

public static final int EAST

See Also:

Constant Field Values

WEST

public static final int WEST

See Also:

Constant Field Values

NORTHEAST

public static final int NORTHEAST

See Also:

Constant Field Values

NORTHWEST

public static final int NORTHWEST

See Also:

Constant Field Values

SOUTHEAST

public static final int SOUTHEAST

See Also:

Constant Field Values

SOUTHWEST

public static final int SOUTHWEST

See Also:

Constant Field Values

NORTHSOUTH_MASK

public static final int NORTHSOUTH_MASK

See Also:

Constant Field Values

EASTWEST_MASK

public static final int EASTWEST_MASK

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

BOX

public static final int BOX

See Also:

Constant Field Values

IMAGE

public static final int IMAGE

See Also:

Constant Field Values

IMAGE_OUTLINED

public static final int IMAGE_OUTLINED

See Also:

Constant Field Values

CUSTOM_SYMBOL

public static final int CUSTOM_SYMBOL

See Also:

Constant Field Values

CUSTOM_ALL

public static final int CUSTOM_ALL

See Also:

Constant Field Values

BOX_PLAIN

public static final int BOX_PLAIN

See Also:

Constant Field Values

LINE

public static final int LINE

See Also:

Constant Field Values

anchor

protected int anchor

orientation

protected int orientation

textRend

protected com.klg.jclass.util.swing.TextRenderer textRend

legendItems

protected List legendItems

ps

protected Dimension ps

symbolSize

protected int symbolSize

ascent

protected int ascent

descent

protected int descent

imageMapInfo

protected com.klg.jclass.util.ImageMapInfo imageMapInfo

The image map information for the JCLegend.

cachedVertical

protected boolean cachedVertical

cachedFont

protected transient Font cachedFont

updateParent

protected boolean updateParent

Used to turn off updates to the parent in certain cases.

changed

protected boolean changed

Boolean representing the value of the Changed property.

changedFlag

protected int changedFlag

A flag to record what has changed

preferredSize

protected Dimension preferredSize

The preferred size of the legend.

cellRendererPane

protected CellRendererPane cellRendererPane

CellRendererPane object used in rendering HTML text.

legendPopulator

protected com.klg.jclass.util.legend.JCLegendPopulator legendPopulator

JCLegendPopulator instance used to populate the legend.

legendRenderer

protected com.klg.jclass.util.legend.JCLegendRenderer legendRenderer

JCLegendRenderer instance used to help draw the legend.

locale

protected Locale locale

The locale field used for localization.

Constructor Detail

JCLegend

public JCLegend()

Internal constructor for legend.

Method Detail

setLegendPopulator

public void setLegendPopulator(com.klg.jclass.util.legend.JCLegendPopulator legPop)

Sets the legend populator class which will populate the legend.

Parameters:

legPop - The JCLegendPopulator instance used to populate this legend

getLegendPopulator

public com.klg.jclass.util.legend.JCLegendPopulator getLegendPopulator()

Gets the JCLegendPopulator instance used to populate this legend.

Returns:

The JCLegendPopulator instance used to populate this legend

setLegendRenderer

public void setLegendRenderer(com.klg.jclass.util.legend.JCLegendRenderer legRend)

Sets the legend renderer class which will help draw the legend.

Parameters:

legRend - The JCLegendRenderer instance used to help draw this legend

getLegendRenderer

public com.klg.jclass.util.legend.JCLegendRenderer getLegendRenderer()

Gets the legend renderer class which is used to help draw the legend.

Returns:

The JCLegendRenderer instance used to help draw this legend

getAnchor

public int getAnchor()

Gets the Anchor property, which determines the position of the legend relative to the parent components primary draw area.

Returns:

One of NORTH, SOUTH, EAST, WEST, NORTHWEST, SOUTHWEST, NORTHEAST, or SOUTHEAST

setAnchor

public void setAnchor(int a)

Sets the Anchor property, which determines the position of the legend relative to the parent component's primary draw area.

Parameters:

a - The new anchor. Must be one of NORTH, SOUTH, EAST, WEST, NORTHWEST, SOUTHWEST, NORTHEAST, or SOUTHEAST

checkAnchor

protected void checkAnchor(int a)

getOrientation

public int getOrientation()

Gets the Orientation property, which determines how the legend information is laid out.

Returns:

One of VERTICAL or HORIZONTAL

setOrientation

public void setOrientation(int orient)

Sets the Orientation property, which determines how the legend information is laid out.

Parameters:

orient - one of VERTICAL or HORIZONTAL

getImageMapInfo

public com.klg.jclass.util.ImageMapInfo getImageMapInfo()

Retrieve the image map information for this JCLegend.

Returns:

The current image map information.

setImageMapInfo

public void setImageMapInfo(com.klg.jclass.util.ImageMapInfo imageMapInfo)

Set the image map information for this JCLegend.

Parameters:

imageMapInfo - The new image map information.

getSymbolSize

public int getSymbolSize()

Gets the default symbol size being used for legend item. The default value is the ascent of the font (set in recalc()). It is overridable by users who want to provide a different symbolSize.

Returns:

the default symbol size

recalc

public void recalc()

Recalculates extents of the legend.

setUpLegendVariables

protected void setUpLegendVariables()

Set up and store variables used by the legend, including the font, font metrics and the list of legend items.

getLegendItems

public List getLegendItems()

Returns the list of legend items being used by this legend.

Returns:

The list of legend items. It contains a vector for each group (data view). Each group vector contains a number of JCLegendItem instances, each reflecting one item within the legend group. The first JCLegendItem within each group is the title of the group.

layoutLegend

public abstract Dimension layoutLegend(List itemList,
                                       boolean vertical,
                                       Font useFont)

To be overridden by a legend implementation. This method is used to layout the items within the legend by filling in the dim, pos, textPos, and symPos members of each JCLegendItem insance, returning the size of the layed out legend.

Parameters:

itemList - The legend vector. It contains a vector for each group (data view). Each group vector contains a number of JCLegendItem instances, each reflecting one item within the legend group. The first JCLegendItem within each group is the title of the group.

vertical - true for vertical legend, false for horizontal legend

useFont - font used for legend

Returns:

The size of the legend

paintComponent

public void paintComponent(Graphics gc)

Paint method for the legend.

Overrides:

paintComponent in class JComponent

Parameters:

gc - graphics context to use for drawing

drawLegendItem

public void drawLegendItem(Graphics gc,
                           Font useFont,
                           com.klg.jclass.util.legend.JCLegendItem thisItem)

Draws one legend item based on the size and position given in its JCLegendItem instance. The symbol to be drawn is derived from the legend item's draw type. A user that wants to provide different drawing behaviour should use either the CUSTOM_SYMBOL or CUSTOM_ALL draw types.

Parameters:

gc - the graphics context

useFont - the font used for this legend.

thisItem - the legend item to draw; a JCLegendItem instance

isTitleItem

public boolean isTitleItem(com.klg.jclass.util.legend.JCLegendItem item)

Defers the decision on whether an item is a title item or not to the populator class. It knows best.

Parameters:

item - the JCLegendItem in question

Returns:

true if the item is a title in the legend; false otherwise

getPreferredSize

public Dimension getPreferredSize()

Calculates and returns the preferred size for the legend, or the manually set preferred size if it has been manually set.

Overrides:

getPreferredSize in class JComponent

Returns:

preferred size

setPreferredSize

public void setPreferredSize(Dimension dim)

Sets the preferred size manually.

Overrides:

setPreferredSize in class JComponent

Parameters:

dim - the preferred size

getTextRenderer

public com.klg.jclass.util.swing.TextRenderer getTextRenderer()

Gets the TextRenderer class used to draw HTML text.

Returns:

pick

public com.klg.jclass.util.legend.JCLegendItem pick(Point p)

Internal pick method. Chooses the legend item closest to the provided position.

Parameters:

p - pick point relative to legend

Returns:

the JCLegendItem instance representing the picked point.

getDrawingArea

public Rectangle getDrawingArea()

Gets the bounding rectangle of the component's drawing area, (its area minus the shadows and insets).

Returns:

See Also:

JComponent.setBorder(javax.swing.border.Border)

getDrawingArea

public void getDrawingArea(Rectangle rect)

Gets the bounding rectangle of the component's drawing area, (its area minus the insets).

Parameters:

rect -

See Also:

JComponent.setBorder(javax.swing.border.Border)

getCellRendererPane

public CellRendererPane getCellRendererPane()

Gets the cell renderer pane used by this component. Used to render HTML encoded text with a JLabel.

Returns:

getGraphics

public Graphics getGraphics()

Overrides parent getGraphics(). If another Graphics object has been set to be the current one, return that. Otherwise, call the superclass' getGraphics() method.

Overrides:

getGraphics in class JComponent

Returns:

the Graphics object to use to draw this legend

setGraphics

public void setGraphics(Graphics g)

Provides a way for the legend to draw to a custom Graphics object. Call with a null to specify use of the default Graphics object used to draw to the screen.

Parameters:

g - Graphics object to use for drawing

getChanged

public boolean getChanged()

Gets the value of the Changed property. The Changed property determines whether the object needs to be recalculated.

Specified by:

getChanged in interface Changeable

Returns:

true if the object has been changed and needs recalculation; false otherwise

getChanged

public boolean getChanged(int mask)

Checks the value of the ChangedFlag property for the specified mask (see Changeable for a list of valid masks). The ChangedFlag property determines the action the object needs to take in regards to the current change.

Specified by:

getChanged in interface Changeable

Parameters:

mask -

Returns:

true if the specified mask exists in the ChangedFlag property; false otherwise

isChanged

public final boolean isChanged()

Gets the value of the Changed property. The Changed property determines whether the object needs to be recalculated.

Specified by:

isChanged in interface Changeable

Returns:

true if the object has been changed and needs recalculation; false otherwise

isChanged

public final boolean isChanged(int mask)

Checks the value of the ChangedFlag property for the specified mask (see Changeable for a list of valid masks). The ChangedFlag property determines the action the object needs to take in regards to the current change.

Specified by:

isChanged in interface Changeable

Parameters:

mask -

Returns:

true if the specified mask exists in the ChangedFlag property, false otherwise

setChanged

public void setChanged(boolean c,
                       int cf)

Sets the value of the Changed property and updates the parent object. The Changed property determines whether the object needs to be recalculated.

Specified by:

setChanged in interface Changeable

Parameters:

c -

cf -

setChanged

public void setChanged(boolean n,
                       int cf,
                       boolean updateParent)

Sets the value of the Changed property. The Changed property determines whether the object needs to be recalculated.

Specified by:

setChanged in interface Changeable

Parameters:

n - new value for Changed

cf -

updateParent - if true, the parent is updated; otherwise, the parent is not updated (the "update" semantics are up to the implementor)

updateParent

public void updateParent(int cf)

Parameters:

cf -

isBatched

public boolean isBatched()

This method is not used by this implementation of Changeable, so it always returns false.

Specified by:

isBatched in interface Changeable

Returns:

setLocale

public void setLocale(Locale locale)

Sets the locale for legend.

Overrides:

setLocale in class Component

Parameters:

locale -