org.geotoolkit.gui.swing.image
Class KernelEditor

Object
  Component
      Container
          JComponent
              KernelEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Dialog

public class KernelEditor
extends JComponent
implements Dialog

A widget for selecting and/or editing a KernelJAI object. Kernels are used for image convolutions. KernelEditor widgets are initially empty, but a set of default kernels can be added with addDefaultKernels() including (but not limited to) Floyd & Steinberg (1975), Jarvis, Judice & Ninke (1976) and Stucki (1981).

Each kernel can belong to an optional category. Example of categories includes "Error filters" and "Gradient masks".

Since:

2.3

Version:

3.00

Author:

Martin Desruisseaux (IRD)

See Also:

GradientKernelEditor, ConvolveDescriptor, 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

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

KernelEditor()
Constructs a new kernel editor.

Method Summary

void	addDefaultKernels() Add a set of predefined kernels.
void	addKernel(String category, String name, KernelJAI kernel) Adds a kernel to the list of available kernels.
void	commitEdit() Forces the current value to be taken from the editable fields and set them as the current values.
KernelJAI	getKernel() Returns the currently edited kernel.
String	getKernelCategory() Returns the category for the current kernel.
ComboBoxModel	getKernelListModel() Returns the list of predefined kernels in the current category.
String[]	getKernelNames() Returns an array of kernel names in the current category.
TableModel	getKernelTableModel() Returns the table model containing the current kernel coefficients.
void	removeAllKernels() Removes all kernels and categories.
void	removeKernel(KernelJAI kernel) Removes a kernel.
void	removeKernel(String kernel) Removes a kernel by its name.
void	setKernel(KernelJAI kernel) Sets the kernel.
void	setKernel(String name) Sets the kernel by its name.
void	setKernelSize(int width, int height) Sets the size of the current kernel.
boolean	showDialog(Component owner, String title) Shows a dialog box requesting input from the user.
void	sortKernelNames(Comparator<String> comparator) Sort all kernel names according the specified comparator.

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

Constructor Detail

KernelEditor

public KernelEditor()

Constructs a new kernel editor. No kernel will be initially shown. The method setKernel(javax.media.jai.KernelJAI) must be invoked, or the user must performs a selection in a combo box, in order to make a kernel visible.

Method Detail

addDefaultKernels

public void addDefaultKernels()

Add a set of predefined kernels. Default kernels includes (but is not limited to) Floyd & Steinberg (1975), Jarvis, Judice & Ninke (1976) and Stucki (1981).

addKernel

public void addKernel(String category,
                      String name,
                      KernelJAI kernel)

Adds a kernel to the list of available kernels. The widget list kernels in the same order they were added, unless sortKernelNames(java.util.Comparator) has been invoked. Each kernel can belong to an optional category. Example of categories includes "Error filters" and "Gradient masks".

Parameters:

category - The kernel's category name, or null if none.

name - The kernel name. Kernels will be displayed in alphabetic order.

kernel - The kernel. If an other kernel was registered with the same name, the previous kernel will be discarded.

removeKernel

public void removeKernel(KernelJAI kernel)

Removes a kernel. If the kernel was the only one in its category, the category is removed as well.

Parameters:

kernel - The kernel to remove.

removeKernel

public void removeKernel(String kernel)

Removes a kernel by its name. If the kernel was the only one in its category, the category is removed as well.

Parameters:

kernel - The kernel to remove.

removeAllKernels

public void removeAllKernels()

Removes all kernels and categories.

setKernel

public void setKernel(KernelJAI kernel)

Sets the kernel. The table size will be set to the specified kernel size, add all coefficients will be copied in the table. If the specified kernel matches one of the kernel registered with the addKernel method, then the kernel name and category will be updated according.

Parameters:

kernel - The new kernel.

setKernel

public void setKernel(String name)

Sets the kernel by its name. It must be one of the name registered with addKernel(java.lang.String, float[]). If name is not found, then nothing is done.

Parameters:

name - The name of the kernel to select.

setKernelSize

public void setKernelSize(int width,
                          int height)

Sets the size of the current kernel.

Parameters:

width - The number of rows.

height - The number of columns.

getKernel

public KernelJAI getKernel()

Returns the currently edited kernel.

Returns:

The edited kernel.

getKernelCategory

public String getKernelCategory()

Returns the category for the current kernel. This is the category argument given to addKernel(category, name, kernel), where kernel is the current kernel.

Returns:

The category for the current kernel, or null if none.

sortKernelNames

public void sortKernelNames(Comparator<String> comparator)

Sort all kernel names according the specified comparator.

Parameters:

comparator - The comparator, or null for the natural ordering.

getKernelNames

public String[] getKernelNames()

Returns an array of kernel names in the current category. Changes in the returned array will not affect the KernelEditor state.

Returns:

The name of all kernels in the current category.

getKernelListModel

public ComboBoxModel getKernelListModel()

Returns the list of predefined kernels in the current category. The content of this list will changes every time a kernel is added or removed and every time the user selects a new category. The selected item can change at any time as well, according user action.

Returns:

The predefined kernels in the current category.

getKernelTableModel

public TableModel getKernelTableModel()

Returns the table model containing the current kernel coefficients. The content of this table will changes every time the user select a new predefined kernel, or when the user edit cell values.

Returns:

The kernels coefficients.

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).