| Method Summary |
|
| public void | addDocument(ItemT doc)
Adds an IDocuemnt to this navigator. |
| public void | addDocument(ItemT doc, String path)
Adds an INavigatorItem into this navigator in a position relative to a given path. |
| public void | addFocusListener(FocusListener e)
Add FocusListener to navigator. |
| public void | addNavigationListener(INavigationListener<? super ItemT> listener)
Adds an INavigationListener to this navigator. |
| public void | addTopLevelGroup(String name, INavigatorItemFilter<? super ItemT> f)
Adds the top level group with the specified name and filter. |
| public Container | asContainer()
|
| public void | clear()
Removes all INavigatorItems from this IDocumentNavigator. |
| public boolean | contains(ItemT doc)
Tests to see if a given document is contained in this navigator.
Parameters:
doc - the document to test for containment. |
| public ReturnType | execute(IDocumentNavigatorAlgo<ItemT, InType, ReturnType> algo, InType input)
Visitor pattern hook method. |
| public ItemT | getCurrent()
Returns the currently selected navigator item, or null if no navigator item is selected. |
| public int | getDocumentCount()
|
| public int | getDocumentSelectedCount()
the number of documents selected. |
| public Enumeration<ItemT> | getDocuments()
Returns all the IDocuments in the collection in enumeration order. |
| public Enumeration<ItemT> | getDocumentsInBin(String binName)
Returns all the IDocuments contained in the specified bin. |
| public ItemT | getFirst()
|
| public FocusListener[] | getFocusListeners()
Gets the FocustListeners. |
| public int | getGroupSelectedCount()
the number of groups selected. |
| public ItemT | getLast()
|
| public Object | getModelLock()
Returns the model lock for this navigator. |
| public java.util.Set<String> | getNamesOfSelectedTopLevelGroup()
Returns the names of the top level groups that the selected items descend from. |
| public Collection<INavigationListener<? super ItemT>> | getNavigatorListeners()
Returns a collection of all listeners registered with this navigator. |
| public ItemT | getNext(ItemT doc)
The following five operations impose a natural ordering on the documents in the navigator.
For lists, it is order of insertion. |
| public ItemT | getPrevious(ItemT doc)
|
| public java.util.List<ItemT> | getSelectedDocuments()
the documents currently selected. |
| public java.util.List<File> | getSelectedFolders()
the folders currently selected. |
| public int | getSelectionCount()
the number of selected items. |
| public boolean | isDocumentSelected()
true if at least one document is selected. |
| public boolean | isEmpty()
Returns whether this IDocumentNavigator contains any INavigatorItems. |
| public boolean | isGroupSelected()
true if at least one group of INavigatorItems is selected. |
| public boolean | isNextChangeModelInitiated()
whether the next selection change is model-initiated (true) or user-initiated (false). |
| public boolean | isRootSelected()
Returns true if the root is selected. |
| public boolean | isSelectedAt(int x, int y)
Returns true if the item at the x,y coordinate of the navigator pane is currently selected. |
| public boolean | isSelectedInGroup(ItemT i)
true if the INavigatorItem is in a selected group, ifat least one group is selected. |
| public boolean | isTopLevelGroupSelected()
Returns true if at least one top level group is selected, false otherwise. |
| public void | refreshDocument(ItemT doc, String path)
Resets a given INavigatorItem in the tree. |
| public ItemT | removeDocument(ItemT doc)
Removes a given INavigatorItem from this navigator. |
| public void | removeFocusListener(FocusListener e)
Remove FocusListener from navigator. |
| public void | removeNavigationListener(INavigationListener<? super ItemT> listener)
Removes the given listener from observing this navigator. |
| public void | repaint()
The standard swing repaint() method. |
| public void | requestSelectionUpdate(ItemT i)
Switches the selection to the given INavigatorItem if the current selection is not already on an
INavigatorItem. |
| public boolean | selectDocumentAt(int x, int y)
Selects the document at the x,y coordinates of the navigator pane and makes it the active document. |
| public void | setActiveDoc(ItemT doc)
Sets the active document as specified. |
| public void | setNextChangeModelInitiated(boolean b)
Marks the next selection change as model-initiated (true) or user-initiated (false; default). |