com.xmlmind.xmleditapp.desktop.select

Class NodePathTool

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.xmlmind.xmledit.nodepath.NodePath

com.xmlmind.xmleditapp.desktop.select.NodePathTool

All Implemented Interfaces:

NodePathListener, AppPart, AppTool, ImageObserver, MenuContainer, Serializable, EventListener

public final class NodePathTool
extends NodePath
implements AppTool, NodePathListener

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xmledit.nodepath.NodePath

NodePath.Item

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 inherited from class com.xmlmind.xmledit.nodepath.NodePath

detailsColor, dim, displayedNode, docIcon, dragEnabled, hoverColor, hoverItem, intrinsicSize, items, listenerList, MARGIN_HEIGHT, MARGIN_WIDTH, readOnlyColor, SEPARATOR_SIZE, STATE_READ_ONLY

Fields inherited from class javax.swing.JComponent

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 and Description
NodePathTool()

Method Summary

Modifier and Type	Method and Description
void	activeEditorChanged() Invoked after the active editor has changed or when there is no active editor at all (generally because all documents have been closed).
void	applyPreferences() If this part supports user preferences, this part should update its state after reading its settings from the object returned by AppBase.getPreferences().
protected Icon	createDocumentIcon()
void	destroyApp() Invoked when the component is detached from the App.
void	editingContextChanged() Invoked when the editing context (text node containing caret, node selection, etc) changes in active editor.
void	flushPreferences() If this part supports user preferences, this part should store its current settings in the object returned by AppBase.getPreferences().
App	getApp() Returns the App containing this part.
String	getHelpId() Returns the online help ID of this component.
String	getId() Returns the ID this part within the App.
protected String	getToolTipText(Document doc)
protected String	getToolTipText(Node node)
void	initApp(App app, String id) Specifies the App containing this part and the unique ID of this part within the App.
boolean	isEditingContextSensitive() This method must return true if this part is intrinsically context sensitive and it must return false if this part is intrinsically not context sensitive.
protected int	layoutItems(NodePath.Item[] items, FontMetrics metrics)
void	namespacePrefixesChanged() Invoked after the namespace/prefix map has been modified for the active document.
void	nodeSelected(NodePathEvent e) Invoked by a NodePath when user selects a node displayed in the path.
protected void	paintTag(Graphics g, NodePath.Item item, int x, int y, Color foreground, boolean hover)
void	saveStateChanged() Invoked after active document has been saved or, on the contrary, when its has been modified and thus needs to be saved.
void	setDragEnabled(boolean enable) Specifies whether the node path bar has a draggable document icon.
void	setHelpId(String helpId) Specifies the online help ID of this component.
protected void	showDocumentMenu(MouseEvent e)
protected int	tagWidth(NodePath.Item item, FontMetrics metrics)
void	undoStateChanged() Invoked after it becomes possible to undo or redo a command in active document or, on the contrary, when it becomes impossible to undo or redo a command.
void	validityStateChanged() Invoked after active document has been checked for validity.

Methods inherited from class com.xmlmind.xmledit.nodepath.NodePath

addNodePathListener, appendAttribute, appendAttributes, fireNodeSelected, getDocument, getDocumentURL, getElementToolTip, getMinimumSize, getNode, getPreferredSize, getReadOnlyColor, getToolTipText, invalidate, isDragEnabled, isFocusable, isOpaque, mouseXToItem, mouseXToNode, notifyListeners, paintComponent, paintItems, paintSeparator, relayout, removeNodePathListener, repaintTag, resetHoverItem, setBackground, setBorder, setFont, setForeground, setNode, setReadOnlyColor, translateMouseClick

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, 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, getAccessibleContext, 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

NodePathTool

public NodePathTool()

Method Detail

setDragEnabled

public void setDragEnabled(boolean enable)

Description copied from class: NodePath

Specifies whether the node path bar has a draggable document icon.

Overrides:

setDragEnabled in class NodePath

See Also:

NodePath.isDragEnabled()

createDocumentIcon

protected Icon createDocumentIcon()

Overrides:

createDocumentIcon in class NodePath

getToolTipText

protected String getToolTipText(Document doc)

Overrides:

getToolTipText in class NodePath

getToolTipText

protected String getToolTipText(Node node)

Overrides:

getToolTipText in class NodePath

layoutItems

protected int layoutItems(NodePath.Item[] items,
                          FontMetrics metrics)

Overrides:

layoutItems in class NodePath

tagWidth

protected int tagWidth(NodePath.Item item,
                       FontMetrics metrics)

Overrides:

tagWidth in class NodePath

paintTag

protected void paintTag(Graphics g,
                        NodePath.Item item,
                        int x,
                        int y,
                        Color foreground,
                        boolean hover)

