Package adams.gui.tools

Class PropertiesViewerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.tools.PropertiesViewerPanel

All Implemented Interfaces:

MenuBarProvider, SendToActionSupporter, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TableModelListener

public class PropertiesViewerPanel
extends BasePanel
implements MenuBarProvider, TableModelListener, SendToActionSupporter

A panel displaying properties files. If the properties file is managed through the Environment class, then it will be loaded through this mechanism, otherwise a simple loading of the properties, just for the current project will be performed.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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 BaseComboBox	m_ComboBoxKeys	the combobox with the properties keys.
protected File	m_CurrentFile	the current props file.
protected BaseFileChooser	m_FileChooser	the file chooser for loading external props files.
protected JMenuBar	m_MenuBar	the menu bar, if used.
protected JMenuItem	m_MenuItemClose	the "close" menu item.
protected JMenuItem	m_MenuItemOpen	the "open" menu item.
protected JMenuItem	m_MenuItemSave	the "save" menu item.
protected JMenu	m_MenuLoadRecent	the "load recent" submenu.
protected SearchPanel	m_PanelSearch	the search panel.
protected RecentFilesHandler<JMenu>	m_RecentFilesHandler	the recent files handler.
protected SortableAndSearchableTable	m_Table	the table displaying the information.
protected PropertiesTableModel	m_TableModel	the table model displaying the data.
static String	SESSION_FILE	the file to store the recent files in.

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructor Summary

Constructors

Constructor	Description
PropertiesViewerPanel()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkForModified()	Returns whether we can proceed with the operation or not, depending on whether the user saved the flow or discarded the changes.
protected void	close()	Closes the dialog or frame.
protected void	finishInit()	Finishes the initialization.
JMenuBar	getMenuBar()	Creates a menu bar (singleton per panel object).
Class[]	getSendToClasses()	Returns the classes that the supporter generates.
Object	getSendToItem(Class[] cls)	Returns the object to send.
boolean	hasSendToItem(Class[] cls)	Checks whether something to send is available.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
protected void	open()	Presents the user with an input dialog to enter the props file.
protected void	open(Properties props)	Displays the properties in the table.
protected void	open(File file)	Opens the specified properties file and displays it.
protected void	save()	Saves the current properties.
void	tableChanged(TableModelEvent e)	This fine grain notification tells listeners the exact range of cells, rows, or columns that changed.
protected void	updateMenu()	Updates the menu items.
protected void	updateTitle()	Updates the title of the dialog.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, unregisterKeyboardAction, update

Methods inherited from class java.awt.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, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_FILE

public static final String SESSION_FILE

the file to store the recent files in.

See Also:

Constant Field Values

m_ComboBoxKeys

protected BaseComboBox m_ComboBoxKeys

the combobox with the properties keys.

m_TableModel

protected PropertiesTableModel m_TableModel

the table model displaying the data.

m_Table

protected SortableAndSearchableTable m_Table

the table displaying the information.

m_PanelSearch

protected SearchPanel m_PanelSearch

the search panel.

m_MenuBar

protected JMenuBar m_MenuBar

the menu bar, if used.

m_MenuItemOpen

protected JMenuItem m_MenuItemOpen

the "open" menu item.

m_MenuLoadRecent

protected JMenu m_MenuLoadRecent

the "load recent" submenu.

m_MenuItemSave

protected JMenuItem m_MenuItemSave

the "save" menu item.

m_MenuItemClose

protected JMenuItem m_MenuItemClose

the "close" menu item.

m_CurrentFile

protected File m_CurrentFile

the current props file.

m_FileChooser

protected BaseFileChooser m_FileChooser

the file chooser for loading external props files.

m_RecentFilesHandler

protected RecentFilesHandler<JMenu> m_RecentFilesHandler

the recent files handler.

Constructor Detail

PropertiesViewerPanel

public PropertiesViewerPanel()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

finishInit

protected void finishInit()

Finishes the initialization.

Overrides:

finishInit in class BasePanel

getMenuBar

public JMenuBar getMenuBar()

Creates a menu bar (singleton per panel object). Can be used in frames.

Specified by:

getMenuBar in interface MenuBarProvider

Returns:

the menu bar

checkForModified

protected boolean checkForModified()

Returns whether we can proceed with the operation or not, depending on whether the user saved the flow or discarded the changes.

Returns:

true if safe to proceed

updateMenu

protected void updateMenu()

Updates the menu items.

updateTitle

protected void updateTitle()

Updates the title of the dialog.

close

protected void close()

Closes the dialog or frame.

open

protected void open()

Presents the user with an input dialog to enter the props file.

open

protected void open(File file)

Opens the specified properties file and displays it.

Parameters:

file - the file to load and display

open

protected void open(Properties props)

Displays the properties in the table.

Parameters:

props - the properties to display

save

protected void save()

Saves the current properties.

tableChanged

public void tableChanged(TableModelEvent e)

This fine grain notification tells listeners the exact range of cells, rows, or columns that changed.

Specified by:

tableChanged in interface TableModelListener

Parameters:

e - the event

getSendToClasses

public Class[] getSendToClasses()

Returns the classes that the supporter generates.

Specified by:

getSendToClasses in interface SendToActionSupporter

Returns:

the classes

hasSendToItem

public boolean hasSendToItem(Class[] cls)

Checks whether something to send is available.

Specified by:

hasSendToItem in interface SendToActionSupporter

Parameters:

cls - the requested classes

Returns:

true if an object is available for sending

getSendToItem

public Object getSendToItem(Class[] cls)

Returns the object to send.

Specified by:

getSendToItem in interface SendToActionSupporter

Parameters:

cls - the requested classes

Returns:

the item to send