Documentation

Cinch Documentation

Definitions

There are several interpretations of Model-View-Controller so we'll provide ours up front:

Model

A Model is a class that implements BindableModel and provides getters and setters for JavaBeans-style named properties. A Model does not directly have knowledge of any Views or Controllers. Generally the code in the Model is not very complicated and only serves to keep the model data in a valid state. It indirectly may refer to these through a list of listeners.

View

A View is any class that holds a reference to a Model and depicts it in some way, shape, or form. Within the scope of this framework there is no need for a View to be tied to Swing or any other UI framework. A View has direct knowledge (i.e., a reference) to some number of Models and Controllers.

Controller

A Controller is a class that incorporates "business logic" or any large block of code that processes the data in a Model. The logic in the Controller can be arbitrarily complex. Typically the controller will take some number of Models as input, process some logic, and set values on the various models. Controllers only have direct knowledge (i.e., a reference) to Models or Controllers.

Next Steps

• Tutorial & Examples - a tour through a set of runnable examples that explain using the framework.
• More Examples - a list of examples included in the Cinch source tree.
• Annotations Reference - quick reference and links into the Javadoc for the Cinch framework.

Technical Guide

Compile Time Types versus Run Time Types

TODO

Performance

TODO

Costs

TODO

Threading

TODO

Future Work

SWT?