Class ConfigDescriptionEditor
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- java.awt.Window
-
- java.awt.Frame
-
- javax.swing.JFrame
-
- org.pentaho.reporting.tools.configeditor.ConfigDescriptionEditor
-
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,RootPaneContainer
,WindowConstants
public class ConfigDescriptionEditor extends 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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame
-
Nested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
-
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
-
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
Fields Modifier and Type Field Description protected static String
EDITOR_FONT_KEY
A configuration key to define the Font used in the editor.protected static 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, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, 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
-
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
-
Constructor Summary
Constructors Constructor Description ConfigDescriptionEditor()
ConfigDescriptionEditor(String booterClass)
Constructs a ConfigDescriptionEditor that is initially invisible.ConfigDescriptionEditor(org.pentaho.reporting.libraries.base.boot.AbstractBoot boot)
Constructs a ConfigDescriptionEditor that is initially invisible.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
attempExit()
Handles the attemp to quit the program.protected JPanel
createStatusBar()
Creates the statusbar for this frame.protected JList
getEntryList()
Returns the JList component containing all configuration entries.protected int
getEntryType()
Returns the current entry type.protected JTextField
getEnumEntryEditField()
Returns the text field containing the currently edited enumeration entry.protected JList
getEnumEntryList()
Returns the JList component containing all entries of the enumeration detail editor.protected 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.pentaho.reporting.libraries.base.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 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(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(String text)
Defines the status text for this dialog.protected void
writeSelectedEntry()
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, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
-
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated
-
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
-
-
-
-
Field Detail
-
EDITOR_FONT_KEY
protected static final String EDITOR_FONT_KEY
A configuration key to define the Font used in the editor.- See Also:
- Constant Field Values
-
EDITOR_FONT_SIZE_KEY
protected static final String EDITOR_FONT_SIZE_KEY
A configuration key to define the Font size used in the editor.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ConfigDescriptionEditor
public ConfigDescriptionEditor()
-
ConfigDescriptionEditor
public ConfigDescriptionEditor(org.pentaho.reporting.libraries.base.boot.AbstractBoot boot)
Constructs a ConfigDescriptionEditor that is initially invisible.
-
ConfigDescriptionEditor
public ConfigDescriptionEditor(String booterClass)
Constructs a ConfigDescriptionEditor that is initially invisible.
-
-
Method Detail
-
getEnumEntryList
protected JList getEnumEntryList()
Returns the JList component containing all entries of the enumeration detail editor.- Returns:
- the enumeration entry list.
-
getEnumEntryEditField
protected JTextField getEnumEntryEditField()
Returns the text field containing the currently edited enumeration entry.- Returns:
- the textfield containing the current entry.
-
getEnumEntryListModel
protected DefaultListModel getEnumEntryListModel()
Returns the List Model containing all entries of the current enumeration entry editor.- Returns:
- the entry list.
-
getEntryList
protected JList getEntryList()
Returns the JList component containing all configuration entries.- Returns:
- the entry list.
-
createStatusBar
protected 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(String text)
Defines the status text for this dialog.- Parameters:
text
- the new status text.
-
getStatusText
protected 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.
-
writeSelectedEntry
protected void writeSelectedEntry()
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.pentaho.reporting.libraries.base.util.ResourceBundleSupport getResources()
Returns the resource bundle of this editor for translating strings.- Returns:
- the resource bundle.
-
main
public static void main(String[] args)
The main entry point to start the detail editor.- Parameters:
args
- ignored.
-
-