org.jfree.report.modules.gui.config.editor
Class EnumKeyEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--org.jfree.report.modules.gui.config.editor.AbstractKeyEditor
                          |
                          +--org.jfree.report.modules.gui.config.editor.EnumKeyEditor

public class EnumKeyEditor

extends AbstractKeyEditor

The enumeration key editor is used to edit configuration keys, which accept a closed set of values. The possible values are defined in the config-description.

Author:

Thomas Morgner

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Fields inherited from class org.jfree.report.modules.gui.config.editor.AbstractKeyEditor

VALID_INPUT_PROPERTY

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

Constructor Summary

EnumKeyEditor(org.jfree.base.config.HierarchicalConfiguration config, EnumConfigDescriptionEntry entry, java.lang.String displayName)
Creates a new enumeration key editor for the given configuration and key definition.

Method Summary

int	getLabelWidth() Returns the preferred width of the label.
void	reset() Restores the original value as read from the report configuration.
void	setEnabled(boolean enabled) Sets whether or not this component is enabled.
void	setLabelWidth(int width) Defines the preferred width of the label.
void	store() Saves the currently selected option as new value in the report configuration.
protected void	validateInput() Checks, whether the input from the combobox is a valid option.

Methods inherited from class org.jfree.report.modules.gui.config.editor.AbstractKeyEditor

deleteValue, getComponent, getConfig, getEmptyIcon, getEntry, getErrorIcon, isDefined, isValidInput, loadValue, setContentPane, setValidInput, storeValue

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumKeyEditor

public EnumKeyEditor(org.jfree.base.config.HierarchicalConfiguration config,
                     EnumConfigDescriptionEntry entry,
                     java.lang.String displayName)

Creates a new enumeration key editor for the given configuration and key definition. The given displayname will be used as label.

Parameters:

config - the report configuration used to read the values.

entry - the metadata for the edited key.

displayName - the text for the label.

Method Detail

reset

public void reset()

Restores the original value as read from the report configuration.

See Also:

KeyEditor.reset()

validateInput

protected void validateInput()

Checks, whether the input from the combobox is a valid option.

store

public void store()

Saves the currently selected option as new value in the report configuration.

See Also:

KeyEditor.store()

setEnabled

public void setEnabled(boolean enabled)

Sets whether or not this component is enabled. A component which is enabled may respond to user input, while a component which is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input.

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

enabled - defines, whether this editor is enabled.

See Also:

Component.isEnabled()

setLabelWidth

public void setLabelWidth(int width)

Defines the preferred width of the label.

Parameters:

width - the new preferred width.

See Also:

KeyEditor.setLabelWidth(int)

getLabelWidth

public int getLabelWidth()

Returns the preferred width of the label.

Returns:

the preferred width.

See Also:

KeyEditor.getLabelWidth()