Revision: 1245
Author: peterdb
Date: 2006-07-27 04:17:39 -0700 (Thu, 27 Jul 2006)
ViewCVS: http://svn.sourceforge.net/spring-rich-c/?rev=1245&view=rev
Log Message:
-----------
initial draft of form documentation: doc for Interceptors
Added Paths:
-----------
trunk/spring-richclient/form/src/site/apt/index.apt
trunk/spring-richclient/form/src/site/apt/interceptors.apt
trunk/spring-richclient/form/src/site/resources/screenshots/
trunk/spring-richclient/form/src/site/resources/screenshots/ColorValidationInterceptor.png
trunk/spring-richclient/form/src/site/resources/screenshots/ComboboxAutocompletionInterceptor.png
trunk/spring-richclient/form/src/site/resources/screenshots/DirtyIndicatorInterceptor.png
trunk/spring-richclient/form/src/site/resources/screenshots/OverlayValidationInterceptor.png
trunk/spring-richclient/form/src/site/resources/screenshots/SelectAllInterceptor.png
trunk/spring-richclient/form/src/site/resources/screenshots/ShowCaptionInStatusBarInterceptor.png
trunk/spring-richclient/form/src/site/resources/screenshots/TextComponentInterceptor.png
Added: trunk/spring-richclient/form/src/site/apt/index.apt
===================================================================
--- trunk/spring-richclient/form/src/site/apt/index.apt
(rev 0)
+++ trunk/spring-richclient/form/src/site/apt/index.apt 2006-07-27 11:17:39 UTC
(rev 1245)
@@ -0,0 +1,13 @@
+ -----
+ Spring-richclient Form
+ -----
+ Peter De Bruycker
+ -----
+
+Spring-richclient Form Module
+
+ This module contains the Form module.
+
+Mechanisms
+
+ {{{interceptors.html}FormComponentInterceptors}}
Added: trunk/spring-richclient/form/src/site/apt/interceptors.apt
===================================================================
--- trunk/spring-richclient/form/src/site/apt/interceptors.apt
(rev 0)
+++ trunk/spring-richclient/form/src/site/apt/interceptors.apt 2006-07-27
11:17:39 UTC (rev 1245)
@@ -0,0 +1,165 @@
+ -----
+ Form Component Interceptors
+ -----
+ Peter De Bruycker
+ -----
+
+Rationale
+
+ Form Component Interceptors provide a way to intercept and add extra
+ functionality to input components on a form.
+
+ The application context specifies the list of interceptors to attach to
controls
+ constructed by the platform. This allows for a declarative model for
specifying
+ "additional" functionality to be added to various components.
+
+ Examples are interceptors to overlay validation error images and
background color
+ changes, provide popup menus in text fields, and autocompletion (as you
type) for
+ comboboxes.
+
+Configuration
+
+ The configuration of the interceptors in the application context is
done by
+ defining the <<<FormComponentInterceptorFactory>>>.
+
+ Sample configuration:
+
++---+
+<bean id="formComponentInterceptorFactory"
+
class="org.springframework.richclient.form.builder.support.ChainedInterceptorFactory">
+ <property name="interceptorFactories">
+ <list>
+ <bean
class="org.springframework.richclient.form.builder.support.ColorValidationInterceptorFactory">
+ <property name="errorColor"
value="255,200,200"/>
+ </bean>
+ <bean
class="org.springframework.richclient.form.builder.support.OverlayValidationInterceptorFactory"/>
+ <bean
class="org.springframework.richclient.form.builder.support.DirtyIndicatorInterceptorFactory"/>
+ <bean
class="org.springframework.richclient.text.TextComponentPopupInterceptorFactory"/>
+ <bean
class="org.springframework.richclient.list.ComboBoxAutoCompletionInterceptorFactory"/>
+ </list>
+ </property>
+</bean>
++---+
+
+Existing Interceptors
+
+ The framework contains some interceptors ready to use.
+
+* Overlay Validation Interceptor
+
+ Shows an error image in the lower left corner of the component if the
contents
+ of the component is invalid. The image also has a tooltip showing the
validation message.
+
+ <<Factory class>>:
<<<org.springframework.richclient.form.builder.support.OverlayValidationInterceptorFactory>>>
+
+
+[screenshots/OverlayValidationInterceptor.png] Overlay Validation Interceptor
screenshot
+
+* Color Validation Interceptor
+
+ Changes the background color of the form component.
+
+ <<Factory class>>:
<<<org.springframework.richclient.form.builder.support.ColorValidationInterceptorFactory>>>
+
+ <<Properties>>:
+
+ * <<<errorColor>>>: the background color
+
+ []
+
+ Sample configuration:
+
++---+
+<!-- This sets the error color to a nice "reddish" tint -->
+<bean
class="org.springframework.richclient.form.builder.support.ColorValidationInterceptorFactory">
+ <property name="errorColor" value="255,200,200"/>
+</bean>
++---+
+
+
+[screenshots/ColorValidationInterceptor.png] Color Validation Interceptor
screenshot
+
+* Text Component Interceptor
+
+ Adds more advanced text editing functionality to text components. It
adds a
+ popup menu with "undo/redo/cut/copy/paste/select all" items. It also
adds
+ the standard keyboard accelerators for these commands to the component.
+
+ <<Factory class>>:
<<<org.springframework.richclient.text.TextComponentPopupInterceptorFactory>>>
+
+[screenshots/TextComponentInterceptor.png] Text Component Interceptor
screenshot
+
+* Combobox Autocompletion Interceptor
+
+ Adds autocompletion to a combobox.
+
+ <<Factory class>>:
<<<org.springframework.richclient.list.ComboBoxAutoCompletionInterceptorFactory>>>
+
+[screenshots/ComboboxAutocompletionInterceptor.png] Combobox Autocompletion
Interceptor screenshot
+
+* Dirty Indicator Interceptor
+
+ Shows an image in the top left corder of the component if the contents
of the
+ component has been changed by the user. The image also has a tooltip
showing the
+ original value. To the right of the image is a small revert button.
Pushing this
+ button restores the original value in the component.
+
+ <<Factory class>>:
<<<org.springframework.richclient.form.builder.support.DirtyIndicatorInterceptorFactory>>>
+
+ <<Properties>>:
+
+ * <<<includedFormModelIds>>>: list of form models that should display
the Dirty Indicator.
+
+ Only one of <<<includedFormModelIds>>> or <<<excludedFormModelIds>>>
can be specified.
+
+ * <<<excludedFormModelIds>>>: list of form models that should not
display the Dirty Indicator
+
+ Only one of <<<includedFormModelIds>>> or <<<excludedFormModelIds>>>
can be specified.
+
+ []
+
++---+
+<!-- The login form will not show the Dirty Indicator -->
+
+<bean
class="org.springframework.richclient.form.builder.support.DirtyIndicatorInterceptorFactory">
+ <property name="excludedFormModelIds">
+ <list>
+ <value>loginForm</value>
+ </list>
+ </property>
+</bean>
++---+
+
+[screenshots/DirtyIndicatorInterceptor.png] Dirty Indicator Interceptor
screenshot
+
+Interceptors in Sandbox
+
+ Note: it's likely that these interceptors will change as they are still
in the
+ sandbox. This can go from a simple rename to a complete change in
implementation
+ and/or behaviour.
+
+* Show Caption in StatusBar Interceptor
+
+ Displays the caption of the component that has focus in the statusbar.
+ For this to work, the form property must have a caption in the message
source.
+
+ <<Factory class>>:
<<<org.springframework.richclient.form.builder.support.ShowCaptionInStatusBarInterceptorFactory>>>
+
+[screenshots/ShowCaptionInStatusBarInterceptor.png] Show Caption in StatusBar
screenshot
+
+* Select All Interceptor
+
+ Selects all the text in text fields and spinners when they receive
focus.
+
+ <<Factory class>>:
<<<org.springframework.richclient.text.SelectAllInterceptorFactory>>>
+
+[screenshots/SelectAllInterceptor.png] Select All Interceptor screenshot
+
+
+Ideas for Interceptors
+
+ Possible new interceptors:
+
+ * Help Interceptor: use the form id + form property path to show help
using the java help system.
+
+ * ...
\ No newline at end of file
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/ColorValidationInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/ColorValidationInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/ComboboxAutocompletionInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/ComboboxAutocompletionInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/DirtyIndicatorInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/DirtyIndicatorInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/OverlayValidationInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/OverlayValidationInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/SelectAllInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/SelectAllInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/ShowCaptionInStatusBarInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/ShowCaptionInStatusBarInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/spring-richclient/form/src/site/resources/screenshots/TextComponentInterceptor.png
===================================================================
(Binary files differ)
Property changes on:
trunk/spring-richclient/form/src/site/resources/screenshots/TextComponentInterceptor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys -- and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
spring-rich-c-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs
