org.geotools.gui.swing
Class ColorRamp

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              org.geotools.gui.swing.ColorRamp

All Implemented Interfaces:

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

public class ColorRamp

extends javax.swing.JComponent

A color ramp with a graduation. The colors can be specified with a SampleDimension, an array of Colors or an IndexColorModel object, and the graduation is specified with a Graduation object. The resulting object is usually painted together with a remote sensing image, for example in a MapPane object.

Since:

2.2

Version:

$Id: ColorRamp.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Nested Class Summary

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

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, 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

ColorRamp()
Constructs an initially empty color bar.

ColorRamp(org.opengis.coverage.Coverage coverage)
Constructs a color bar for the specified coverage.

Method Summary

void	addNotify() Notifies this component that it now has a parent component.
protected Graduation	createGraduation(Graduation reuse, org.opengis.coverage.SampleDimension band, double minimum, double maximum) Returns a graduation for the specified sample dimension, minimum and maximum values.
java.awt.Color[]	getColors() Returns the colors painted by this .
Graduation	getGraduation() Returns the graduation to paint over colors.
int	getOrientation() Returns the component's orientation (horizontal or vertical).
boolean	isLabelVisibles() Tests if graduation labels are paint on top of the colors ramp.
void	removeNotify() Notifies this component that it no longer has a parent component.
boolean	setColors(java.awt.Color[] colors) Sets the colors to paint.
boolean	setColors(org.opengis.coverage.Coverage coverage) Sets the graduation and the colors from a coverage.
boolean	setColors(java.awt.image.IndexColorModel model) Sets the colors to paint from an IndexColorModel.
boolean	setColors(org.opengis.coverage.SampleDimension band) Sets the graduation and the colors from a sample dimension.
void	setForeground(java.awt.Color color) Sets the label colors.
boolean	setGraduation(Graduation graduation) Set the graduation to paint on top of the color bar.
void	setLabelVisibles(boolean visible) Sets whatever the graduation labels should be painted on top of the colors ramp.
void	setOrientation(int orient) Set the component's orientation (horizontal or vertical).
java.lang.String	toString() Returns a string representation for this color ramp.

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, 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, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, 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, 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, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColorRamp

public ColorRamp()

Constructs an initially empty color bar. Colors can be set using one of the methods.

ColorRamp

public ColorRamp(org.opengis.coverage.Coverage coverage)

Constructs a color bar for the specified coverage.

Method Detail

getGraduation

public Graduation getGraduation()

Returns the graduation to paint over colors. If the graduation is not yet defined, then this method returns .

setGraduation

public boolean setGraduation(Graduation graduation)

Set the graduation to paint on top of the color bar. The graduation can be set also by a call to setColors(SampleDimension) and setColors(Coverage). This method will fire a property change event with the name.

Parameters:

graduation - The new graduation, or if none.

Returns:

if this object changed as a result of this call.

getColors

public java.awt.Color[] getColors()

Returns the colors painted by this .

Returns:

The colors (never ).

setColors

public boolean setColors(java.awt.Color[] colors)

Sets the colors to paint. This method will fire a property change event with the name.

Parameters:

colors - The colors to paint.

Returns:

if the state of this changed as a result of this call.

See Also:

setColors(Coverage), setColors(SampleDimension), setColors(IndexColorModel), getColors(), getGraduation()

setColors

public boolean setColors(java.awt.image.IndexColorModel model)

Sets the colors to paint from an IndexColorModel. The default implementation fetches the colors from the index color model and invokes setColors(Color[]).

Parameters:

model - The colors to paint.

Returns:

if the state of this changed as a result of this call.

See Also:

setColors(Coverage), setColors(SampleDimension), setColors(Color[]), getColors(), getGraduation()

setColors

public boolean setColors(org.opengis.coverage.SampleDimension band)

Sets the graduation and the colors from a sample dimension. The default implementation fetchs the palette and the minimum and maximum values from the supplied band, and then invokes setColors and setGraduation.

Parameters:

band - The sample dimension, or .

Returns:

if the state of this changed as a result of this call.

See Also:

setColors(Coverage), setColors(SampleDimension), setColors(IndexColorModel), setColors(Color[]), getColors(), getGraduation()

setColors

public boolean setColors(org.opengis.coverage.Coverage coverage)

Sets the graduation and the colors from a coverage. The default implementation fetchs the visible sample dimension from the specified coverage, and then invokes setColors and setGraduation.

Parameters:

coverage - The coverage, or .

Returns:

if the state of this changed as a result of this call.

See Also:

setColors(IndexColorModel), setColors(SampleDimension), getColors(), getGraduation()

getOrientation

public int getOrientation()

Returns the component's orientation (horizontal or vertical). It should be one of the following constants: (SwingConstants.HORIZONTAL or SwingConstants.VERTICAL).

setOrientation

public void setOrientation(int orient)

Set the component's orientation (horizontal or vertical).

Parameters:

orient - SwingConstants.HORIZONTAL or SwingConstants.VERTICAL.

isLabelVisibles

public boolean isLabelVisibles()

Tests if graduation labels are paint on top of the colors ramp. Default value is .

setLabelVisibles

public void setLabelVisibles(boolean visible)

Sets whatever the graduation labels should be painted on top of the colors ramp.

setForeground

public void setForeground(java.awt.Color color)

Sets the label colors. A value reset the automatic color.

See Also:

Component.getForeground()

createGraduation

protected Graduation createGraduation(Graduation reuse,
                                      org.opengis.coverage.SampleDimension band,
                                      double minimum,
                                      double maximum)

Returns a graduation for the specified sample dimension, minimum and maximum values. This method must returns a graduation of the appropriate class, usually NumberGraduation or LogarithmicNumberGraduation. If the supplied object is non-null and is of the appropriate class, then this method can returns without creating a new graduation object. This method must set graduations's minimum, maximum and unit according the values given in arguments.

Parameters:

reuse - The graduation to reuse if possible.

band - The sample dimension to create graduation for.

minimum - The minimal geophysics value to appears in the graduation.

maximum - The maximal geophysics value to appears in the graduation.

Returns:

A graduation for the supplied sample dimension.

toString

public java.lang.String toString()

Returns a string representation for this color ramp.

addNotify

public void addNotify()

Notifies this component that it now has a parent component. This method is invoked by Swing and shouldn't be directly used.

removeNotify

public void removeNotify()

Notifies this component that it no longer has a parent component. This method is invoked by Swing and shouldn't be directly used.