jmri.jmrit.catalog
Class CatalogPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  jmri.jmrit.catalog.CatalogPanel

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class CatalogPanel
extends JPanel
implements MouseListener

Create a JPanel containing trees of resources to replace default icons. The panel also displays image files files contained in a node of a tree. Drag and Drop is implemented to drag a display of an icon to the display of an icon that may be added to the panel.

This panel is used in the Icon Editors and also in the ImageIndex Editor.

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Author:

Pete Cressman Copyright 2009

See Also:

Serialized Form

Nested Class Summary

class

CatalogPanel.MemoryExceptionHandler

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

protected Color	_currentBackground
protected boolean	_noMemory
protected JPanel	_preview
static int	ICON_HEIGHT
static double	ICON_SCALE
static int	ICON_WIDTH

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

CatalogPanel()

CatalogPanel(String label1, String label2)

Method Summary

void	addTree(CatalogTree tree) Extend the Catalog by adding a tree to the root.
void	createNewBranch(String systemName, String userName, String path) Create a new model and add it to the main root
static Frame	getParentFrame(Component comp)
CatalogTreeNode	getSelectedNode() Return the node the user has selected.
void	init(boolean treeDnD)
boolean	insertNodeIntoModel(String name, CatalogTreeNode parent) Insert a new node into the displayed tree.
static CatalogPanel	makeDefaultCatalog()
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
boolean	nodeChange(CatalogTreeNode node, String name) Make a change to a node in the displayed tree.
static void	packParentFrame(Component comp)
static String	printDbl(double z, int decimalPlaces) Utility
void	removeNodeFromModel(CatalogTreeNode node) Delete a node from the displayed tree.
protected void	resetPanel()
void	scrollPathToVisible(String[] names)
void	setBackground(Container container)
protected String	setIcons() Display the icons in the preview panel
void	setSelectedNode(String[] names)
void	setToolTipText(String tip)
void	updatePanel()

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, transferFocusBackward, 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, 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 java.lang.Object

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

Field Detail

ICON_SCALE

public static final double ICON_SCALE

See Also:

Constant Field Values

ICON_WIDTH

public static final int ICON_WIDTH

See Also:

Constant Field Values

ICON_HEIGHT

public static final int ICON_HEIGHT

See Also:

Constant Field Values

_currentBackground

protected Color _currentBackground

_preview

protected JPanel _preview

_noMemory

protected boolean _noMemory

Constructor Detail

CatalogPanel

public CatalogPanel()

CatalogPanel

public CatalogPanel(String label1,
                    String label2)

Method Detail

setToolTipText

public void setToolTipText(String tip)

Overrides:

setToolTipText in class JComponent

init

public void init(boolean treeDnD)

updatePanel

public void updatePanel()

createNewBranch

public void createNewBranch(String systemName,
                            String userName,
                            String path)

Create a new model and add it to the main root

addTree

public void addTree(CatalogTree tree)

Extend the Catalog by adding a tree to the root.

insertNodeIntoModel

public boolean insertNodeIntoModel(String name,
                                   CatalogTreeNode parent)

Insert a new node into the displayed tree.

removeNodeFromModel

public void removeNodeFromModel(CatalogTreeNode node)

Delete a node from the displayed tree.

nodeChange

public boolean nodeChange(CatalogTreeNode node,
                          String name)

Make a change to a node in the displayed tree. Either its name or the contents of its leaves (image references)

setBackground

public void setBackground(Container container)

resetPanel

protected void resetPanel()

setIcons

protected String setIcons()
                   throws OutOfMemoryError

Display the icons in the preview panel

Throws:

OutOfMemoryError

makeDefaultCatalog

public static CatalogPanel makeDefaultCatalog()

getParentFrame

public static Frame getParentFrame(Component comp)

packParentFrame

public static void packParentFrame(Component comp)

printDbl

public static String printDbl(double z,
                              int decimalPlaces)

Utility

setSelectedNode

public void setSelectedNode(String[] names)

scrollPathToVisible

public void scrollPathToVisible(String[] names)

getSelectedNode

public CatalogTreeNode getSelectedNode()

Return the node the user has selected.

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener