Author: jmorliaguet
Date: Sat Feb 25 20:42:07 2006
New Revision: 2464
Modified:
cpsskins/branches/jmo-perspectives/ui/framework/doc/index.txt
Log:
- doc update
Modified: cpsskins/branches/jmo-perspectives/ui/framework/doc/index.txt
==============================================================================
--- cpsskins/branches/jmo-perspectives/ui/framework/doc/index.txt
(original)
+++ cpsskins/branches/jmo-perspectives/ui/framework/doc/index.txt Sat Feb
25 20:42:07 2006
@@ -114,24 +114,186 @@
Controller classes have access to the model and to the view.
-Available widgets
-=================
+Definitions
+===========
-Panels
-------
+The Model, View and Controller elements are registered in the HTML page using
+the HTML *ins* tag::
-...
+ <ins class="model">
+ ...
+ </ins>
-Contextual menus
+ <ins class="view">
+ ...
+ </ins>
+
+ <ins class="controller">
+ ...
+ </ins>
+
+
+The definitions are written in the JSON format, either inline ::
+
+ <ins class="view">
+ {"widget": {
+ "type": "menu"
+ }}
+ </ins>
+
+or they can be inserted from a remote location::
+
+ <ins class="view" cite="/def/viewDefinition.html">
+ </ins>
+
+
+Note: the <ins> tag is part of the HTML specification.
+Semantically it denotes an editorial insertion of content.
+
+Model
+=====
+
+The model contains some initial data (used to define a schema) and a storage.
+
+* id: the model's id
+
+* data: the model's initial data and schema definition
+
+* storage: the data storage
+
+ There are different types of storages:
+
+ - RAM (the data is stored in the browser's RAM)
+
+ - local (the data is stored in a cookie)
+
+ - remote (the data is stored on a remote server)
+
+ - unified (a combination of several data storages to provide unified
+ data access)
+
+Storage adapters
----------------
-...
+* type: the storage type
+
+ - ram (used by default)
-Tooltip
+ - local
+
+ - remote
+
+ - accessors: the storage accessors ("get", "set")
+
+ - refresh: the refresh rate
+
+ - access: the type of access
+
+ - sequence type: queue, stack
+
+ - sequence signature
+
+
+
+View
+====
+
+* widget type
+
+* template: a CTAL template (optional)
+
+* model: the model's id (optional)
+
+* show_effect: the effect to applied when the widget is shown (optional)
+
+* render_effect: the effect to applied when the widget is rendered (optional)
+
+* hide_effect: the effect to applied when the widget is hidden (optional)
+
+* controllers: a list of controllers that apply to the view (optional)
+
+* perspectives: the perspectives in which the view is visible (optional)
+
+Widgets
-------
-...
+* Panel
+
+
+* Contextual menus
+
+ - items
+
+ - type (item, submenu, separator)
+
+ - label
+
+ - icon
+
+ - action
+
+ - confirm
+
+
+* Contextual actions
+
+ (same options as the Contextual menu)
+
+
+* Tooltip
+
+
+* Custom
+
+ a custom widget, requires a 'template'.
+
+Effects
+-------
+
+* transition type
+
+ - fadein
+
+ - fadeout
+
+ - blinddown
+
+ - blindup
+
+
+* effect options:
+
+ - delay
+
+ - duration
+
+
+Controllers
+===========
+
+* form controller
+
+
+* behaviour controller
+
+ - rules
+
+
+* focus observer
+
+
+* command controller
+
+ - handlers
+
+
+* drag-and-drop
+
+ - action
+
+ - droppable
+ - draggable
.. Emacs
--
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins
