sos.marker
Class DefaultMarkerRenderer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  sos.marker.DefaultMarkerRenderer

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, MarkerRenderer

Direct Known Subclasses:

DefaultMarkerRenderer.UIResource

public class DefaultMarkerRenderer
extends javax.swing.JPanel
implements MarkerRenderer

An object that renders a marker by drawing a colored rectangle over the marker's region. The color of the rectangle is the color supplied by setColor(java.awt.Color). If the color is unspecified or null, then the marker bar's foreground color is used. Also, the marker's short description is used as the Component's tooltip.

Since DefaultMarkerRenderer extends JPanel, clients can use common methods like setPreferredSize, setMinimumSize, setAlignmentX, setAlignmentY, and setBorder to control the bounds given to the rendered component. For example, the following code specifies that the rectangle have a blue background with an orange border, have a preferred/minimum width of 5, have a preferred/minimum height of 3, and be centered along the x axis.

  DefaultMarkerRenderer renderer = new DefaultMarkerRenderer();
  renderer.setColor( Color.BLUE );
  renderer.setBorder( BorderFactory.createLineBorder( Color.ORANGE, 1 ));
  Dimension size = new Dimension( 5, 5 );
  renderer.setPreferredSize( size );
  renderer.setMinimumSize( size );
  renderer.setAlignmentX( 0.5f );

Note that setBackground has no effect on this renderer. Use setColor instead.

Since:

1.0

Nested Class Summary

static class

DefaultMarkerRenderer.UIResource A subclass of DefaultMarkerRenderer that implements UIResource.

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

javax.swing.JPanel.AccessibleJPanel

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

DefaultMarkerRenderer()
Creates an instance of DefaultMarkerRenderer.

Method Summary

void	firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, byte oldValue, byte newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, char oldValue, char newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, double oldValue, double newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, float oldValue, float newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, int oldValue, int newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, long oldValue, long newValue) Overridden for performance reasons.
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Overridden for performance reasons.
void	firePropertyChange(java.lang.String propertyName, short oldValue, short newValue) Overridden for performance reasons.
java.awt.Color	getColor() Returns this marker's color, which is used as the background color.
java.awt.Component	getMarkerRendererComponent(JMarkerBar markerBar, int markerIndex, Marker marker) Returns the Component for a given marker on a marker bar.
void	invalidate() Overridden for performance reasons.
void	repaint() Overridden for performance reasons.
void	repaint(long tm, int x, int y, int width, int height) Overridden for performance reasons.
void	repaint(java.awt.Rectangle r) Overridden for performance reasons.
void	revalidate() Overridden for performance reasons.
void	setColor(java.awt.Color color) Sets the color of this marker.
void	validate() Overridden for performance reasons.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, 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, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, 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, 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, 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, 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

Constructor Detail

DefaultMarkerRenderer

public DefaultMarkerRenderer()

Creates an instance of DefaultMarkerRenderer.

Method Detail

getColor

public java.awt.Color getColor()

Returns this marker's color, which is used as the background color.

Returns:

this marker's color (may be null)

See Also:

setColor(java.awt.Color)

getMarkerRendererComponent

public java.awt.Component getMarkerRendererComponent(JMarkerBar markerBar,
                                                     int markerIndex,
                                                     Marker marker)

Description copied from interface: MarkerRenderer

Returns the Component for a given marker on a marker bar. The Component ultimately gets sized and rendered on the marker bar.

Specified by:

getMarkerRendererComponent in interface MarkerRenderer

Parameters:

markerBar - the marker bar containing the marker to render

markerIndex - the index of the marker to render

marker - the marker to render

Returns:

the Component that draws the marker

setColor

public void setColor(java.awt.Color color)

Sets the color of this marker. Use this method rather than setBackground to set this marker's color. If this marker's color is not set, then it uses the marker bar's foreground color.

Parameters:

color - this marker's color (may be null)

See Also:

getColor()

validate

public void validate()

Overridden for performance reasons.

Overrides:

validate in class java.awt.Container

invalidate

public void invalidate()

Overridden for performance reasons.

Overrides:

invalidate in class java.awt.Container

repaint

public void repaint()

Overridden for performance reasons.

Overrides:

repaint in class java.awt.Component

revalidate

public void revalidate()

Overridden for performance reasons.

Overrides:

revalidate in class javax.swing.JComponent

repaint

public void repaint(long tm,
                    int x,
                    int y,
                    int width,
                    int height)

Overridden for performance reasons.

Overrides:

repaint in class javax.swing.JComponent

repaint

public void repaint(java.awt.Rectangle r)

Overridden for performance reasons.

Overrides:

repaint in class javax.swing.JComponent

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               byte oldValue,
                               byte newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               char oldValue,
                               char newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class javax.swing.JComponent

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               short oldValue,
                               short newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               int oldValue,
                               int newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class javax.swing.JComponent

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               long oldValue,
                               long newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               float oldValue,
                               float newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               double oldValue,
                               double newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               boolean oldValue,
                               boolean newValue)

Overridden for performance reasons.

Overrides:

firePropertyChange in class javax.swing.JComponent