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

java.lang.Object
  extended byuk.ac.kcl.cch.jb.pliny.views.utils.ResourceExplorerItemBase
      extended byuk.ac.kcl.cch.jb.pliny.views.utils.ResourceExplorerSurrogateListItemBase
All Implemented Interfaces:
EventListener, IResourceExplorerItem, PropertyChangeListener
Direct Known Subclasses:
ResourceExplorerContainsList, ResourceExplorerDisplayedInList

public abstract class ResourceExplorerSurrogateListItemBase
extends ResourceExplorerItemBase

an abstract class that provides base functionality for those Resource Explorer model items that manage lists of Pliny Resources.

Author:
John Bradley

Field Summary
protected  IResourceExplorerItem parent
           
 
Fields inherited from class uk.ac.kcl.cch.jb.pliny.views.utils.ResourceExplorerItemBase
myChildren, myView
 
Constructor Summary
ResourceExplorerSurrogateListItemBase(IResourceTreeView myView, IResourceExplorerItem parent, Resource theObject, String myName, String trackingProperty, List surrogateList)
           
 
Method Summary
 boolean canModify()
          return true if this item's name can be edited within the Resource Explorer.
 Iterator createListIterator()
           
 org.eclipse.swt.graphics.Image getIcon()
          returns the Image to be used as the Icon displayed beside the item in the Resource Explorer tree.
 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.
abstract  IResourceExplorerItem makeChild(Object item)
           
 void setText(String name)
          changes text to be displayed as the label to the given text.
 
Methods inherited from class uk.ac.kcl.cch.jb.pliny.views.utils.ResourceExplorerItemBase
dispose, getAssociatedObject, getBaseObject, getChildren, getChildrenList, getMyView, getNumberChildren, getPageNumber, hasChildren, propertyChange, setBaseObject, updateMyChildren
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

parent

protected IResourceExplorerItem parent
Constructor Detail

ResourceExplorerSurrogateListItemBase

public ResourceExplorerSurrogateListItemBase(IResourceTreeView myView,
                                             IResourceExplorerItem parent,
                                             Resource theObject,
                                             String myName,
                                             String trackingProperty,
                                             List surrogateList)
Method Detail

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
Specified by:
getText in class ResourceExplorerItemBase

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
Specified by:
canModify in class ResourceExplorerItemBase

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
Specified by:
setText in class ResourceExplorerItemBase

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
Specified by:
getIcon in class ResourceExplorerItemBase

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
Specified by:
getParent in class ResourceExplorerItemBase

createListIterator

public Iterator createListIterator()
Specified by:
createListIterator in class ResourceExplorerItemBase

makeChild

public abstract IResourceExplorerItem makeChild(Object item)
Specified by:
makeChild in class ResourceExplorerItemBase