Class NodePickerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.apache.batik.apps.svgbrowser.NodePickerPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ActionMap

public class NodePickerPanel
extends JPanel
implements ActionMap

Used to preview and edit nodes.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	NodePickerPanel.AddButtonAction	The action associated with the 'Add' button.
protected class	NodePickerPanel.ApplyButtonAction	The action associated with the 'Apply' button.
static class	NodePickerPanel.AttributesTableModel	The attributesTable model.
protected class	NodePickerPanel.AttributesTableModelListener	Listens for the changes in the table and updates this node picker panel if needed.
static class	NodePickerPanel.NameEditorDialog	Dialog for choosing element name.
static class	NodePickerPanel.NodePickerAdapter	The adapter for the NodePicker listener.
protected class	NodePickerPanel.NodePickerEditListener	Manages the edits on focus events.
static class	NodePickerPanel.NodePickerEvent	Event to pass to listener.
static interface	NodePickerPanel.NodePickerListener	Node picker listener.
protected class	NodePickerPanel.RemoveButtonAction	The action associated with the 'Remove' button.
protected class	NodePickerPanel.ResetButtonAction	The action associated with the 'Reset' button.
protected static class	NodePickerPanel.SVGInputPanel	The panel to view and edit the elements xml representation.
protected class	NodePickerPanel.XMLAreaListener	Listens for the changes in the xml text area and updates this node picker panel if needed.

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ADD_NEW_ELEMENT	Creates new element while in this mode.
private JButton	addButton	The Add button.
private JButton	applyButton	The Apply button.
private JScrollPane	attributePane	The Attributes table ScrollPane.
private JLabel	attributesLabel	The Attributes table label.
private JPanel	attributesPanel	The Attributes table and buttons Panel.
private JTable	attributesTable	The attributes table - the table that consists of attribute name and attribute value columns.
private static ResourceBundle	bundle	The resource bundle.
private ButtonFactory	buttonFactory	The Button factory.
private JPanel	choosePanel	The OK and Cancel button Panel.
private Element	clonedElement	The copy of the original (preview) element.
private NodePickerController	controller	The controller for this panel.
private static final int	EDIT_MODE	Edit mode.
private EventListenerList	eventListeners	Listeners list.
private boolean	isDirty	If the element being edited is actually changed.
private JLabel	isWellFormedLabel	The isWellFormed label.
private Map	listeners	The map that contains the listeners
private int	mode	The panel mode.
private Node	parentElement	The parent Element for the element to be added.
private Element	previewElement	The element that is being previewed or edited it's content (xml representation).
private JButton	removeButton	The Remove button.
private JButton	resetButton	The Reset button.
private static ResourceManager	resources	The resource manager.
private static final String	RESOURCES	The resource file name.
private boolean	shouldProcessUpdate	If the attribute table listener should process the update event and update node picker after an update on the table had triggered.
private NodePickerPanel.SVGInputPanel	svgInputPanel	The svg input panel.
private JLabel	svgInputPanelNameLabel	The svgInputPanel name label.
private TableModelListener	tableModelListener	The Attribute table model listener.
private static final int	VIEW_MODE	View only.

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
NodePickerPanel(NodePickerController controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
private void	addButtonActions()	Adds button actions.
void	addListener(NodePickerPanel.NodePickerListener listener)	Adds the listener to the listener list.
void	enterAddNewElementMode(Element newElement, Node parent)	Enters the add new element mode.
void	enterEditMode()	Enters the edit mode.
void	enterViewMode()	Enters the view mode.
void	fireAddNewElement(NodePickerPanel.NodePickerEvent event)	Fires the AddNewElement event.
void	fireUpdateElement(NodePickerPanel.NodePickerEvent event)	Fires the updateElement event.
Action	getAction(String key)	Returns the action associated with the given string or null on error
private JButton	getAddButton()	Gets the Add button.
private JButton	getApplyButton()	Gets the Apply button.
private JPanel	getAttributesPanel()	Gets the attributesPanel.
private ButtonFactory	getButtonFactory()	Gets buttonFactory.
private JPanel	getChoosePanel()	Gets the choosePanel.
private int	getMode()	Gets the current working mode.
private String	getNamespaceURI(String prefix)	Looks up for the namespaceURI based on the given prefix.
private Element	getPreviewElement()	Getter for the preivewElement.
private JButton	getRemoveButton()	Gets the Remove button.
private JButton	getResetButton()	Gets the Reset sbutton.
String	getResults()	Gets the results of this node picker panel - gets the contents of the xml text area.
private NodePickerPanel.SVGInputPanel	getSvgInputPanel()	Gets the svgInputPanel.
private void	initialize()	Initalizes this panel.
private boolean	isANodePickerComponent(Component component)	Checks whether the given component is a part component of the this node picker.
private boolean	isElementModified()	Whether the element being edit is changed.
(package private) boolean	panelHiding()	Invoked by the DOMViewer to inform the NodePickerPanel that it is being hidden.
private Element	parseXml(String xmlString)	Parses the given xml and return parsed document's root element.
boolean	promptForChanges()	Shows a dialog to save changes.
private void	removeAttributes(Element element)	Removes all the attributes from an element.
void	setEditable(boolean editable)	Sets the node picker components to be editable / uneditable.
void	setPreviewElement(Element elem)	Sets the preview element.
private boolean	shouldUpdate(String mutationEventType, Node affectedNode, Node currentNode)	If the panel should update its components after dom mutation event.
private void	updateAttributesTable(Element elem)	Fills the attributesTable with the given element attribute name - value pairs.
private void	updateElementAttributes(Element element, NodePickerPanel.AttributesTableModel tableModel)	Replaces all of the atributes of a given element with the values from the given table model.
private void	updateElementAttributes(Element elem, Element referentElement)	Replaces all of the attributes of the given element with the referent element's attributes.
private void	updateNodeXmlArea(Node node)	Shows node's String representation in svgInputPanel
void	updateOnDocumentChange(String mutationEventType, Node targetNode)	Updates the panel when DOM Mutation event occures.
private void	updateViewAfterSvgInput(Element referentElement, Element elementToUpdate)	Update the components and the element after text is being inputted in the xml text area.

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class 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, setVisible, unregisterKeyboardAction, update

Methods inherited from class 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 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 Object

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

Field Details

VIEW_MODE

private static final int VIEW_MODE

View only. Inspects the associated node.

See Also:

• Constant Field Values

EDIT_MODE

private static final int EDIT_MODE

Edit mode. Used for editing the associated node.

See Also:

• Constant Field Values

ADD_NEW_ELEMENT

private static final int ADD_NEW_ELEMENT

Creates new element while in this mode.

See Also:

• Constant Field Values

RESOURCES

private static final String RESOURCES

The resource file name.

See Also:

• Constant Field Values

bundle

private static ResourceBundle bundle

The resource bundle.

resources

private static ResourceManager resources

The resource manager.

attributesTable

private JTable attributesTable

The attributes table - the table that consists of attribute name and attribute value columns. Shows the element's attributes.

tableModelListener

private TableModelListener tableModelListener

The Attribute table model listener.

attributePane

private JScrollPane attributePane

The Attributes table ScrollPane.

attributesPanel

private JPanel attributesPanel

The Attributes table and buttons Panel.

buttonFactory

private ButtonFactory buttonFactory

The Button factory.

addButton

private JButton addButton

The Add button.

removeButton

private JButton removeButton

The Remove button.

attributesLabel

private JLabel attributesLabel

The Attributes table label.

applyButton

private JButton applyButton

The Apply button.

resetButton

private JButton resetButton

The Reset button.

choosePanel

private JPanel choosePanel

The OK and Cancel button Panel.

svgInputPanel

private NodePickerPanel.SVGInputPanel svgInputPanel

The svg input panel.

isWellFormedLabel

private JLabel isWellFormedLabel

The isWellFormed label.

svgInputPanelNameLabel

private JLabel svgInputPanelNameLabel

The svgInputPanel name label.

shouldProcessUpdate

private boolean shouldProcessUpdate

If the attribute table listener should process the update event and update node picker after an update on the table had triggered. Used instead of removing and adding the table listener.

previewElement

private Element previewElement

The element that is being previewed or edited it's content (xml representation).

clonedElement

private Element clonedElement

The copy of the original (preview) element. Used to synchronize svginput area and the attributes table, since the original elements attributes shouldn't be changed while previewing or editing it.

parentElement

private Node parentElement

The parent Element for the element to be added. It is used when adding the new element, to get the information on where to be appended.

mode

private int mode

The panel mode.

isDirty

private boolean isDirty

If the element being edited is actually changed.

eventListeners

private EventListenerList eventListeners

Listeners list.

controller

private NodePickerController controller

The controller for this panel.

listeners

private Map listeners

The map that contains the listeners

Constructor Details

NodePickerPanel

public NodePickerPanel(NodePickerController controller)

Constructor.

Parameters:

controller - The node picker panel controller

Method Details

initialize

private void initialize()

Initalizes this panel.

getButtonFactory

private ButtonFactory getButtonFactory()

Gets buttonFactory.

addButtonActions

private void addButtonActions()

Adds button actions.

getAddButton

private JButton getAddButton()

Gets the Add button.

getRemoveButton

private JButton getRemoveButton()

Gets the Remove button.

getApplyButton

private JButton getApplyButton()

Gets the Apply button.

getResetButton

private JButton getResetButton()

Gets the Reset sbutton.

getAttributesPanel

private JPanel getAttributesPanel()

Gets the attributesPanel.

getSvgInputPanel

private NodePickerPanel.SVGInputPanel getSvgInputPanel()

Gets the svgInputPanel.

getChoosePanel

private JPanel getChoosePanel()

Gets the choosePanel.

getResults

public String getResults()

Gets the results of this node picker panel - gets the contents of the xml text area.

updateViewAfterSvgInput

private void updateViewAfterSvgInput(Element referentElement,
 Element elementToUpdate)

Update the components and the element after text is being inputted in the xml text area.

Parameters:

referentElement - The updated element, referent element

elementToUpdate - The element to update.

updateElementAttributes

private void updateElementAttributes(Element elem,
 Element referentElement)

Replaces all of the attributes of the given element with the referent element's attributes.

Parameters:

elem - The element whose attributes should be replaced

referentElement - The referentElement to copy the attributes from

updateElementAttributes

private void updateElementAttributes(Element element,
 NodePickerPanel.AttributesTableModel tableModel)

Replaces all of the atributes of a given element with the values from the given table model.

Parameters:

element - The node whose attributes should update

tableModel - The tableModel from which to get attributes

removeAttributes

private void removeAttributes(Element element)

Removes all the attributes from an element.

Parameters:

element - The given element

getNamespaceURI

private String getNamespaceURI(String prefix)

Looks up for the namespaceURI based on the given prefix. Uses the Node.lookupNamespaceURI method, starting from the parent element of the element being edited / created.

Parameters:

prefix - The given prefix

Returns:

namespaceURI or null

updateAttributesTable

private void updateAttributesTable(Element elem)

Fills the attributesTable with the given element attribute name - value pairs.

Parameters:

elem - The given element

updateNodeXmlArea

private void updateNodeXmlArea(Node node)

Shows node's String representation in svgInputPanel

Parameters:

node - The given node

getPreviewElement

private Element getPreviewElement()

Getter for the preivewElement.

Returns:

the preivewElement

setPreviewElement

public void setPreviewElement(Element elem)

Sets the preview element. Enters the view mode and updates the associated components.

Parameters:

elem - the element to set

panelHiding

boolean panelHiding()

Invoked by the DOMViewer to inform the NodePickerPanel that it is being hidden.

getMode

private int getMode()

Gets the current working mode.

Returns:

the mode

enterViewMode

public void enterViewMode()

Enters the view mode.

enterEditMode

public void enterEditMode()

Enters the edit mode.

enterAddNewElementMode

public void enterAddNewElementMode(Element newElement,
 Node parent)

Enters the add new element mode.

Parameters:

newElement - The element to be added

parent - The parent node of the element to be added

updateOnDocumentChange

public void updateOnDocumentChange(String mutationEventType,
 Node targetNode)

Updates the panel when DOM Mutation event occures.

shouldUpdate

private boolean shouldUpdate(String mutationEventType,
 Node affectedNode,
 Node currentNode)

If the panel should update its components after dom mutation event. Checks whether any node that is the child node of the node currently being previewed has changed. If true, updates the xml text area of this NodePicker. In case of DOMAttrModiefied mutation event, the additional condition is added - to check whether the attributes of an element that is being previewed are changed. If true, the xml text area is refreshed.

Returns:

True if should update

parseXml

private Element parseXml(String xmlString)

Parses the given xml and return parsed document's root element. Used to check whether the given xml is well formed.

Parameters:

xmlString - Xml as a String

Returns:

Element

setEditable

public void setEditable(boolean editable)

Sets the node picker components to be editable / uneditable.

Parameters:

editable - Whether to enable or disable edit

isANodePickerComponent

private boolean isANodePickerComponent(Component component)

Checks whether the given component is a part component of the this node picker.

Parameters:

component - The given component

Returns:

True if the given component is a part of the this NodePicker

promptForChanges

public boolean promptForChanges()

Shows a dialog to save changes.

isElementModified

private boolean isElementModified()

Whether the element being edit is changed.

Returns:

True if the element being edit is changed

getAction

public Action getAction(String key)
                 throws MissingListenerException

Returns the action associated with the given string or null on error

Specified by:

getAction in interface ActionMap

Parameters:

key - the key mapped with the action to get

Throws:

MissingListenerException - if the action is not found

fireUpdateElement

public void fireUpdateElement(NodePickerPanel.NodePickerEvent event)

Fires the updateElement event.

Parameters:

event - The associated NodePickerEvent event

fireAddNewElement

public void fireAddNewElement(NodePickerPanel.NodePickerEvent event)

Fires the AddNewElement event.

Parameters:

event - The associated NodePickerEvent event

addListener

public void addListener(NodePickerPanel.NodePickerListener listener)

Adds the listener to the listener list.

Parameters:

listener - The listener to add