com.mockturtlesolutions.snifflib.graphics

Class SLLegend

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.mockturtlesolutions.snifflib.graphics.SLComponent

com.mockturtlesolutions.snifflib.graphics.SLLegend

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class SLLegend
extends SLComponent

This is an abstract object. The axes it is added to will actually render it based on the legend's properties. Importantly the axes will modify its margins to accomodate the legend in a way appropriate to It maintains a mapping of existing lines in a plot to words.

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

Modifier and Type	Field and Description
static int	ALPHA_ORDER
protected java.util.ArrayList	children
static int	INSERTION_ORDER
static int	LEGEND_EAST
static int	LEGEND_INSIDE
static int	LEGEND_NORTH
static int	LEGEND_SOUTH
static int	LEGEND_WEST

Fields inherited from class com.mockturtlesolutions.snifflib.graphics.SLComponent

name, selected

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

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

Constructor Summary

Constructors

Constructor and Description
SLLegend(SLLocator locator, SLAxes parent)
SLLegend(SLLocator locator, SLAxes parent, int orderm) Creates a legend which orders its entries accoring to the given strategy.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(SLComponentEvent ev)
void	addChild(SLComponent c)
void	addLegend(java.lang.String token, SLAnnotation T, SLLine line)
void	addLegend(java.lang.String token, SLLine line) Add an association to the legend.
void	applyPreferences(java.lang.String repos, SLLegendPreferences p)
void	assignAnnotation(java.lang.String token, SLAnnotation annot)
java.awt.Color	getBackgroundColor(java.awt.Color b)
java.util.List	getChildren()
double	getColumnSpace() Get the space in pixels between columns.
java.awt.Color	getEdgeColor(java.awt.Color b)
double	getEntryHeight() Gets the height in pixels of a single row plus the inter-row space.
double	getEntryWidth() Gets the height in pixels of a single entry (symbol,text and spaces).
java.awt.Font	getFont()
java.awt.Color	getFontColor(java.awt.Color b)
java.lang.String	getFontFamily()
int	getFontSize()
int	getFontStyle()
java.awt.Graphics	getGraphics()
double	getLabelWidth() Get the space in pixels to hold a symbol's label.
int[]	getLegendArrayDims()
double	getLegendAxesHSpace() Get the horizontal space to place between a legend and the axes.
double	getLegendAxesVSpace() Get the vertical space to place between a legend and the axes.
java.awt.Font	getLegendFont()
double	getLegendHeight() Get height of legend in pixels.
int	getLegendLocale()
double	getLegendWidth() Get width of legend in pixels.
double	getRowHeight() Gets the height in pixels of a single row.
double	getRowSpace() Get the space in pixels between rows of the legend.
double	getSymbolLabelSpace() Get the space in pixels between the symbol and the text.
double	getSymbolWidth() Get the space in pixels to hold a symbol.
boolean	getTruncate()
int	getTruncatePoint()
DblMatrix	getXBounds() This default implementation of getXBounds returns a vector of zeros, essentially giving the object a reported size of zero.
DblMatrix	getXData() Get the x-coordinate in data units of the upper left corner of the legend box.
DblMatrix	getYBounds() This default implementation of getYBounds returns a vector of zeros, essentially giving the object a reported size of zero.
DblMatrix	getYData()
DblMatrix	getZBounds() This default implementation of getZBounds returns a vector of zeros, essentially giving the object a reported size of zero.
boolean	hasChild(SLComponent b)
void	paint(java.awt.Graphics g)
void	paintSL()
void	paintSL(java.awt.Graphics g)
void	removeLegend(java.lang.String token) Remove an association to the legend.
void	setBackgroundColor(java.awt.Color b)
void	setEdgeColor(java.awt.Color b)
void	setFont(java.awt.Font b)
void	setFontColor(java.awt.Color b)
void	setFontFamily(java.lang.String f)
void	setFontSize(int x)
void	setFontStyle(int x)
void	setLegendDomainNameFilter(DomainNameFilter p)
void	setLegendFont(java.awt.Font f)
void	setLegendLocale(int x)
void	setLegendLocation(DblMatrix xdata, DblMatrix ydata)
void	setNumberOfColumns(int x)
void	setTruncate(boolean f)
void	setTruncatePoint(int x)
void	updatePreferences(java.lang.String repos, SLLegendPreferences p) Deprecated. Replaced by applyPreferences(String repos,SLLegendPreferences p)

Methods inherited from class com.mockturtlesolutions.snifflib.graphics.SLComponent

getName, isSelected, seenIntersecting, setName, setSelected, superComponentPaint

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, 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

ALPHA_ORDER

public static final int ALPHA_ORDER

See Also:

Constant Field Values

INSERTION_ORDER

public static final int INSERTION_ORDER

See Also:

Constant Field Values

LEGEND_NORTH

public static final int LEGEND_NORTH

See Also:

Constant Field Values

LEGEND_SOUTH

public static final int LEGEND_SOUTH

See Also:

Constant Field Values

LEGEND_EAST

public static final int LEGEND_EAST

See Also:

Constant Field Values

LEGEND_WEST

public static final int LEGEND_WEST

See Also:

Constant Field Values

LEGEND_INSIDE

public static final int LEGEND_INSIDE

See Also:

Constant Field Values

children

protected java.util.ArrayList children

Constructor Detail

SLLegend

public SLLegend(SLLocator locator,
        SLAxes parent)

SLLegend

public SLLegend(SLLocator locator,
        SLAxes parent,
        int orderm)

Creates a legend which orders its entries accoring to the given strategy.

Method Detail

hasChild

public boolean hasChild(SLComponent b)

Specified by:

hasChild in class SLComponent

getChildren

public java.util.List getChildren()

Specified by:

getChildren in class SLComponent

applyPreferences

public void applyPreferences(java.lang.String repos,
                    SLLegendPreferences p)

updatePreferences

@Deprecated
public void updatePreferences(java.lang.String repos,
                                SLLegendPreferences p)

Deprecated. Replaced by applyPreferences(String repos,SLLegendPreferences p)

setLegendDomainNameFilter

public void setLegendDomainNameFilter(DomainNameFilter p)

setLegendFont

public void setLegendFont(java.awt.Font f)

getLegendFont

public java.awt.Font getLegendFont()

getGraphics

public java.awt.Graphics getGraphics()

Specified by:

getGraphics in class SLComponent

actionPerformed

public void actionPerformed(SLComponentEvent ev)

Specified by:

actionPerformed in class SLComponent

setTruncatePoint

public void setTruncatePoint(int x)

setTruncate

public void setTruncate(boolean f)

getTruncate

public boolean getTruncate()

getTruncatePoint

public int getTruncatePoint()

setFont

public void setFont(java.awt.Font b)

Overrides:

setFont in class javax.swing.JComponent

getFont

public java.awt.Font getFont()

Specified by:

getFont in interface java.awt.MenuContainer

Overrides:

getFont in class java.awt.Component

getFontFamily

public java.lang.String getFontFamily()

setFontFamily

public void setFontFamily(java.lang.String f)

getFontStyle

public int getFontStyle()

setFontStyle

public void setFontStyle(int x)

getFontSize

public int getFontSize()

setFontSize

public void setFontSize(int x)

setFontColor

public void setFontColor(java.awt.Color b)

setEdgeColor

public void setEdgeColor(java.awt.Color b)

setBackgroundColor

public void setBackgroundColor(java.awt.Color b)

getFontColor

public java.awt.Color getFontColor(java.awt.Color b)

getEdgeColor

public java.awt.Color getEdgeColor(java.awt.Color b)

getBackgroundColor

public java.awt.Color getBackgroundColor(java.awt.Color b)

getLegendAxesHSpace

public double getLegendAxesHSpace()

Get the horizontal space to place between a legend and the axes.

getLegendAxesVSpace

public double getLegendAxesVSpace()

Get the vertical space to place between a legend and the axes.

setNumberOfColumns

public void setNumberOfColumns(int x)

setLegendLocale

public void setLegendLocale(int x)

setLegendLocation

public void setLegendLocation(DblMatrix xdata,
                     DblMatrix ydata)

getLegendLocale

public int getLegendLocale()

getRowHeight

public double getRowHeight()

Gets the height in pixels of a single row.

getEntryHeight

public double getEntryHeight()

Gets the height in pixels of a single row plus the inter-row space.

getEntryWidth

public double getEntryWidth()

Gets the height in pixels of a single entry (symbol,text and spaces).

getColumnSpace

public double getColumnSpace()

Get the space in pixels between columns.

getSymbolLabelSpace

public double getSymbolLabelSpace()

Get the space in pixels between the symbol and the text.

getSymbolWidth

public double getSymbolWidth()

Get the space in pixels to hold a symbol.

getLabelWidth

public double getLabelWidth()

Get the space in pixels to hold a symbol's label.

getRowSpace

public double getRowSpace()

Get the space in pixels between rows of the legend.

getLegendWidth

public double getLegendWidth()

Get width of legend in pixels.

getLegendArrayDims

public int[] getLegendArrayDims()

getLegendHeight

public double getLegendHeight()

Get height of legend in pixels.

getXBounds

public DblMatrix getXBounds()

Description copied from class: SLComponent

This default implementation of getXBounds returns a vector of zeros, essentially giving the object a reported size of zero. This method should be overridden in inheriting child classes.

Overrides:

getXBounds in class SLComponent

getYBounds

public DblMatrix getYBounds()

Description copied from class: SLComponent

This default implementation of getYBounds returns a vector of zeros, essentially giving the object a reported size of zero. This method should be overridden in inheriting child classes.

Overrides:

getYBounds in class SLComponent

getZBounds

public DblMatrix getZBounds()

Description copied from class: SLComponent

This default implementation of getZBounds returns a vector of zeros, essentially giving the object a reported size of zero. This method should be overridden in inheriting child classes.

Overrides:

getZBounds in class SLComponent

addLegend

public void addLegend(java.lang.String token,
             SLAnnotation T,
             SLLine line)

addLegend

public void addLegend(java.lang.String token,
             SLLine line)

Add an association to the legend. The actual line is placed in the Map so that any changes in the line's style should be reflected automatically in the legend.

assignAnnotation

public void assignAnnotation(java.lang.String token,
                    SLAnnotation annot)

addChild

public void addChild(SLComponent c)

Specified by:

addChild in class SLComponent

removeLegend

public void removeLegend(java.lang.String token)

Remove an association to the legend.

paintSL

public void paintSL()

getXData

public DblMatrix getXData()

Get the x-coordinate in data units of the upper left corner of the legend box.

getYData

public DblMatrix getYData()

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class SLComponent

paintSL

public void paintSL(java.awt.Graphics g)

Specified by:

paintSL in class SLComponent