cvsuser 02/03/28 07:22:01
Modified: P5EEx/Blue/P5EEx/Blue Widget.pm
Log:
updated somke doc
Revision Changes Path
1.11 +42 -9 p5ee/P5EEx/Blue/P5EEx/Blue/Widget.pm
Index: Widget.pm
===================================================================
RCS file: /cvs/public/p5ee/P5EEx/Blue/P5EEx/Blue/Widget.pm,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -w -r1.10 -r1.11
--- Widget.pm 12 Mar 2002 17:00:01 -0000 1.10
+++ Widget.pm 28 Mar 2002 15:22:01 -0000 1.11
@@ -1,6 +1,6 @@
#############################################################################
-## $Id: Widget.pm,v 1.10 2002/03/12 17:00:01 spadkins Exp $
+## $Id: Widget.pm,v 1.11 2002/03/28 15:22:01 spadkins Exp $
#############################################################################
package P5EEx::Blue::Widget;
@@ -47,24 +47,57 @@
=item * Class: P5EEx::Blue::Widget
=item * Class: P5EEx::Blue::Widget::Entity
- - for local EJB-like widgets
+ - entity widgets are business objects (like EJB)
-=item * Class: P5EEx::Blue::Widget::SOAP
- - for remote EJB-like widgets
+=item * Class: P5EEx::Blue::Widget::Entity::Repository
+ - a local entity widget stored in a Repository
+
+=item * Class: P5EEx::Blue::Widget::Entity::SOAP
+ - a remote entity widget, accessed via SOAP
=item * Class: P5EEx::Blue::Widget::HTML
- - for HTML widgets
+ - user interface widgets displayed on a browser in HTML
=item * Class: P5EEx::Blue::Widget::Curses
- - for Curses widgets
+ - user interface widgets displayed on a terminal using Curses
=item * Class: P5EEx::Blue::Widget::Gtk
- - for Gtk widgets
+ - user interface widgets displayed in X11 using Gtk
+
+=item * Class: P5EEx::Blue::Widget::Tk
+ - user interface widgets displayed in X11 using Tk
-=item * Class: P5EEx::Blue::Widget::Wxperl
- - for Wxperl widgets
+=item * Class: P5EEx::Blue::Widget::WxPerl
+ - user interface widgets displayed on Windows using wxPerl
=back
+
+A Widget is an object that can be manipulated
+without having to worry about its lifecycle (i.e. persistence,
+saving and restoring state, etc.) or its location (local or remote).
+
+A Widget is a P5EE Service, and it inherits all of the features of
+P5EE Services.
+
+ * Each Widget may be identified by a unique (text) name
+ * Entity Widget are kept separate from UI Widgets by naming convention
+ * Widgets are accessed by requesting them by name from the Context
+ * Widgets have attributes (which may be references to complex data structures)
+ * Attributes of Widgets are accessed via get()/set() methods
+ * get($attribute) is equivalent to $self->{$attribute} (but not set())
+ * Attributes may be defaulted in the code that first accesses the Widget,
+ configured in the Config file, or overridden at runtime for the
+ duration of the Session
+
+A user interface Widget also has a display() method to display
+the Widget on the user agent.
+The values that are set are stored in the user's Session, so
+every user Session has a unique copy of every user interface
+Widget.
+
+An entity Widget is shared between all user Sessions.
+It maintains its state in a shared data store such as a
+Repository.
=cut
