JAC project
AOPSYS
CEDRIC & LIP6 labs

Package org.objectweb.jac.aspects.gui

Provides a simple and generic GUI (Graphical User Interface) aspect.

See:
          Description

Interface Summary
AbstractCollectionItemView Interface for the component used to display elements of a collection, with "prev" and "next" buttons to go to the previous or next element of the collection easily.
BehaviorGuiConf This configuration interface of the Gui aspect defines all the methods that handle some behavioral configurations of the widgets.
ClassAppearenceGuiConf This configuration interface of the Gui aspect defines all the methods that handle the appearence of the classes in the GUI.
CollectionModel An abstract representation of a collection.
CollectionUpdate This interface defines callback methods used to notify that a collection was updated (that is, an object was added to it or removed from it).
CollectionView This interface implements common methods for view of collections.
CompositeView This view is a composite view (i.e.
CustomizedDisplay Defines a display which contains customized GUI windows.
CustomizedView  
DialogView A dialog box interface.
EditorContainer A container for editor components.
ExtendedTableModel Data model for tables.
FieldAppearenceGuiConf This configuration interface of the Gui aspect defines all the methods that handle the appearence of the fields in objects views.
FieldEditor This interface is implemented to define different value editors depending on the type of the value to edit.
FieldUpdate This interface defines a callback method used to notify that a field was updated.
FieldView This interface represents viewers for field items.
GuiConf This is the configuration interface of the Gui aspect.
MenuView The GUI target independent menu.
MethodAppearenceGuiConf This configuration interface of the Gui aspect defines all the methods that handle the appearence of the methods in views.
MethodUpdate This interface defines a callback method used to notify that the value returned by a method has changed.
MethodView The GUI target independent method view.
Model The root interface for abstract data models.
ObjectChooserModel Data model for ObjectChooser.
ObjectUpdate This interface defines a callback method used to notify that an object was updated.
PanelView  
ReferenceEditor  
StatusView The GUI target independant status bar view.
TableCellViewer The GUI target independant cell viewer for a table.
TabsView  
TreeListener  
TreeView The GUI terget independant tree view.
View  
ViewIdentity This interface allows views comparison.
 

Class Summary
AbstractNode This tree node caches the text and the icon to display so that calls to the wrappee are not needed every time tree is painted
Actions This class is a container of commonly used GUI actions static methods.
AppletView This class allows the programmer to insert specialized object views defined as applets.
Border This class represents borders in GUI.
Callback This class holds a method and its parameters that can be passed to a peer object as a callback.
ClassChooser Used to choose a class to instantiate
CollectionItemView Defines a generic member view (is embedded, ...)
CollectionPosition A class that represents a position in a given collection.
CollectionWrapper This class is just a wrappable delegator used to display collections.
ComboBoxModel This is an abstract representation of a combo box.
Constants  
Currency Holds information about a currency: its name, display precision and change rate.
CustomizedGUI This interface allows the programmer to create simple customized GUIs.
DisplayContext This class implements a display context.
EventHandler This handler manages events received from GUIs (web and swing for now).
FieldItemView  
GenericFactory This class implements static methods that generically create GUI items.
GuiAC This aspect component implements a very simple GUI that allows the user to browse the named object of the system and call methods on them.
HandlerResult A handler that is assigned to a selection event (in order to change its result in most cases).
InputSequence This class allows a GUI programmer to create input sequences to ask the user to fill a set of parameters when invoking a method.
InputWrapper This wrapper asks the user the parameters of the invoked method if the attribute Gui.askForParameters is defined in the current collaboration.
InvokeThread This class allows the programmer to invoke a given method in a new thread.
LessAbstractListModel Base class for ListModel and ComboBoxModel.
ListModel A generic list data model.
MemberItemView Defines a generic member view (is embedded, ...)
Menu  
MethodItemView Defines a generic member view (is embedded, ...)
ObjectNode This class represents a tree node for an object.
ObjectView Defines a generic object view (attributes order, tabs, ...)
PanelContent Represents the content of a panel.
RelationNode This tree node represents a relation.
ResourceManager A class with static methods to get GUI resources as icons.
RootNode  
SortCriteria  
TableModel The data model for tables.
TableSorter A sorter for TableModels.
Target Defines all the parameters needed to build a view in a customized GUI.
Template This is unused class to create printable templates.
TemplateReader This is unused class to create printable templates.
Transfer This class defines JAC objects data tranfer utilities.
TreeModel A data model for trees.
Utils A class with static methods to factorize code between display types (swing and web)
ViewControlWrapper This wrapper updates the views of a given object when its state changes, that is to say when a write method is called on the wrappee.
ViewFactory This is a generic view factory.
WrappableMap This class is a mere wrapper which delegates all methods to a real Map.
 

Exception Summary
InputCanceledException This exception is thrown by the input wrapper when an input process is canceled by the user.
TimeoutException  
ViewFactory.UnhandledViewTypeException Thrown to indicate that a ViewFactory is unable to build a view of the given type because no constructor is associated to this type of view.
 

Package org.objectweb.jac.aspects.gui Description

Provides a simple and generic GUI (Graphical User Interface) aspect.

This aspect is based on a MVC (Model-View-Controller) pattern. The GUI aspect component wrapps all the objects of the application that need to be displayed with a view wrapper that plays the controller role. The view is generic and is implemented by the View class. It simply displays the objects fields values and add some buttons for the commands that correspond to the class methods.

It supports arrays, collections, and maps displaying.

The configuration file lets you specify how objects should be displayed. You can control which fields are shown and in which order for instance. You can also specify the name of methods parameters.

Two guis are available : a swing gui, based on Java's swing components, and a web gui which generates HTML pages. They both use the configuration of the gui aspect, which means that you do not have to write two configuration files, however due to constraint of each implementation, some gui may not use all settings of the gui aspect. For instance, the setRender configuration method only has an effect in the swing gui.

If you want to create a customized GUI for a given application, you must implement the org.objectweb.jac.core.Display interface and use the setDisplay configuration method to launch it.

Configuration methods for the GUI aspect

Related Documentation

For overviews, sources, tutorials, examples, guides, and tool documentation, please see:


Contact JAC development team:
Renaud Pawlak
Lionel Seinturier
Laurent Martelli