Note: restructuring of this Plugin code into a different
package structure is needed and might well be taken at a future time.
The following packages are contained within this plugin:
- uk.ac.kcl.cch.jb.pliny: provides code for
the the basic Plugin class, for the Pliny perspective and a few other widely
useful functions -- see more details in its own section.
- uk.ac.kcl.cch.jb.pliny.actions: system
responses to user interactions in Eclipse are packaged up as Actions.
Actions classes sit behind menu items, behind icons in a toolbar, and
potentially behind other interactions as well. The Action classes that are
useful both within the Views and Editors provided by this plugin, and generally
to other Pliny-aware plugins are provided here.
- uk.ac.kcl.cch.jb.pliny.browser: The
classes associated with the integrated Pliny web browser are here.
- uk.ac.kcl.cch.jb.pliny.commands: The
Eclipse component GEF provides a mechanism called Commands that, when
used with GEF's CommandStack provide support for undoing and redoing of
user-requested changes. Any appropriate process which should be undoable is
packaged as a Command and invoked through a GEF CommandStack. Note that
although Command and CommandStack are GEF classes they are independent of other
parts of GEF, and are in fact used in Pliny components that don't use GEF as
well as those that do.
The classes associated with the Pliny Containment View are here, and in the
- uk.ac.kcl.cch.jb.pliny.controls: Contains
a special Control item class defining a slider for scaleable displays, and
- uk.ac.kcl.cch.jb.pliny.dnd: Provides a
range of classes and interfaces to support Pliny's use of drag-and-drop and
- uk.ac.kcl.cch.jb.pliny.editors: Provides
a range of classes and interfaces to support Pliny-aware editors, and code to
specific to Pliny's Note Editor.
Provides two things called "Factories":
- uk.ac.kcl.cch.jb.pliny.figures: Provides
draw2d Figure classes for GEF implementation of the reference/annotation area,
and support classes for them.
- uk.ac.kcl.cch.jb.pliny.lucene: Provides a
class to support Pliny's use of Lucene to provide textual note searching for
the Note Search View.
- uk.ac.kcl.cch.jb.pliny.model: Behind
Pliny's support for annotations, notes, containment, etc, is a model of this
data. The classes that define this model are here. There is a brief
introduction to the classes in the section the
Pliny Data Model.
- uk.ac.kcl.cch.jb.pliny.parts: classes
here provide the set of GEF Control objects (called by GEF edit parts) that are
involved in displaying and supporting user interaction with things displayed in
a Pliny annotation/reference area.
- uk.ac.kcl.cch.jb.pliny.policies: classes
here provide GEF edit policies that define what kind of user interaction is
permitted, and how it is implemented for Pliny annotation/reference areas.
- uk.ac.kcl.cch.jb.pliny.views: classes
here define the Annotation View, the Note Search View, the Resource Explorer
View and the Type Manager View.
classes represent classes that support the Pliny views, including code to
support exporting and importing from Pliny, wizards used by these views, and
the Resource Explorer data model.
Center for Computing in the Humanities
King's College London