org.jfree.report.modules.gui.config
Class ConfigDescriptionEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--org.jfree.report.modules.gui.config.ConfigDescriptionEditor

public class ConfigDescriptionEditor

extends javax.swing.JFrame

The config description editor is used to edit the configuration metadata used in the ConfigEditor to describe the ReportConfiguration keys.

Author:

Thomas Morgner

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Field Summary

protected static java.lang.String	EDITOR_FONT_KEY A configuration key to define the Font used in the editor.
protected static java.lang.String	EDITOR_FONT_SIZE_KEY A configuration key to define the Font size used in the editor.

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

ConfigDescriptionEditor()
Constructs a ConfigDescriptionEditor that is initially invisible.

Method Summary

protected void	attempExit() Handles the attemp to quit the program.
protected javax.swing.JPanel	createStatusBar() Creates the statusbar for this frame.
protected javax.swing.JList	getEntryList() Returns the JList component containing all configuration entries.
protected int	getEntryType() Returns the current entry type.
protected javax.swing.JTextField	getEnumEntryEditField() Returns the text field containing the currently edited enumeration entry.
protected javax.swing.JList	getEnumEntryList() Returns the JList component containing all entries of the enumeration detail editor.
protected javax.swing.DefaultListModel	getEnumEntryListModel() Returns the List Model containing all entries of the current enumeration entry editor.
protected ConfigDescriptionModel	getModel() Returns the config description model containing all metainformation about the configuration.
protected org.jfree.util.ResourceBundleSupport	getResources() Returns the resource bundle of this editor for translating strings.
protected ConfigDescriptionEntry	getSelectedEntry() Returns the currently select entry from the entry list model.
protected java.lang.String	getStatusText() Returns the currently visible status text of this dialog.
protected void	load() Loads the config description model from a xml file.
static void	main(java.lang.String[] args) The main entry point to start the detail editor.
protected void	save() Saves the config description model in a xml file.
protected void	setEntryType(int type) Sets the entry type for the current config description entry.
protected void	setSelectedEntry(ConfigDescriptionEntry selectedEntry) Defines the currently selected entry from the entry list model and updates the detail editor to reflect the data from the entry.
protected void	setStatusText(java.lang.String text) Defines the status text for this dialog.
protected void	updateSelectedEntry() Updates the currently selected entry from the values found in the detail editor.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

EDITOR_FONT_KEY

protected static final java.lang.String EDITOR_FONT_KEY

A configuration key to define the Font used in the editor.

EDITOR_FONT_SIZE_KEY

protected static final java.lang.String EDITOR_FONT_SIZE_KEY

A configuration key to define the Font size used in the editor.

Constructor Detail

ConfigDescriptionEditor

public ConfigDescriptionEditor()

Constructs a ConfigDescriptionEditor that is initially invisible.

Method Detail

getEnumEntryList

protected javax.swing.JList getEnumEntryList()

Returns the JList component containing all entries of the enumeration detail editor.

Returns:

the enumeration entry list.

getEnumEntryEditField

protected javax.swing.JTextField getEnumEntryEditField()

Returns the text field containing the currently edited enumeration entry.

Returns:

the textfield containing the current entry.

getEnumEntryListModel

protected javax.swing.DefaultListModel getEnumEntryListModel()

Returns the List Model containing all entries of the current enumeration entry editor.

Returns:

the entry list.

getEntryList

protected javax.swing.JList getEntryList()

Returns the JList component containing all configuration entries.

Returns:

the entry list.

createStatusBar

protected javax.swing.JPanel createStatusBar()

Creates the statusbar for this frame. Use setStatus() to display text on the status bar.

Returns:

the status bar.

setStatusText

protected void setStatusText(java.lang.String text)

Defines the status text for this dialog.

Parameters:

text - the new status text.

getStatusText

protected java.lang.String getStatusText()

Returns the currently visible status text of this dialog.

Returns:

the status text.

setEntryType

protected void setEntryType(int type)

Sets the entry type for the current config description entry. This also selects and activates the correct detail editor for this type.

Parameters:

type - the type of the currently selected entry.

getEntryType

protected int getEntryType()

Returns the current entry type.

Returns:

the current entry type.

getSelectedEntry

protected ConfigDescriptionEntry getSelectedEntry()

Returns the currently select entry from the entry list model.

Returns:

the currently selected entry.

setSelectedEntry

protected void setSelectedEntry(ConfigDescriptionEntry selectedEntry)

Defines the currently selected entry from the entry list model and updates the detail editor to reflect the data from the entry.

Parameters:

selectedEntry - the selected entry.

save

protected void save()

Saves the config description model in a xml file.

load

protected void load()

Loads the config description model from a xml file.

updateSelectedEntry

protected void updateSelectedEntry()

Updates the currently selected entry from the values found in the detail editor.

getModel

protected ConfigDescriptionModel getModel()

Returns the config description model containing all metainformation about the configuration.

Returns:

the config description model.

attempExit

protected void attempExit()

Handles the attemp to quit the program. This method shuts down the VM.

getResources

protected org.jfree.util.ResourceBundleSupport getResources()

Returns the resource bundle of this editor for translating strings.

Returns:

the resource bundle.

main

public static void main(java.lang.String[] args)

The main entry point to start the detail editor.

Parameters:

args - ignored.