Class FormHelpTemplate

java.lang.Object

sunlabs.brazil.template.Template

sunlabs.brazil.template.FormTemplate

sunlabs.brazil.sunlabs.FormHelpTemplate

All Implemented Interfaces:

TemplateInterface

public class FormHelpTemplate
extends FormTemplate

Template class for adding field help to the FormTemplate. The "help" attribute of the <form> element specifies a javascript template used to generate an event handler for each form element. The "help" attribute on each form element is passed to the javascript template, allowing a (user supplied) javascript function to present field specific help. The help text for each feld may be supplied as a server config file.

"help" feature:
This template may be used to provide field specific help with a little external javascript "glue". For example, the markup:

<form event=onfocus help="do_help(%)">
...
  <input name=foo ... help="help for this input field">
...
</form>

will generate:

<form>
...
  <input ... onfocus='do_help("help for this input field")'>
...
</form>

This works with the form elements <input> <select>, and <textarea>. The "event" defaults to "onfocus". If foo.help is a defined property then it is used as the help text.

Version:

@(#)FormHelpTemplate.java 1.1

Author:

Stephen Uhler

Field Summary

Fields inherited from class Template

debug

Constructor Summary

Constructors

Constructor	Description
FormHelpTemplate()

Method Summary

Modifier and Type	Method	Description
protected void	do_help(RewriteContext hr)	Look for help text, and put it into an event call.
boolean	done(RewriteContext hr)	This is for debugging only !!
protected String	format(String base, String arg)	Substitute "arg" into "base" at "%"
boolean	init(RewriteContext hr)	Save a reference to our request properties.
void	tag_form(RewriteContext hr)	Look for a "help" attribute, remember its value, then remove it .
void	tag_input(RewriteContext hr)	Look for a "help" attribute, remember its value, then remove it .
void	tag_option(RewriteContext hr)	Needed to retain parent functionality.
void	tag_select(RewriteContext hr)	Look for a "help" attribute, remember its value, then remove it .
void	tag_slash_form(RewriteContext hr)	Forget about the "help" action.
void	tag_slash_select(RewriteContext hr)	Needed to retain parent functionality.
void	tag_textarea(RewriteContext hr)	Look for a "help" attribute, remember its value, then remove it .

Methods inherited from class Template

debug, debug

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FormHelpTemplate

public FormHelpTemplate()

Method Details

init

public boolean init(RewriteContext hr)

Description copied from class: FormTemplate

Save a reference to our request properties.

Specified by:

init in interface TemplateInterface

Overrides:

init in class FormTemplate

tag_form

public void tag_form(RewriteContext hr)

Look for a "help" attribute, remember its value, then remove it .

Overrides:

tag_form in class FormTemplate

tag_slash_form

public void tag_slash_form(RewriteContext hr)

Forget about the "help" action.

Overrides:

tag_slash_form in class FormTemplate

tag_input

public void tag_input(RewriteContext hr)

Look for a "help" attribute, remember its value, then remove it .

Overrides:

tag_input in class FormTemplate

tag_select

public void tag_select(RewriteContext hr)

Look for a "help" attribute, remember its value, then remove it .

Overrides:

tag_select in class FormTemplate

tag_slash_select

public void tag_slash_select(RewriteContext hr)

Needed to retain parent functionality.

Overrides:

tag_slash_select in class FormTemplate

tag_option

public void tag_option(RewriteContext hr)

Needed to retain parent functionality.

Overrides:

tag_option in class FormTemplate

tag_textarea

public void tag_textarea(RewriteContext hr)

Look for a "help" attribute, remember its value, then remove it .

do_help

protected void do_help(RewriteContext hr)

Look for help text, and put it into an event call. First, see if the attribute "helpname" is specified, and use it to name the property containing the help text. Otherwise look in the "name".help property, and lastly the "help" attribute.

format

protected String format(String base,
 String arg)

Substitute "arg" into "base" at "%"

done

public boolean done(RewriteContext hr)

Description copied from class: FormTemplate

This is for debugging only !!

Specified by:

done in interface TemplateInterface

Overrides:

done in class FormTemplate