uk.ac.kcl.cch.jb.pliny.views.utils
Class NoteSearchRoot

java.lang.Object
  uk.ac.kcl.cch.jb.pliny.views.utils.NoteSearchRoot

All Implemented Interfaces:

IResourceExplorerItem

public class NoteSearchRoot

extends Object

implements IResourceExplorerItem

used by the NoteSearchView as the root of the model for its display, and contains items that were selected by the query. Since the NoteSearchView is like the Resource Explorer in some ways and reuses some of this code, this root is a IResourceExplorerItem.

Author:

John Bradley

Field Summary

Vector	noteList
Vector	rsltList

Constructor Summary

NoteSearchRoot(Vector noteList, IResourceTreeView myViewer)
the constructor for this item.

Method Summary

boolean	canModify() return true if this item's name can be edited within the Resource Explorer.
void	dispose() performs data cleanup.
Object	getAssociatedObject() returns the Pliny model object associated with this item.
List	getChildren() returns a list of IResourceExplorerItem items that are children of this item.
org.eclipse.swt.graphics.Image	getIcon() returns the Image to be used as the Icon displayed beside the item in the Resource Explorer tree.
int	getNumberChildren() returns number of children owned by this item.
int	getPageNumber() return the page number data associated with the Pliny model object associated wtih this item.
IResourceExplorerItem	getParent() returns the parent item of this item in the Resource Explorer display tree.
String	getText() returns text to be used as the textual label for the tree item display.
boolean	hasChildren() returns true if this item has children items.
void	setText(String name) changes text to be displayed as the label to the given text.

Methods inherited from class java.lang.Object

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

Field Detail

noteList

public Vector noteList

rsltList

public Vector rsltList

Constructor Detail

NoteSearchRoot

public NoteSearchRoot(Vector noteList,
                      IResourceTreeView myViewer)

the constructor for this item.

Parameters:

noteList - a Vector of NoteLucenes that were selected by the search query. These will be this object's children.

myViewer - the owning ViewPart.

Method Detail

dispose

public void dispose()

Description copied from interface: IResourceExplorerItem

performs data cleanup. This will be called then the item is no longer needed.

Specified by:

dispose in interface IResourceExplorerItem

getText

public String getText()

Description copied from interface: IResourceExplorerItem

returns text to be used as the textual label for the tree item display.

Specified by:

getText in interface IResourceExplorerItem

Returns:

String text to be displayed.

setText

public void setText(String name)

Description copied from interface: IResourceExplorerItem

changes text to be displayed as the label to the given text. This should result in changes in the backing Pliny model as well.

Specified by:

setText in interface IResourceExplorerItem

Parameters:

name - text to be used as the name of this item.

canModify

public boolean canModify()

Description copied from interface: IResourceExplorerItem

return true if this item's name can be edited within the Resource Explorer.

Specified by:

canModify in interface IResourceExplorerItem

Returns:

true if editable.

getAssociatedObject

public Object getAssociatedObject()

Description copied from interface: IResourceExplorerItem

returns the Pliny model object associated with this item. Return null if there is not Pliny model object.

Specified by:

getAssociatedObject in interface IResourceExplorerItem

Returns:

Object representing associated Pliny model object.

getPageNumber

public int getPageNumber()

Description copied from interface: IResourceExplorerItem

return the page number data associated with the Pliny model object associated wtih this item. Return 0 if there is no associated page number.

Specified by:

getPageNumber in interface IResourceExplorerItem

Returns:

page number associated with the item.

getIcon

public org.eclipse.swt.graphics.Image getIcon()

Description copied from interface: IResourceExplorerItem

returns the Image to be used as the Icon displayed beside the item in the Resource Explorer tree. The image must be disposed of by this object -- it will not be disposed by the caller.

Specified by:

getIcon in interface IResourceExplorerItem

Returns:

SWT Image to act as the icon.

getParent

public IResourceExplorerItem getParent()

Description copied from interface: IResourceExplorerItem

returns the parent item of this item in the Resource Explorer display tree.

Specified by:

getParent in interface IResourceExplorerItem

hasChildren

public boolean hasChildren()

Description copied from interface: IResourceExplorerItem

returns true if this item has children items.

Specified by:

hasChildren in interface IResourceExplorerItem

getNumberChildren

public int getNumberChildren()

Description copied from interface: IResourceExplorerItem

returns number of children owned by this item.

Specified by:

getNumberChildren in interface IResourceExplorerItem

getChildren

public List getChildren()

Description copied from interface: IResourceExplorerItem

returns a list of IResourceExplorerItem items that are children of this item.

Specified by:

getChildren in interface IResourceExplorerItem