Overrides:

paintTag in class NodePath

showDocumentMenu

protected void showDocumentMenu(MouseEvent e)

Overrides:

showDocumentMenu in class NodePath

nodeSelected

public void nodeSelected(NodePathEvent e)

Description copied from interface: NodePathListener

Invoked by a NodePath when user selects a node displayed in the path.

Specified by:

nodeSelected in interface NodePathListener

setHelpId

public void setHelpId(String helpId)

Description copied from interface: AppTool

Specifies the online help ID of this component.

This ID is almost always obtained from the declaration of this AppTool found in the .xxe_gui GUI specification file of the App.

Specified by:

setHelpId in interface AppTool

getHelpId

public String getHelpId()

Description copied from interface: AppTool

Returns the online help ID of this component.

Specified by:

getHelpId in interface AppTool

initApp

public void initApp(App app,
                    String id)

Description copied from interface: AppPart

Specifies the App containing this part and the unique ID of this part within the App. Invoked when the component is attached to the App.

Specified by:

initApp in interface AppPart

See Also:

AppPart.getApp(), AppPart.getId(), App.getPart(java.lang.String)

getApp

public App getApp()

Description copied from interface: AppPart

Returns the App containing this part.

Specified by:

getApp in interface AppPart

getId

public String getId()

Description copied from interface: AppPart

Returns the ID this part within the App.

Specified by:

getId in interface AppPart

See Also:

App.getPart(java.lang.String)

applyPreferences

public void applyPreferences()

Description copied from interface: AppPart

If this part supports user preferences, this part should update its state after reading its settings from the object returned by AppBase.getPreferences().

Specified by:

applyPreferences in interface AppPart

See Also:

Preferences

flushPreferences

public void flushPreferences()

Description copied from interface: AppPart

If this part supports user preferences, this part should store its current settings in the object returned by AppBase.getPreferences().

Specified by:

flushPreferences in interface AppPart

See Also:

Preferences

activeEditorChanged

public void activeEditorChanged()

Description copied from interface: AppPart

Invoked after the active editor has changed or when there is no active editor at all (generally because all documents have been closed).

Specified by:

activeEditorChanged in interface AppPart

See Also:

App.getActiveEditor()

editingContextChanged

public void editingContextChanged()

Description copied from interface: AppPart

Invoked when the editing context (text node containing caret, node selection, etc) changes in active editor.

This method is never invoked if AppPart.isEditingContextSensitive() returned false when the App has registered this part (just before invoking AppPart.initApp(com.xmlmind.xmleditapp.desktop.App, java.lang.String)).

Specified by:

editingContextChanged in interface AppPart

See Also:

AppPart.isEditingContextSensitive(), App.getLastContextChangeReason(), App.getActiveEditor()

isEditingContextSensitive

public boolean isEditingContextSensitive()

Description copied from interface: AppPart

This method must return true if this part is intrinsically context sensitive and it must return false if this part is intrinsically not context sensitive.

This method is invoked once: when the App registers this part (just before invoking AppPart.initApp(com.xmlmind.xmleditapp.desktop.App, java.lang.String)). Therefore, it is useless to sometimes return true and other times to return false.

Specified by:

isEditingContextSensitive in interface AppPart

See Also:

AppPart.editingContextChanged()

namespacePrefixesChanged

public void namespacePrefixesChanged()

Description copied from interface: AppPart

Invoked after the namespace/prefix map has been modified for the active document.

Specified by:

namespacePrefixesChanged in interface AppPart

See Also:

App.getActiveOpenedDocument()

validityStateChanged

public void validityStateChanged()

Description copied from interface: AppPart

Invoked after active document has been checked for validity.

Specified by:

validityStateChanged in interface AppPart

See Also:

App.getActiveOpenedDocument(), OpenedDocument.getDiagnostics(), OpenedDocument.getDiagnosticSeverity()

saveStateChanged

public void saveStateChanged()

Description copied from interface: AppPart

Invoked after active document has been saved or, on the contrary, when its has been modified and thus needs to be saved.

Specified by:

saveStateChanged in interface AppPart

See Also:

App.getActiveOpenedDocument(), OpenedDocument.isSaveNeeded()

undoStateChanged

public void undoStateChanged()

Description copied from interface: AppPart

Invoked after it becomes possible to undo or redo a command in active document or, on the contrary, when it becomes impossible to undo or redo a command.

Specified by:

undoStateChanged in interface AppPart

See Also:

App.getActiveOpenedDocument()

destroyApp

public void destroyApp()

Description copied from interface: AppPart

Invoked when the component is detached from the App. Allows the component to perform some cleanup.

Specified by:

destroyApp in interface AppPart