org.apache.pivot.wtk
Class TreeView.NodeEditor.NodeEditorListenerList

java.lang.Object
  extended by org.apache.pivot.util.ListenerList<TreeView.NodeEditorListener>
      extended by org.apache.pivot.wtk.TreeView.NodeEditor.NodeEditorListenerList
All Implemented Interfaces:
Iterable<TreeView.NodeEditorListener>, TreeView.NodeEditorListener
Enclosing interface:
TreeView.NodeEditor

public static class TreeView.NodeEditor.NodeEditorListenerList
extends ListenerList<TreeView.NodeEditorListener>
implements TreeView.NodeEditorListener

Node editor listener list.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.TreeView.NodeEditorListener
TreeView.NodeEditorListener.Adapter
 
Constructor Summary
TreeView.NodeEditor.NodeEditorListenerList()
           
 
Method Summary
 void changesSaved(TreeView.NodeEditor nodeEditor, TreeView treeView, Sequence.Tree.Path path)
          Called when changes have been saved.
 void editCancelled(TreeView.NodeEditor nodeEditor, TreeView treeView, Sequence.Tree.Path path)
          Called when an edit has been cancelled.
 void editNodeVetoed(TreeView.NodeEditor nodeEditor, Vote reason)
          Called when a node edit was vetoed by a listener in the preview event.
 void nodeEditing(TreeView.NodeEditor nodeEditor, TreeView treeView, Sequence.Tree.Path path)
          Called when editing has begun.
 Vote previewEditNode(TreeView.NodeEditor nodeEditor, TreeView treeView, Sequence.Tree.Path path)
          Called to preview a node edit.
 Vote previewSaveChanges(TreeView.NodeEditor nodeEditor, TreeView treeView, Sequence.Tree.Path path, Object changes)
          Called to preview a save.
 void saveChangesVetoed(TreeView.NodeEditor nodeEditor, Vote reason)
          Called when a save was vetoed by a listener in the preview event.
 
Methods inherited from class org.apache.pivot.util.ListenerList
add, iterator, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeView.NodeEditor.NodeEditorListenerList

public TreeView.NodeEditor.NodeEditorListenerList()
Method Detail

previewEditNode

public Vote previewEditNode(TreeView.NodeEditor nodeEditor,
                            TreeView treeView,
                            Sequence.Tree.Path path)
Description copied from interface: TreeView.NodeEditorListener
Called to preview a node edit.

Specified by:
previewEditNode in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
treeView - The tree view containing the node to be edited.
path - The path to the node to edit.
Returns:
A vote on whether editing should be allowed to begin.

editNodeVetoed

public void editNodeVetoed(TreeView.NodeEditor nodeEditor,
                           Vote reason)
Description copied from interface: TreeView.NodeEditorListener
Called when a node edit was vetoed by a listener in the preview event.

Specified by:
editNodeVetoed in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
reason - The reason for the veto

nodeEditing

public void nodeEditing(TreeView.NodeEditor nodeEditor,
                        TreeView treeView,
                        Sequence.Tree.Path path)
Description copied from interface: TreeView.NodeEditorListener
Called when editing has begun.

Specified by:
nodeEditing in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
treeView - The tree view containing the node being edited.
path - The path to the node being edited.

previewSaveChanges

public Vote previewSaveChanges(TreeView.NodeEditor nodeEditor,
                               TreeView treeView,
                               Sequence.Tree.Path path,
                               Object changes)
Description copied from interface: TreeView.NodeEditorListener
Called to preview a save.

Specified by:
previewSaveChanges in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
treeView - The tree view containing the node being edited.
path - The path to the node being edited.
changes - The proposed changes. The type of this object will depend on the editor implementation.
Returns:
A vote on whether the changes should be allowed to be saved.

saveChangesVetoed

public void saveChangesVetoed(TreeView.NodeEditor nodeEditor,
                              Vote reason)
Description copied from interface: TreeView.NodeEditorListener
Called when a save was vetoed by a listener in the preview event.

Specified by:
saveChangesVetoed in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
reason - The reason for the veto

changesSaved

public void changesSaved(TreeView.NodeEditor nodeEditor,
                         TreeView treeView,
                         Sequence.Tree.Path path)
Description copied from interface: TreeView.NodeEditorListener
Called when changes have been saved.

Specified by:
changesSaved in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
treeView - The tree view containing the node that was edited.
path - The path to the node that was edited.

editCancelled

public void editCancelled(TreeView.NodeEditor nodeEditor,
                          TreeView treeView,
                          Sequence.Tree.Path path)
Description copied from interface: TreeView.NodeEditorListener
Called when an edit has been cancelled.

Specified by:
editCancelled in interface TreeView.NodeEditorListener
Parameters:
nodeEditor - The node editor
treeView - The tree view containing the node that was being edited.
path - The path to the node that was being edited.