org.geotoolkit.gui.swing.image
Class GradientKernelEditor

Object
  Component
      Container
          JComponent
              GradientKernelEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Dialog

public class GradientKernelEditor
extends JComponent
implements Dialog

A widget for editing the horizontal and vertical kernels for a gradient magnitude operation. This widget combine two KernelEditor side-by-side: one for the horizontal component and one for the vertical component.

Demo The image on the left side gives an example of this widget appearance. To try this component in your browser, see the demonstration applet.

Since:

2.3

Version:

3.00

Author:

Martin Desruisseaux (IRD)

See Also:

KernelEditor, GradientMagnitudeDescriptor, GradientMagnitude, Serialized Form

Module:

display/geotk-widgets-swing (download)

View source code for this class

Nested Class Summary

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static KernelJAI	ISOTROPIC_HORIZONTAL Horizontal gradient mask (isotropic).
static KernelJAI	ISOTROPIC_VERTICAL Vertical gradient mask (isotropic).
static KernelJAI	KIRSCH_HORIZONTAL Horizontal gradient mask according Kirsch.
static KernelJAI	KIRSCH_VERTICAL Vertical gradient mask according Kirsch.
static KernelJAI	PREWITT_HORIZONTAL Horizontal gradient mask according Prewitt (also know as smoothed).
static KernelJAI	PREWITT_VERTICAL Vertical gradient mask according Prewitt (also know as smoothed).
static KernelJAI	SOBEL_HORIZONTAL Horizontal gradient mask according Sobel.
static KernelJAI	SOBEL_VERTICAL Vertical gradient mask according Sobel.

Fields inherited from class 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 Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

GradientKernelEditor()
Constructs a new editor for gradient kernels.

Method Summary

void	addDefaultKernels() Adds a set of predefined kernels.
void	commitEdit() Forces the current value to be taken from the editable fields and set them as the current values.
KernelEditor	getHorizontalEditor() Returns the horizontal kernel editor.
KernelEditor	getVerticalEditor() Returns the vertical kernel editor.
boolean	showDialog(Component owner, String title) Shows a dialog box requesting input from the user.

Methods inherited from class 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, getGraphics, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class 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, 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, 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 Object

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

Field Detail

PREWITT_HORIZONTAL

public static final KernelJAI PREWITT_HORIZONTAL

Horizontal gradient mask according Prewitt (also know as smoothed).

PREWITT_VERTICAL

public static final KernelJAI PREWITT_VERTICAL

Vertical gradient mask according Prewitt (also know as smoothed).

ISOTROPIC_HORIZONTAL

public static final KernelJAI ISOTROPIC_HORIZONTAL

Horizontal gradient mask (isotropic).

ISOTROPIC_VERTICAL

public static final KernelJAI ISOTROPIC_VERTICAL

Vertical gradient mask (isotropic).

SOBEL_HORIZONTAL

public static final KernelJAI SOBEL_HORIZONTAL

Horizontal gradient mask according Sobel.

SOBEL_VERTICAL

public static final KernelJAI SOBEL_VERTICAL

Vertical gradient mask according Sobel.

KIRSCH_HORIZONTAL

public static final KernelJAI KIRSCH_HORIZONTAL

Horizontal gradient mask according Kirsch.

KIRSCH_VERTICAL

public static final KernelJAI KIRSCH_VERTICAL

Vertical gradient mask according Kirsch.

TODO:

Why positives numbers are on the first row? This is the opposite of other vertical gradient masks. Need to verify in J.J. Simpson (1990).

Constructor Detail

GradientKernelEditor

public GradientKernelEditor()

Constructs a new editor for gradient kernels.

Method Detail

addDefaultKernels

public void addDefaultKernels()

Adds a set of predefined kernels. This convenience method invokes KernelEditor.addDefaultKernels() on both horizontal and vertical kernel editors. The default implementation for those editors will add a set of Sobel kernels.

getHorizontalEditor

public KernelEditor getHorizontalEditor()

Returns the horizontal kernel editor.

Returns:

The horizontal kernel editor.

getVerticalEditor

public KernelEditor getVerticalEditor()

Returns the vertical kernel editor.

Returns:

The vertical kernel editor.

commitEdit

public void commitEdit()
                throws ParseException

Forces the current value to be taken from the editable fields and set them as the current values. If this operation fails for at least one field, this method will set the focus on the offending field before to throw the exception.

This method is typically invoked after Dialog.showDialog(Component, String) returned true and before to read the values from the dialog widget.

Specified by:

commitEdit in interface Dialog

Throws:

ParseException - If at least one values couldn't be commited.

Since:

3.12

See Also:

JFormattedTextField.commitEdit(), JSpinner.commitEdit()

showDialog

public boolean showDialog(Component owner,
                          String title)

Shows a dialog box requesting input from the user. The dialog box will be parented to owner. If owner is contained into a JDesktopPane, the dialog box will appears as an internal frame.

Multi-threading
Geotk implementations allow this method to be invoked from any thread. If the caller thread is not the Swing thread, then the execution of this method will be registered in the AWT Event Queue and the caller thread will block until completion.

Specified by:

showDialog in interface Dialog

Parameters:

owner - The parent component for the dialog box, or null if there is no parent.

title - The dialog box title.

Returns:

true if user pressed the "Ok" button, or false otherwise (e.g. pressing "Cancel" or closing the dialog box from the title bar).