Package project35.desktopDeployment

The project35.desktopDeployment package describes classes that are used to make the desktop version of the data entry tool.

See:
Description

Interface Summary

CustomisedFieldView	an interface that developers can use to develop their own customised field views.
ListTypeListener	Interface used to monitor the state of the child type combination box that appears in list fields.
ListTypeManager	Interface for classes that manage the currently selected type of child subrecord for a list.
NavigationView	This is an interface developed to make Project35 better able to substitute views of the record tree.
PluginSelectorComponent	an interface used to give end-users access to a display of available plugins.
TextComponentSupplier	an interface used to characterise the ability for field views to supply an editable text component.

Class Summary

CombinationFieldView	Renders a GroupFieldModel model component as a combination field.
DataFieldView	Describes basic aspects of a field view including context sensitive help and whether field should indicate a required or optional model component.
DateFieldView	Visualises a date field.
DateTimeFieldView	Visualises a dateTime field.
DocumentDescriptionDialog	this dialog helps capture some basic meta data about the document.
EditFieldView	The view that renders edit fields.
EditMenu	the Edit menu shown in the menu bar of a Project35 Dialog
FileMenu	manages menu items that appear in the "File" menu of a Project35 dialog.
HelpMenu	the "Help" menu that appears in the menu bar of a Project35 Dialog
IDFieldView	Renders XML schema ID data fields.
InsertSymbolsDialog	Copyright (c) 2008 Kevin Garwood for Project35.
InsertSymbolsEventObject	Copyright (c) 2008 Kevin Garwood for Project35.
InsertSymbolsPanel	Copyright (c) 2008 Kevin Garwood for Project35.
ListFieldView	basic class for rendering a list field for forms.
ListValueButtonPanel	manages the actions of "New", "Edit", and "Delete" buttons that appear in a list field display.
ListValueManager	manages the values contained in list fields.
MenuActionListener	Has methods for managing items in menus that appear in the Project35 menu bar.
MTMVListFieldView	Multi type multi value list field view.
MTSVListFieldView	Multiple type single value list field view.
MultiListTypeManager	Handles the part of lists that indicate it can support multiple types of subrecords.
MultiListValueManager	Manages the list part that displays multiple values.
NavigationTree	Does management of tree nodes.
NavigationTreeNode	A tree node that is specialised to view Project35 record nodes The node is capable of indicating the following aspects: indicate it is a search result indicate it is deleted indicate it has an error indicate it has been changed it is selected
NavigationTreePanel	a panel that contains the navigation tree and buttons for shifting the currently selected node up and down.
OptionsMenu	the Options menu that appears in the menu bar of a Project35 Dialog
Project35Alerts	this is the main class that starts the Project35 Alerts Editor.
Project35Application	the main class to launch an instance of the Project35 data entry tool This class is similar in structure to project35.tabletDeployment.TabletProject35Application and project35.configurationTool.Project35ConfigurationTool.
Project35Dialog	The class that produces the main dialog for the Project35 application
Project35Menu	describes the basic features of one of the standard menus that appears in the menu bar of a Project35 dialog.
Project35MenuBar	the menu bar that is displayed in a Project35 Dialog.
Project35MetaDataEditor	this is the main class for the Project35 Meta Data Editor.
Project35Panel	Copyright (c) 2008 Kevin Garwood for Project35.
Project35Service	This class is reasonably stable.
Project35StartupUtility	Copyright (c) 2008 Kevin Garwood for Project35.
RadioFieldView	This class is used to render radio buttons for a GroupFieldModel model construction.
RecordModelTransferable	this class supports copying and pasting record model objects to and from the clip board.
RecordView	this is the class that renders the form for the currently selected record.
RecordViewFactory	produces the field view UI components that are used in classes such as project35.desktopDeployment.RecordView
RecordViewReferencePanel	this is the panel that appears when an end-user has decided to create a list field item that is a reference to something else in the data set.
RecordViewTitle	This class is used to allow the title of the record to be sensitised to context help activities.
SaveTemplateDialog	dialog that lets you save the current record or a subtree.
SchemaInformationDialog	This dialog is invoked from the main window's help menu.
SearchAndReplaceDialog	Copyright (c) 2008 Kevin Garwood for Project35.
SearchAndReplacePanel	Copyright (c) 2008 Kevin Garwood for Project35.
SelectColourFieldView	Copyright (c) 2008 Kevin Garwood for Project35.
ShowDependenciesDialog	Displays records that contain the search string.
SingleListTypeManager	Handles the part of lists that indicate it can support a single type of subrecord.
SingleListValueManager	Manages the list part that displays a single value.
StatusBar	shows the status bar that appears on the bottom of a Project35 dialog.
STMVListFieldView	Single type multiple view list field.
STSVListFieldView	Single type single value list field view.
SymbolGenerator	Copyright (c) 2008 Kevin Garwood for Project35.
SymbolTile	Copyright (c) 2008 Kevin Garwood for Project35.
SymbolTileDisplayPanel	Copyright (c) 2008 Kevin Garwood for Project35.
TextFieldView	Renders text field views for EditFieldModel model components.
TreeNodeRenderer	Renders project35 tree nodes.
TreeSelectionEventManager	This class is used to govern tree selection events.
URIFieldView	Renders URL data fields.
ViewMenu	the View menu that appears in the menu bar of a Project35 Dialog
WindowMenu	the Window menu that appears in the menu bar of a Project35 Dialog.
WindowRegistry	Keeps track of which files are currently open.
Workspace	This is a container class meant to hold all the state information needed to support launching a project35 session with a given model.
WorkspaceFileFinder	class which uses knowledge about how a model folder is laid out to derive properties which are managed in Workspace and ultimately Project35ApplicationContext.
WorkspaceFiles	this is a container class meant to hold all the state information needed to support launching a project35 session with a given model.
WorkspaceProperties	this is a container class meant to hold all the state information needed to support launching a project35 session with a given model.

Package project35.desktopDeployment Description

The project35.desktopDeployment package describes classes that are used to make the desktop version of the data entry tool. It is quite large but its classes can be organised into just a few categories. Classes that can be invoked as applications include Project35Application and Project35Alerts. Project35Service is intended to behave as a component that operates within an environment provided by a client application.

Classes that describe the behaviour of Project35's NavigationTree include:

• NavigationTree
• NavigationTreePanel
• NavigationTreeNode
• NavigationView
• TreeSelectionEventManager
• TreeNodeRenderer

Perhaps the most complicated class in the package is TreeSelectionEventManager, which changes the main form to display the record which is displayed in the NavigationTree. The complexity in the code comes from having to validate the current record before jumping to the next.

NavigationView is a relatively new class which was developed to allow Project35 to treat the NavigationTree in the desk top deployment in a similar way to the project35.tabletDeployment.RecordStack navigation widget used in the Tablet deployment.

Classes for rendering the main form include RecordView and all the form field classes, which are represented by classes ending with "FieldView". Instances of field views are produced by RecordViewFactory.